diff --git a/.changeset/add-abandoned-checkout-index-action-target.md b/.changeset/add-abandoned-checkout-index-action-target.md new file mode 100644 index 0000000000..19c66c334f --- /dev/null +++ b/.changeset/add-abandoned-checkout-index-action-target.md @@ -0,0 +1,6 @@ +--- +'@shopify/ui-extensions': patch +'@shopify/ui-extensions-tester': patch +--- + +Add `admin.abandoned-checkout-index.action.render` and `admin.abandoned-checkout-index.action.should-render` extension targets for the abandoned checkout index page. This mirrors the action targets already available on other resource index pages (orders, customers, products, draft orders, etc.) and unblocks `admin.abandoned-checkout-index.action.link` admin link extensions. diff --git a/.changeset/add-admin-tools-data-target.md b/.changeset/add-admin-tools-data-target.md deleted file mode 100644 index f2b35dc34a..0000000000 --- a/.changeset/add-admin-tools-data-target.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': patch ---- - -Add admin.app.tools.data extension target diff --git a/.changeset/add-app-home-render-target.md b/.changeset/add-app-home-render-target.md new file mode 100644 index 0000000000..5b76ad3c98 --- /dev/null +++ b/.changeset/add-app-home-render-target.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Add admin.app.home.render extension target diff --git a/.changeset/add-purchase-type-and-recurring-cycle-limit.md b/.changeset/add-purchase-type-and-recurring-cycle-limit.md new file mode 100644 index 0000000000..1ffd361b8a --- /dev/null +++ b/.changeset/add-purchase-type-and-recurring-cycle-limit.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': minor +--- + +Add purchaseType and recurringCycleLimit subscribable fields to the DiscountsApi for discount function settings extensions. diff --git a/.changeset/admin-app-home-intents-request.md b/.changeset/admin-app-home-intents-request.md new file mode 100644 index 0000000000..a9c313d0bc --- /dev/null +++ b/.changeset/admin-app-home-intents-request.md @@ -0,0 +1,6 @@ +--- +'@shopify/ui-extensions': patch +'@shopify/ui-extensions-tester': patch +--- + +Narrow `AppHomeApi.intents` to a new `AppHomeIntents` shape that exposes a signal-like `request` so the runtime can stream link intents into a long-lived `admin.app.home.render` extension. `WithGeneratedIntents` continues to narrow `request.value` to the CLI-generated variants. diff --git a/.changeset/admin-app-home-tools-api.md b/.changeset/admin-app-home-tools-api.md new file mode 100644 index 0000000000..0e08d9af83 --- /dev/null +++ b/.changeset/admin-app-home-tools-api.md @@ -0,0 +1,6 @@ +--- +'@shopify/ui-extensions': patch +'@shopify/ui-extensions-tester': patch +--- + +Expose the `Tools` API on `AppHomeApi` so `admin.app.home.render` extensions can call `shopify.tools.register(...)` even before the CLI generates typed overloads. Adds a matching mock to `@shopify/ui-extensions-tester`. diff --git a/.changeset/admin-pick-file-intent.md b/.changeset/admin-pick-file-intent.md new file mode 100644 index 0000000000..23100b06ab --- /dev/null +++ b/.changeset/admin-pick-file-intent.md @@ -0,0 +1,6 @@ +--- +'@shopify/ui-extensions': patch +'@shopify/ui-extensions-tester': patch +--- + +Add `pick` action and `shopify/File` resource type to the admin Intents API, enabling extensions to open the file picker via `intents.invoke('pick:shopify/File', …)`. diff --git a/.changeset/brave-falcons-perform.md b/.changeset/brave-falcons-perform.md deleted file mode 100644 index 878d0d464c..0000000000 --- a/.changeset/brave-falcons-perform.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': patch ---- - -2026.1.0-rc release diff --git a/.changeset/brown-flowers-ask.md b/.changeset/brown-flowers-ask.md new file mode 100644 index 0000000000..64a2fe77d5 --- /dev/null +++ b/.changeset/brown-flowers-ask.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Add inlineSize to the customer account Page component diff --git a/.changeset/bundle-component-discount-allocations.md b/.changeset/bundle-component-discount-allocations.md new file mode 100644 index 0000000000..4a34bc671e --- /dev/null +++ b/.changeset/bundle-component-discount-allocations.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': minor +--- + +Added optional `discountAllocations` field to POS bundle `LineItemComponent` so extensions can access the discount amount allocated to each bundle component. diff --git a/.changeset/calm-sites-warn.md b/.changeset/calm-sites-warn.md new file mode 100644 index 0000000000..388c8c9b09 --- /dev/null +++ b/.changeset/calm-sites-warn.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Update docs for inlineSize prop on customer account Page component diff --git a/.changeset/cash-rounding-transaction-complete.md b/.changeset/cash-rounding-transaction-complete.md new file mode 100644 index 0000000000..25a308c722 --- /dev/null +++ b/.changeset/cash-rounding-transaction-complete.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Add optional `cashRoundingAdjustment` money data to POS transaction-complete payload types. diff --git a/.changeset/chat-s-component.md b/.changeset/chat-s-component.md new file mode 100644 index 0000000000..7f9cd48dc0 --- /dev/null +++ b/.changeset/chat-s-component.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': minor +--- + +Release the `Chat` component (`s-chat`) to checkout UI extensions. diff --git a/.changeset/checkbox-rich-label.md b/.changeset/checkbox-rich-label.md new file mode 100644 index 0000000000..8277b3a569 --- /dev/null +++ b/.changeset/checkbox-rich-label.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +The `label` prop on the checkout and customer-account `s-checkbox` component now accepts a label as a slot in addition to a plain string, label slots can include only plain text and s-links. diff --git a/.changeset/chilly-ghosts-beam.md b/.changeset/chilly-ghosts-beam.md deleted file mode 100644 index 1f3018ebe0..0000000000 --- a/.changeset/chilly-ghosts-beam.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': patch ---- - -new oidc deploy workflow diff --git a/.changeset/config.json b/.changeset/config.json index 9ef61d7e9a..76c765f5f3 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -6,7 +6,7 @@ ], "commit": false, "fixed": [], - "linked": [], + "linked": [["@shopify/ui-extensions", "@shopify/ui-extensions-tester"]], "access": "restricted", "baseBranch": "unstable", "updateInternalDependencies": "patch", diff --git a/.changeset/deprecate-buyer-journey-intercept.md b/.changeset/deprecate-buyer-journey-intercept.md new file mode 100644 index 0000000000..afff582bdc --- /dev/null +++ b/.changeset/deprecate-buyer-journey-intercept.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Deprecate `useBuyerJourneyIntercept` and the `buyerJourney.intercept` API. Use a cart and checkout validation function instead. The buyer journey intercept will be removed in a future version of the API. diff --git a/.changeset/eager-dogs-carry.md b/.changeset/eager-dogs-carry.md deleted file mode 100644 index 3afe0a1a80..0000000000 --- a/.changeset/eager-dogs-carry.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': patch ---- - -Remove unsupported fields for the Discount API. Those fields will be added in a later API. diff --git a/.changeset/eleven-mammals-allow.md b/.changeset/eleven-mammals-allow.md deleted file mode 100644 index e6e7581f2e..0000000000 --- a/.changeset/eleven-mammals-allow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': patch ---- - -Bump node version to v20.19.6 diff --git a/.changeset/floppy-camels-bet.md b/.changeset/floppy-camels-bet.md new file mode 100644 index 0000000000..7005c35d25 --- /dev/null +++ b/.changeset/floppy-camels-bet.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Add generic helper types for intents diff --git a/.changeset/funny-moons-share.md b/.changeset/funny-moons-share.md deleted file mode 100644 index 0a453a156f..0000000000 --- a/.changeset/funny-moons-share.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': patch ---- - -Add optional tipAmount field to POS transaction data types diff --git a/.changeset/hip-shirts-drum.md b/.changeset/hip-shirts-drum.md deleted file mode 100644 index 428d148b1a..0000000000 --- a/.changeset/hip-shirts-drum.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': minor ---- - -implements the cash drawer api to the ui extensions repository diff --git a/.changeset/hot-olives-act.md b/.changeset/hot-olives-act.md deleted file mode 100644 index a3e6d0c052..0000000000 --- a/.changeset/hot-olives-act.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': patch ---- - -recommend merchant friendly warning for enabling checkout extension to block progress diff --git a/.changeset/legal-eggs-roll.md b/.changeset/legal-eggs-roll.md deleted file mode 100644 index b810c4b2db..0000000000 --- a/.changeset/legal-eggs-roll.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': patch ---- - -Exports LineItemComponent from point-of-sale API so POS can import the type diff --git a/.changeset/mean-ducks-join.md b/.changeset/mean-ducks-join.md new file mode 100644 index 0000000000..f03393feef --- /dev/null +++ b/.changeset/mean-ducks-join.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Match correctly on optional response diff --git a/.changeset/old-geese-smoke.md b/.changeset/old-geese-smoke.md deleted file mode 100644 index 510d624be7..0000000000 --- a/.changeset/old-geese-smoke.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': minor ---- - -Remove accessory slot from TextArea component diff --git a/.changeset/paragraph-text-align.md b/.changeset/paragraph-text-align.md new file mode 100644 index 0000000000..10c551b42b --- /dev/null +++ b/.changeset/paragraph-text-align.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Add `textAlign` prop to the checkout `Paragraph` component, supporting `'start'`, `'end'`, `'center'`, and `'auto'` values. diff --git a/.changeset/pos-cart-add-line-item-options.md b/.changeset/pos-cart-add-line-item-options.md new file mode 100644 index 0000000000..46b8775fd0 --- /dev/null +++ b/.changeset/pos-cart-add-line-item-options.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': minor +--- + +Added an optional `options` argument to the POS `cart.addLineItem` method so a single call can create a line item and decorate it with line-item properties (`properties`) in one operation. This avoids the extra native call and cart sync of chaining `addLineItem` → `addLineItemProperties`. Backwards compatible—the third argument is optional. Adds the `AddLineItemOptions` type. diff --git a/.changeset/pos-data-target-readonly-cart.md b/.changeset/pos-data-target-readonly-cart.md new file mode 100644 index 0000000000..866504e8df --- /dev/null +++ b/.changeset/pos-data-target-readonly-cart.md @@ -0,0 +1,7 @@ +--- +'@shopify/ui-extensions': patch +--- + +Narrow the `pos.app.ready.data` cart API surface to readonly. The background extension target's `shopify.cart` now only exposes the subscribable `current` signal; cart mutation methods (`addLineItem`, `clearCart`, `applyCartDiscount`, `setCustomer`, etc.) are not typed on this target. Cart mutation remains available to interactive render targets via the unchanged `CartApi`. + +Internally this splits `CartApiContent` into `ReadonlyCartApiContent` + `MutableCartApiContent` (both re-exported), and introduces `ReadonlyCartApi` for use in `DataTargetApi`. diff --git a/.changeset/pos-event-payload-objects.md b/.changeset/pos-event-payload-objects.md new file mode 100644 index 0000000000..37a8ac6f92 --- /dev/null +++ b/.changeset/pos-event-payload-objects.md @@ -0,0 +1,6 @@ +--- +'@shopify/ui-extensions': patch +'@shopify/ui-extensions-tester': patch +--- + +Remove native `Event` inheritance from POS event payload types. diff --git a/.changeset/pos-printing-api.md b/.changeset/pos-printing-api.md new file mode 100644 index 0000000000..7fb1cd3a31 --- /dev/null +++ b/.changeset/pos-printing-api.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': minor +--- + +Add the POS `shopify.printing` API. `shopify.printing.getPrinters()` discovers hardware printers currently available to the device, and `shopify.printing.print(src, options?)` prints content fetched from a URL — opening the system print dialog by default, or sending directly to a printer when a `printer` (from `getPrinters()`) is passed via `options`. This supersedes `shopify.print`, which is now deprecated. diff --git a/.changeset/pos-remove-observe-targets.md b/.changeset/pos-remove-observe-targets.md new file mode 100644 index 0000000000..2a601fc479 --- /dev/null +++ b/.changeset/pos-remove-observe-targets.md @@ -0,0 +1,10 @@ +--- +'@shopify/ui-extensions': patch +'@shopify/ui-extensions-tester': patch +--- + +Remove the deprecated POS `.observe` event extension targets: `pos.transaction-complete.event.observe`, `pos.cash-tracking-session-start.event.observe`, `pos.cash-tracking-session-complete.event.observe`, and `pos.cart-update.event.observe`. These were early-access targets with effectively no production usage. + +Use the `pos.app.ready.data` background target instead: `shopify.addEventListener('transactioncomplete' | 'cashtrackingsessionstart' | 'cashtrackingsessioncomplete', callback)` for the event targets, and `shopify.cart.current.subscribe()` for cart updates. + +This also removes the `EventExtensionTargets`/`EventExtensionTarget` types and the `TransactionCompleteData`, `CashTrackingSessionStartData`, `CashTrackingSessionCompleteData`, and `CartUpdateEventData` payload types. The receipt-target type `TransactionCompleteWithReprintData` is unchanged. diff --git a/.changeset/pre.json b/.changeset/pre.json index c33cbf702f..77fba6451d 100644 --- a/.changeset/pre.json +++ b/.changeset/pre.json @@ -2,18 +2,26 @@ "mode": "pre", "tag": "rc", "initialVersions": { - "@shopify/ui-extensions": "2026.1.0-rc.0" + "@shopify/ui-extensions": "2026.7.0-rc.0", + "@shopify/ui-extensions-tester": "2026.7.0-rc.0" }, "changesets": [ - "brave-falcons-perform", - "chilly-ghosts-beam", - "eleven-mammals-allow", - "funny-moons-share", - "hip-shirts-drum", - "legal-eggs-roll", - "old-geese-smoke", - "proud-paths-listen", - "slimy-foxes-hide", - "vast-planes-flow" + "add-abandoned-checkout-index-action-target", + "add-app-home-render-target", + "admin-app-home-intents-request", + "admin-app-home-tools-api", + "brown-flowers-ask", + "calm-sites-warn", + "cash-rounding-transaction-complete", + "checkbox-rich-label", + "floppy-camels-bet", + "mean-ducks-join", + "paragraph-text-align", + "pos-cart-add-line-item-options", + "pos-data-target-readonly-cart", + "sixty-points-doubt", + "soft-otters-share", + "tiny-staff-signal", + "true-tips-fix" ] } diff --git a/.changeset/proud-paths-listen.md b/.changeset/proud-paths-listen.md deleted file mode 100644 index 35021cb0f2..0000000000 --- a/.changeset/proud-paths-listen.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': minor ---- - -Adds register details targets diff --git a/.changeset/ripe-chairs-cry.md b/.changeset/ripe-chairs-cry.md new file mode 100644 index 0000000000..331735088a --- /dev/null +++ b/.changeset/ripe-chairs-cry.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Deprecate renderMode on shipping option item diff --git a/.changeset/serious-keys-trade.md b/.changeset/serious-keys-trade.md deleted file mode 100644 index aa3ebf62eb..0000000000 --- a/.changeset/serious-keys-trade.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': minor ---- - -Add registerName field to the Device Api diff --git a/.changeset/sixty-points-doubt.md b/.changeset/sixty-points-doubt.md new file mode 100644 index 0000000000..a8109e5301 --- /dev/null +++ b/.changeset/sixty-points-doubt.md @@ -0,0 +1,6 @@ +--- +'@shopify/ui-extensions-tester': patch +'@shopify/ui-extensions': patch +--- + +Publish package with admin.app.home.render target diff --git a/.changeset/slimy-foxes-hide.md b/.changeset/slimy-foxes-hide.md deleted file mode 100644 index 426f482524..0000000000 --- a/.changeset/slimy-foxes-hide.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': minor ---- - -Add Camera API types diff --git a/.changeset/soft-otters-share.md b/.changeset/soft-otters-share.md new file mode 100644 index 0000000000..65d8c0cb66 --- /dev/null +++ b/.changeset/soft-otters-share.md @@ -0,0 +1,5 @@ +--- +'@shopify/ui-extensions': patch +--- + +Expose the `padding` prop on the checkout and customer account `s-section` components. diff --git a/.changeset/tiny-staff-signal.md b/.changeset/tiny-staff-signal.md new file mode 100644 index 0000000000..292490ea2d --- /dev/null +++ b/.changeset/tiny-staff-signal.md @@ -0,0 +1,6 @@ +--- +'@shopify/ui-extensions': minor +'@shopify/ui-extensions-tester': minor +--- + +Add `session.staffMember` for POS UI extensions so extensions can read and subscribe to the currently pinned staff member. diff --git a/.changeset/true-tips-fix.md b/.changeset/true-tips-fix.md new file mode 100644 index 0000000000..c1d18fa000 --- /dev/null +++ b/.changeset/true-tips-fix.md @@ -0,0 +1,6 @@ +--- +'@shopify/ui-extensions-tester': major +'@shopify/ui-extensions': major +--- + +2026-07-rc release diff --git a/.changeset/vast-planes-flow.md b/.changeset/vast-planes-flow.md deleted file mode 100644 index 5b59966b4d..0000000000 --- a/.changeset/vast-planes-flow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': minor ---- - -Adds components to point of sale cart LineItem interface to represent product bundle items. diff --git a/.changeset/wet-cycles-punch.md b/.changeset/wet-cycles-punch.md deleted file mode 100644 index 924af320a6..0000000000 --- a/.changeset/wet-cycles-punch.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@shopify/ui-extensions': minor ---- - -Added subscribable discounts api. Update the type for `data.id` to string to fix a previously incorrect type. diff --git a/.eslintrc.js b/.eslintrc.js index c4f6c682a5..898aadeaae 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -7,7 +7,6 @@ module.exports = { ignorePatterns: [ 'build/', 'examples/', - 'mdxExamples/', 'node_modules/', 'packages/*/build/', 'packages/*/*.d.ts', diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000000..8011c17a7d --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,4 @@ +# Admin generated DTS is owned by Admin UI Foundations. +/packages/ui-extensions/src/surfaces/admin/components.d.ts @Shopify/polaris-team +/packages/ui-extensions/src/surfaces/admin/components/*.d.ts @Shopify/polaris-team +/packages/ui-extensions/src/surfaces/admin/components/**/*.d.ts @Shopify/polaris-team diff --git a/.github/workflows/changesets-reminder.yml b/.github/workflows/changesets-reminder.yml index d29900eba8..bf70be3653 100644 --- a/.github/workflows/changesets-reminder.yml +++ b/.github/workflows/changesets-reminder.yml @@ -31,7 +31,7 @@ jobs: if: ${{ !github.event.pull_request.draft && !startsWith(github.head_ref, 'changeset-release/') }} steps: - uses: actions/checkout@v3 - - uses: mskelton/changelog-reminder-action@v2 + - uses: mskelton/changelog-reminder-action@7039cd14fb784c0a2b37f6e7a6ade2c9148c2245 # v2.0.0 with: changelogRegex: "\\.changeset" message: > diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5df5b6171a..0002e53c30 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -42,6 +42,38 @@ jobs: - name: Lint run: yarn lint + test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - uses: ./.github/workflows/actions/prepare + + - name: Build packages + run: yarn build + + - name: Typecheck ui-extensions-tester (including tests) + run: npx tsc --project packages/ui-extensions-tester/tsconfig.typecheck.json + + - name: Test ui-extensions-tester + run: npx loom test --no-watch packages/ui-extensions-tester/ + + - name: Testing example (checkout) + run: npm install && npm run typecheck && npm test + working-directory: examples/testing/checkout-basic-testing-example + + - name: Testing example (point-of-sale) + run: npm install && npm run typecheck && npm test + working-directory: examples/testing/point-of-sale-testing-example + + - name: Testing example (customer-account) + run: npm install && npm run typecheck && npm test + working-directory: examples/testing/customer-account-testing-example + + - name: Testing example (admin) + run: npm install && npm run typecheck && npm test + working-directory: examples/testing/admin-testing-example + test-build: runs-on: ubuntu-latest diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index efcf4577bf..c9a9dbbac3 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -14,6 +14,10 @@ on: - 20[0-9][0-9]-[01][1470] # RC version branches - 20[0-9][0-9]-[01][1470]-rc + # Snapit trigger - runs when /snapit comment is made on a PR + issue_comment: + types: + - created concurrency: ${{ github.workflow }}-${{ github.ref }} @@ -46,11 +50,13 @@ jobs: NPM_TOKEN: '' NPM_CONFIG_PROVENANCE: true with: + post_install_script: yarn changeset:exit-pre-mode build_script: yarn build comment_command: /snapit changesets: name: Deploy + if: ${{ github.event_name == 'push' }} runs-on: ubuntu-latest permissions: contents: read diff --git a/.github/workflows/rc-port-tracker.yml b/.github/workflows/rc-port-tracker.yml new file mode 100644 index 0000000000..81fa884ce1 --- /dev/null +++ b/.github/workflows/rc-port-tracker.yml @@ -0,0 +1,168 @@ +name: RC port tracker + +on: + pull_request: + types: [opened, reopened, closed, edited] + branches: + - 20[0-9][0-9]-[01][1470] + - 20[0-9][0-9]-[01][1470]-rc + +permissions: + pull-requests: write + issues: write + +jobs: + label-stable-pr: + name: Label PRs against stable branches + if: | + ( + github.event.action == 'opened' || + github.event.action == 'reopened' || + (github.event.action == 'edited' && github.event.changes.base != null) + ) && + !endsWith(github.event.pull_request.base.ref, '-rc') && + !startsWith(github.head_ref, 'changeset-release/') && + !contains(github.event.pull_request.labels.*.name, 'needs-rc-port') + runs-on: ubuntu-latest + timeout-minutes: 2 + steps: + - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + with: + script: | + const LABEL = 'needs-rc-port'; + const { owner, repo } = context.repo; + const pr = context.payload.pull_request; + + const branches = await github.paginate(github.rest.repos.listBranches, { + owner, repo, per_page: 100, + }); + const branchNames = branches.map(b => b.name); + + const stableBranches = branchNames + .filter(n => /^\d{4}-(?:01|04|07|10)$/.test(n)) + .sort(); + const latestStable = stableBranches[stableBranches.length - 1]; + + if (pr.base.ref !== latestStable) return; + + await github.rest.issues.addLabels({ + owner, repo, issue_number: pr.number, labels: [LABEL], + }); + + const rcBranches = branchNames + .filter(n => /^\d{4}-(?:01|04|07|10)-rc$/.test(n)) + .sort(); + const latestRc = rcBranches[rcBranches.length - 1]; + const rcLabel = latestRc ? `\`${latestRc}\`` : 'the current RC branch'; + + const body = [ + `This PR targets a stable release branch (\`${pr.base.ref}\`). Once merged, the change typically also needs to be forward-ported to ${rcLabel} so it ships in the next release.`, + '', + `When you open the forward-port PR, include a line like this in its body so the \`${LABEL}\` label gets removed automatically when that PR merges:`, + '', + '```', + `Forward-port of #${pr.number}`, + '```', + '', + 'Accepted formats (comma-separated for multiple):', + `- \`#${pr.number}\``, + `- \`GH-${pr.number}\``, + `- \`${pr.number}\``, + `- \`https://github.com/${owner}/${repo}/pull/${pr.number}\``, + '', + `If a forward-port isn't needed (e.g., the change is stable-only), you can remove the \`${LABEL}\` label manually.`, + ].join('\n'); + + await github.rest.issues.createComment({ + owner, repo, issue_number: pr.number, body, + }); + + process-rc-merge: + name: Process forward-port references on RC merge + if: | + github.event.action == 'closed' && + github.event.pull_request.merged == true && + endsWith(github.event.pull_request.base.ref, '-rc') + runs-on: ubuntu-latest + timeout-minutes: 2 + steps: + - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + with: + script: | + const LABEL = 'needs-rc-port'; + const { owner, repo } = context.repo; + const pr = context.payload.pull_request; + const body = pr.body || ''; + + const refs = new Set(); + const crossRepo = []; + + const blockRegex = /forward-port\s+of:?\s*(.*?)(?:\n\s*\n|$)/gis; + for (const match of body.matchAll(blockRegex)) { + const tokens = match[1].split(/[\s,;]+/).filter(Boolean); + for (const token of tokens) { + if (/^(?:-|\*|and|&)$/i.test(token)) continue; + + const url = token.match(/^https?:\/\/github\.com\/([^/]+)\/([^/]+)\/pull\/(\d+)\/?$/i); + if (url) { + const [, urlOwner, urlRepo, num] = url; + if (urlOwner.toLowerCase() === owner.toLowerCase() && + urlRepo.toLowerCase() === repo.toLowerCase()) { + refs.add(parseInt(num, 10)); + } else { + crossRepo.push(token); + } + continue; + } + + const num = token.match(/^(?:#|GH-)?(\d+)$/i); + if (num) refs.add(parseInt(num[1], 10)); + } + } + + if (crossRepo.length) { + await github.rest.issues.createComment({ + owner, repo, issue_number: pr.number, + body: `⚠️ The following forward-port references point to a different repository and were ignored:\n${crossRepo.map(r => `- ${r}`).join('\n')}`, + }); + } + + if (refs.size === 0) return; + + for (const num of refs) { + try { + const { data: ref } = await github.rest.pulls.get({ + owner, repo, pull_number: num, + }); + + if (/-rc$/.test(ref.base.ref)) { + await github.rest.issues.createComment({ + owner, repo, issue_number: pr.number, + body: `⚠️ Skipping #${num}: it targets \`${ref.base.ref}\`, not a stable branch.`, + }); + continue; + } + + try { + await github.rest.issues.removeLabel({ + owner, repo, issue_number: num, name: LABEL, + }); + } catch (e) { + if (e.status !== 404) throw e; + } + + await github.rest.issues.createComment({ + owner, repo, issue_number: num, + body: `✓ Forward-ported in #${pr.number}.`, + }); + } catch (e) { + if (e.status === 404) { + await github.rest.issues.createComment({ + owner, repo, issue_number: pr.number, + body: `⚠️ Forward-port reference #${num} could not be found.`, + }); + continue; + } + throw e; + } + } diff --git a/.github/workflows/shopify-dev-preview-automation.yml b/.github/workflows/shopify-dev-preview-automation.yml new file mode 100644 index 0000000000..fa7bb06157 --- /dev/null +++ b/.github/workflows/shopify-dev-preview-automation.yml @@ -0,0 +1,216 @@ +# This workflow dispatches a docs sync event to shop/world when generated docs files change. +# It monitors changes to generated docs files in PRs across all UI extension surfaces. +# +# The shop/world repository will then sync these docs files for preview. +# +# Supports both flat structure (e.g., 2025-04, 2025-07): +# packages/ui-extensions/docs/surfaces//generated/*.json +# And nested structure (e.g., 2025-10+): +# packages/ui-extensions/docs/surfaces//generated///*.json +# +# ============================================================================ +# CONFIGURATION: Enable/disable surfaces by commenting out lines below +# ============================================================================ +# To disable a surface, comment out its line in BOTH the 'paths' trigger AND +# the ENABLED_SURFACES env var below. They must match! +# +# Available surfaces: +# admin -> admin_extensions +# checkout -> checkout_extensions +# customer-account -> customer_account_ui_extensions +# point-of-sale -> pos_ui_extensions +# ============================================================================ + +name: Shopify Dev Docs Sync + +on: + pull_request: + types: [opened, synchronize, reopened, ready_for_review, closed] + paths: + - 'packages/ui-extensions/docs/surfaces/admin/generated/**/*.json' + - 'packages/ui-extensions/docs/surfaces/checkout/generated/**/*.json' + - 'packages/ui-extensions/docs/surfaces/customer-account/generated/**/*.json' + - 'packages/ui-extensions/docs/surfaces/point-of-sale/generated/**/*.json' + +env: + # ============================================================================ + # ENABLED SURFACES: Comment/uncomment to match the paths trigger above + # ============================================================================ + ENABLED_SURFACES: | + admin + checkout + customer-account + point-of-sale + +concurrency: + group: shopify-dev-docs-sync-${{ github.head_ref }} + cancel-in-progress: true + +jobs: + dispatch-docs-sync: + name: Dispatch docs sync to shop/world + runs-on: shopify-docs-ubuntu-latest + timeout-minutes: 10 + if: github.repository_owner == 'Shopify' + steps: + - name: Checkout repository + if: github.event.action != 'closed' + uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 + with: + fetch-depth: 1 + + - name: Create GitHub App Token + id: app-token + uses: actions/create-github-app-token@af35edadc00be37caa72ed9f3e6d5f7801bfdf09 # v1.11.7 + with: + app-id: ${{ secrets.SHOPIFY_DEV_DOCS_SYNC_APP_ID }} + private-key: ${{ secrets.SHOPIFY_DEV_DOCS_SYNC_APP_PRIVATE_KEY }} + owner: Shop + repositories: | + world + + - name: Debug - Check token access to shop/world + env: + GH_TOKEN: ${{ steps.app-token.outputs.token }} + run: | + echo "Testing token access to shop/world repository..." + HTTP_STATUS=$(curl -s -o repo_check.txt -w "%{http_code}" \ + -H "Authorization: Bearer $GH_TOKEN" \ + -H "Accept: application/vnd.github+json" \ + https://api.github.com/repos/shop/world) + + echo "HTTP Status: $HTTP_STATUS" + + if [ "$HTTP_STATUS" -eq 200 ]; then + echo "Token has access to shop/world repository" + echo "Repository info:" + cat repo_check.txt | jq '.name, .private, .permissions' + elif [ "$HTTP_STATUS" -eq 404 ]; then + echo "Token does NOT have access to shop/world (404 Not Found)" + cat repo_check.txt + elif [ "$HTTP_STATUS" -eq 401 ]; then + echo "Token is invalid or expired (401 Unauthorized)" + cat repo_check.txt + else + echo "Unexpected response (HTTP $HTTP_STATUS)" + cat repo_check.txt + fi + + - name: Get changed files + id: changed-files + if: github.event.action != 'closed' + env: + GH_TOKEN: ${{ github.token }} + PR_NUMBER: ${{ github.event.pull_request.number }} + run: | + # Build monitored patterns from ENABLED_SURFACES env var + MONITORED_PATTERNS=() + while IFS= read -r surface; do + # Skip empty lines + [[ -z "$surface" ]] && continue + MONITORED_PATTERNS+=("packages/ui-extensions/docs/surfaces/${surface}/generated/") + done <<< "$ENABLED_SURFACES" + + echo "Monitoring surfaces: ${MONITORED_PATTERNS[*]}" + + # Only match these specific JSON files + VALID_FILENAMES=( + "generated_docs_data.json" + "generated_docs_data_v2.json" + "generated_static_pages.json" + "generated_category_pages.json" + "targets.json" + ) + + # Get the list of changed files in this PR using GitHub API + echo "Fetching changed files from GitHub API for PR #$PR_NUMBER" + CHANGED_FILES=$(gh api repos/${{ github.repository }}/pulls/$PR_NUMBER/files --paginate --jq '.[].filename') + + # Filter to only include files that: + # 1. Are under one of our monitored directories + # 2. Have one of our valid filenames + MATCHING_FILES=() + while IFS= read -r file; do + # Skip empty lines + [[ -z "$file" ]] && continue + # Check if file is under a monitored directory + for pattern in "${MONITORED_PATTERNS[@]}"; do + if [[ "$file" == ${pattern}* ]]; then + # Check if the filename is one we care about + filename=$(basename "$file") + for valid_name in "${VALID_FILENAMES[@]}"; do + if [[ "$filename" == "$valid_name" ]]; then + MATCHING_FILES+=("$file") + break 2 + fi + done + fi + done + done <<< "$CHANGED_FILES" + + # Convert to JSON array + if [ ${#MATCHING_FILES[@]} -eq 0 ]; then + echo "No monitored files changed" + echo "has_changes=false" >> $GITHUB_OUTPUT + else + JSON_ARRAY=$(printf '%s\n' "${MATCHING_FILES[@]}" | jq -R . | jq -s -c .) + echo "Changed files: $JSON_ARRAY" + echo "has_changes=true" >> $GITHUB_OUTPUT + echo "files=$JSON_ARRAY" >> $GITHUB_OUTPUT + fi + + - name: Dispatch to shop/world + if: github.event.action == 'closed' || steps.changed-files.outputs.has_changes == 'true' + env: + GH_TOKEN: ${{ steps.app-token.outputs.token }} + SOURCE_BRANCH: ${{ github.event.pull_request.base.ref }} + SOURCE_REF: ${{ github.event.pull_request.head.ref }} + PR_NUMBER: ${{ github.event.pull_request.number }} + CHANGED_FILES: ${{ steps.changed-files.outputs.files }} + run: | + # Determine action based on PR event + if [ "${{ github.event.action }}" = "closed" ]; then + ACTION="close" + CHANGED_FILES='[]' + else + ACTION="sync" + fi + + # Build the payload + PAYLOAD=$(jq -n \ + --arg action "$ACTION" \ + --arg source_repo "Shopify/ui-extensions" \ + --arg source_branch "$SOURCE_BRANCH" \ + --arg source_ref "$SOURCE_REF" \ + --argjson source_pr_number "$PR_NUMBER" \ + --argjson changed_files "$CHANGED_FILES" \ + '{ + event_type: "templated-api-docs-sync", + client_payload: { + action: $action, + source_repo: $source_repo, + source_branch: $source_branch, + source_ref: $source_ref, + source_pr_number: $source_pr_number, + changed_files: $changed_files + } + }') + + echo "Dispatching to shop/world with payload:" + echo "$PAYLOAD" | jq . + + # Send the dispatch request + HTTP_STATUS=$(curl -s -o response.txt -w "%{http_code}" \ + -X POST \ + -H "Authorization: Bearer $GH_TOKEN" \ + -H "Accept: application/vnd.github+json" \ + https://api.github.com/repos/shop/world/dispatches \ + -d "$PAYLOAD") + + if [ "$HTTP_STATUS" -ge 200 ] && [ "$HTTP_STATUS" -lt 300 ]; then + echo "Successfully dispatched docs $ACTION event to shop/world (HTTP $HTTP_STATUS)" + else + echo "Failed to dispatch docs $ACTION event (HTTP $HTTP_STATUS)" + cat response.txt + exit 1 + fi diff --git a/.gitignore b/.gitignore index 751edf12a8..6422a26308 100644 --- a/.gitignore +++ b/.gitignore @@ -11,10 +11,10 @@ packages/**/*.mjs !components.d.ts packages/**/*.js !packages/**/__mocks__/**/*.js +!packages/**/intents/examples/*.js packages/**/bin !packages/**/.eslintrc.js *.log -packages/ui-extensions/docs/**/generated # IntelliJ IDE ignore .idea diff --git a/.prettierignore b/.prettierignore index 1186ebb729..e8e3c96f28 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,4 +1,7 @@ node_modules +.shopify +**/.shopify packages/*/build packages/web-pixels-extension/src/schemas/pixel-events.jtd.json -packages/ui-extensions/src/surfaces/checkout/**/*.d.ts \ No newline at end of file +packages/ui-extensions/src/surfaces/checkout/**/*.d.ts +packages/ui-extensions/docs/**/generated/**/*.json \ No newline at end of file diff --git a/.prettierrc b/.prettierrc index 03d85fb91e..daf192e09e 100644 --- a/.prettierrc +++ b/.prettierrc @@ -12,6 +12,14 @@ "options": { "printWidth": 50 } + }, + { + "files": [ + "packages/ui-extensions-tester/**/README.md" + ], + "options": { + "printWidth": 50 + } } ] } \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000000..a20fca7135 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,12 @@ +# AGENTS.md + +After every change, you must: + +1. **Run `yarn build`** — rebuild any changed packages. +2. **Run relevant tests** — ensure all affected test suites pass. Read ./CONTRIBUTING.md for how to run tests. +3. **Check for type errors** — run the TypeScript compiler to verify there are no type errors. +4. **Check for lint and formatting errors** — run the linter and formatter to ensure code quality. + +## ui-extensions-tester + +When working on `ui-extensions-tester`, ALWAYS read [packages/ui-extensions-tester/AGENTS.md](packages/ui-extensions-tester/AGENTS.md). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d20e8a61fc..8075d59fa0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,3 +7,25 @@ These packages act as the public API Shopify is exposing for UI Extensions in ou Though we are not accepting contributions, we’d still love to hear from you! If you have ideas for new components or APIs, please [raise an issue on this repo](https://github.com/Shopify/ui-extensions/issues/new/choose). We will also happily accept pull requests for fixing typos in the documentation. If you do raise an issue or PR on this repo, please read [the code of conduct](./CODE_OF_CONDUCT.md), which all contributors must adhere to. Shopifolk looking to contribute fixes and new features to our UI extension APIs can follow the [versions and deploys guide](./documentation/versions-and-deploys.md). + +## Development + +Build all libraries: + +``` +yarn build +``` + +## Development on ui-extensions-tester + +Run all tests: + +``` +yarn test -- packages/ui-extensions-tester/ +``` + +For integration, run all example test suites: + +``` +yarn test:example-suites +``` diff --git a/README.md b/README.md index ee103a1d07..e1d923a632 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This repo contains the public definition of Shopify’s UI extension API. App developers can use these libraries for a strongly-typed, optimized development experience that lets them focus on integrating their app’s features deep into Shopify workflows. You can learn more about what is possible with UI extensions in [Shopify’s developer documentation](https://shopify.dev/api/checkout-extensions/checkout). -> **Note:** UI extensions are a [versioned API](https://shopify.dev/api/usage/versioning). This branch contains the APIs for the `2026-01` API version. The following API versions are available as separate branches in this repo: [`2025-07`](https://github.com/Shopify/ui-extensions/tree/2025-07), [`2025-10`](https://github.com/Shopify/ui-extensions/tree/2025-10) +> **Note:** UI extensions are a [versioned API](https://shopify.dev/api/usage/versioning). This branch contains the APIs for the `2026-04-rc` API version. The following API versions are available as separate branches in this repo: [`2025-07`](https://github.com/Shopify/ui-extensions/tree/2025-07), [`2025-10`](https://github.com/Shopify/ui-extensions/tree/2025-10) Shopify provides UI extension APIs via the [`@shopify/ui-extensions` package](./packages/ui-extensions/) which lets developers use a small, strongly-typed JavaScript API for creating UI extensions diff --git a/dev.yml b/dev.yml index bc5040d07e..b7ef15b695 100644 --- a/dev.yml +++ b/dev.yml @@ -1,4 +1,6 @@ name: ui-extensions +minimum_dependency_age: + enforce: false up: - node: diff --git a/documentation/versions-and-deploys.md b/documentation/versions-and-deploys.md index 281bbc2d49..611d8d12f5 100644 --- a/documentation/versions-and-deploys.md +++ b/documentation/versions-and-deploys.md @@ -4,19 +4,19 @@ Shopify’s UI extensions are a [versioned API](https://shopify.dev/api/usage/ve ## RC -Whenever a new stable version is released we also create a release-candidate (RC) branch for the next stable version. For example, `2025-01` is created at the same time as `2025-04-rc` and is used for previewing `2025-04` before it is promoted to stable. RC branches are stricter than `unstable` and we should try to avoid including APIs that are not finalized. These branches publish UI extension packages using a special `{{SEMVER}}-rc.{{VERSION}}` (ex. `2025.10.0-rc.5`) version number, which allows us to release continuously without bumping the semver. Changesets merged into RC branches will trigger a PR to be created for [deploying the package to NPM](#deploying-new-versions-to-npm). +Whenever a new stable version is released we also create a release-candidate (RC) branch for the next stable version. For example, `2025-01` is created at the same time as `2025-04-rc` and is used for previewing `2025-04` before it is promoted to stable. The latest RC branch is where active development happens (see [Adding code](#adding-code)). To keep RC branches stable, avoid merging APIs that are not yet finalized directly into an RC — do that work on a feature branch first. These branches publish UI extension packages using a special `{{SEMVER}}-rc.{{VERSION}}` (ex. `2025.10.0-rc.5`) version number, which allows us to release continuously without bumping the semver. Changesets merged into RC branches will trigger a PR to be created for [deploying the package to NPM](#deploying-new-versions-to-npm). -## Unstable +## Unstable (deprecated) -The [`unstable` branch](https://github.com/Shopify/ui-extensions/tree/unstable) is used to build experimental features before they are promoted to an RC. This version is meant to allow third parties to try out experimental extension APIs before they are released for use in production environments. This branch publishes UI extension packages using a special `0.0.0-unstable-{{TIMESTAMP}}` version number, which allows us to release it continuously as changes are made. +> **Deprecated**: The [`unstable` branch](https://github.com/Shopify/ui-extensions/tree/unstable) is deprecated and frozen at `2025-07`. It still runs on [`remote-ui`](https://github.com/Shopify/remote-ui), which the rest of the repo has since moved away from, so it can't be updated without breaking extensions that still run on it. Don't branch off it or target it with new work — branch off the latest RC branch instead (see [Adding code](#adding-code)). > **Note**: Shopify also released a set of UI extension packages that had NPM versions, but did not follow a formal API versioning system. These packages, like `@shopify/checkout-ui-extensions` and `@shopify/admin-ui-extensions`, are still available, but are on a [“legacy” branch](https://github.com/Shopify/ui-extensions/tree/main). If you are trying to deploy new versions of those packages, the instructions in this document **do not apply**. ## Adding code -Most code added to this repo will be added to the `unstable` branch, which captures the latest public APIs Shopify has made available. Code changes should only be added to RC branches when we're confident the API is unlikely to change. Stable version branches should only be getting bugfixes (`patches`) — no new features should be added to them. +Most code added to this repo will be added to the latest RC branch, which captures the latest public APIs Shopify has made available. New and experimental work happens against the latest RC: until an API is finalized, do that work on a feature branch and only merge it into the RC once you're confident the API is unlikely to change. Stable version branches should only be getting bugfixes (`patches`) — no new features should be added to them. -To start adding code, branch off of the `unstable` branch (or the branch for the version you’re working on). Make your changes as you normally would. Before creating a PR for your work, though, you will need to run a command to generate a [changeset](https://github.com/changesets/changesets): +To start adding code, branch off of the latest RC branch (or the branch for the version you’re working on) to create a feature branch. Make your changes as you normally would. Before creating a PR for your work, though, you will need to run a command to generate a [changeset](https://github.com/changesets/changesets): ```bash yarn changeset @@ -37,8 +37,6 @@ Commit your changeset file alongside the rest of the changes you are making — When changeset files are detected on any of the stable version or RC branches, a GitHub action will create a new PR that merges all the unpublished changesets together into a single changelog, and increments the version number on updated packages. This PR on stable branches should be reviewed and merged by a member of the [UI Extension Stewards GitHub team](https://github.com/orgs/Shopify/teams/ui-extension-stewards). Once it is merged, the new package versions will automatically be published to NPM, with a tag corresponding to their API version (for example, `yarn add @shopify/ui-extensions@2023-01` will install the latest package version for the `2023-01` API version). -The `unstable` branch does not have the additional step of creating a PR to merge changesets “on-demand”. Instead, _every_ merge into the branches causes a new set of versions to be published to NPM. A GitHub action watches this branch and, when any changes are detected, it will create a [“snapshot release”](https://github.com/changesets/changesets/blob/main/docs/snapshot-releases.md) that publishes the changed packages as they exist at that point in time. Snapshot versions a unique timestamp and are published to NPM with an `unstable` tag. This allows developers to get the latest `unstable` of a package by running an install command referencing the tag, like `yarn add @shopify/ui-extensions@unstable`. - ## Creating new stable versions > **Note:** only members of the [UI Extension Stewards GitHub team](https://github.com/orgs/Shopify/teams/ui-extension-stewards) should create new stable versions. @@ -53,5 +51,4 @@ To create a new stable version, you will need to follow these steps: 1. Update the [`LATEST_STABLE_VERSION`](https://github.com/Shopify/ui-extensions/settings/variables/actions) repository variable to your stable version (i.e. `2025-04`). This ensures means it will be marked with a `latest` npm dist-tag on NPM. 1. Merge the PR, and let robots release the new versions to NPM and tag it appropriately. 1. Create a new RC branch for the next stable release off of the current stable release. For example, if you've release `2025-04` you should create a new branch `2025-07-rc` off of `2025-04`. -1. For any changes from `unstable` that have been incorporated into the new version, delete their changeset files on the `unstable` branch and replace the existing `CHANGELOG.md` files in `unstable` with what was just shipped. 1. Send a message announcing the release. Let teams know that now is the time to update their section's docs and CLI templates. diff --git a/examples/testing/admin-testing-example/.gitignore b/examples/testing/admin-testing-example/.gitignore new file mode 100644 index 0000000000..43a02ea149 --- /dev/null +++ b/examples/testing/admin-testing-example/.gitignore @@ -0,0 +1,29 @@ +# Environment Configuration +.env +.env.* + +# Dependency directory +node_modules + +# Test coverage directory +coverage + +# Ignore Apple macOS Desktop Services Store +.DS_Store + +# Logs +logs +*.log + +# extensions build output +extensions/*/build +extensions/*/dist + +# lock files + + + + +# Ignore shopify files created during app dev +.shopify/* +.shopify.lock \ No newline at end of file diff --git a/examples/testing/admin-testing-example/.graphqlrc.js b/examples/testing/admin-testing-example/.graphqlrc.js new file mode 100644 index 0000000000..b58eae185c --- /dev/null +++ b/examples/testing/admin-testing-example/.graphqlrc.js @@ -0,0 +1,30 @@ +const fs = require("node:fs"); + +function getConfig() { + const config = { + projects: {}, + }; + + let extensions = []; + try { + extensions = fs.readdirSync("./extensions"); + } catch { + // ignore if no extensions + } + + for (const entry of extensions) { + const extensionPath = `./extensions/${entry}`; + const schema = `${extensionPath}/schema.graphql`; + if (!fs.existsSync(schema)) { + continue; + } + config.projects[entry] = { + schema, + documents: [`${extensionPath}/**/*.graphql`], + }; + } + + return config; +} + +module.exports = getConfig(); diff --git a/examples/testing/admin-testing-example/README.md b/examples/testing/admin-testing-example/README.md new file mode 100644 index 0000000000..5302bac8c1 --- /dev/null +++ b/examples/testing/admin-testing-example/README.md @@ -0,0 +1,23 @@ +This extension was created with: + +``` +shopify app init --name admin-testing-example +cd admin-testing-example +shopify app generate extension --template admin_block +``` + +See it in action: + +Build the root package: + +``` +yarn build +``` + +Change into this example package and run: + +``` +npm install +npm run typecheck +npm test +``` diff --git a/examples/testing/admin-testing-example/extensions/.gitkeep b/examples/testing/admin-testing-example/extensions/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/examples/testing/admin-testing-example/extensions/admin-testing-example/package-lock.json b/examples/testing/admin-testing-example/extensions/admin-testing-example/package-lock.json new file mode 100644 index 0000000000..b90d849acf --- /dev/null +++ b/examples/testing/admin-testing-example/extensions/admin-testing-example/package-lock.json @@ -0,0 +1,336 @@ +{ + "name": "admin-testing-example", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "admin-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "@shopify/ui-extensions": "2026.1.x", + "preact": "^10.10.x" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@shopify/ui-extensions": { + "version": "2026.1.1", + "resolved": "https://npm.shopify.io/node/@shopify/ui-extensions/-/ui-extensions-2026.1.1.tgz", + "integrity": "sha512-QjyU/PsbmEM0f/UmPA0MVwPjMy4tZxecBtoh7YqZk0D3RrAK9fw5FTn+yDVw6YOIcH97/Wk5zJCUuXVCJ85C1A==", + "license": "MIT", + "dependencies": { + "ts-morph": "^25.0.1" + }, + "peerDependencies": { + "@preact/signals": "*", + "preact": "*" + }, + "peerDependenciesMeta": { + "@preact/signals": { + "optional": true + }, + "preact": { + "optional": true + } + } + }, + "node_modules/@ts-morph/common": { + "version": "0.26.1", + "resolved": "https://registry.npmjs.org/@ts-morph/common/-/common-0.26.1.tgz", + "integrity": "sha512-Sn28TGl/4cFpcM+jwsH1wLncYq3FtN/BIpem+HOygfBWPT5pAeS5dB4VFVzV8FbnOKHpDLZmvAl4AjPEev5idA==", + "license": "MIT", + "dependencies": { + "fast-glob": "^3.3.2", + "minimatch": "^9.0.4", + "path-browserify": "^1.0.1" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" + }, + "node_modules/brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/code-block-writer": { + "version": "13.0.3", + "resolved": "https://registry.npmjs.org/code-block-writer/-/code-block-writer-13.0.3.tgz", + "integrity": "sha512-Oofo0pq3IKnsFtuHqSF7TqBfr71aeyZDVJ0HpmqB7FBM2qEigL0iPONSCZSO9pE9dZTAxANe5XHG9Uy0YMv8cg==", + "license": "MIT" + }, + "node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fastq": { + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/path-browserify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz", + "integrity": "sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==", + "license": "MIT" + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/preact": { + "version": "10.28.3", + "resolved": "https://registry.npmjs.org/preact/-/preact-10.28.3.tgz", + "integrity": "sha512-tCmoRkPQLpBeWzpmbhryairGnhW9tKV6c6gr/w+RhoRoKEJwsjzipwp//1oCpGPOchvSLaAPlpcJi9MwMmoPyA==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/reusify": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/ts-morph": { + "version": "25.0.1", + "resolved": "https://registry.npmjs.org/ts-morph/-/ts-morph-25.0.1.tgz", + "integrity": "sha512-QJEiTdnz1YjrB3JFhd626gX4rKHDLSjSVMvGGG4v7ONc3RBwa0Eei98G9AT9uNFDMtV54JyuXsFeC+OH0n6bXQ==", + "license": "MIT", + "dependencies": { + "@ts-morph/common": "~0.26.0", + "code-block-writer": "^13.0.3" + } + } + } +} diff --git a/examples/testing/admin-testing-example/extensions/admin-testing-example/package.json b/examples/testing/admin-testing-example/extensions/admin-testing-example/package.json new file mode 100644 index 0000000000..03bdc8e2d7 --- /dev/null +++ b/examples/testing/admin-testing-example/extensions/admin-testing-example/package.json @@ -0,0 +1,10 @@ +{ + "name": "admin-testing-example", + "private": true, + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "preact": "^10.10.x", + "@shopify/ui-extensions": "2026.4.x" + } +} diff --git a/examples/testing/admin-testing-example/extensions/admin-testing-example/shopify.d.ts b/examples/testing/admin-testing-example/extensions/admin-testing-example/shopify.d.ts new file mode 100644 index 0000000000..52c8bdf378 --- /dev/null +++ b/examples/testing/admin-testing-example/extensions/admin-testing-example/shopify.d.ts @@ -0,0 +1,7 @@ +import '@shopify/ui-extensions'; + +//@ts-ignore +declare module './src/SelectionAction.jsx' { + const shopify: import('@shopify/ui-extensions/admin.product-index.selection-action.render').Api; + const globalThis: { shopify: typeof shopify }; +} diff --git a/examples/testing/admin-testing-example/extensions/admin-testing-example/shopify.extension.toml b/examples/testing/admin-testing-example/extensions/admin-testing-example/shopify.extension.toml new file mode 100644 index 0000000000..6295c529f7 --- /dev/null +++ b/examples/testing/admin-testing-example/extensions/admin-testing-example/shopify.extension.toml @@ -0,0 +1,10 @@ +api_version = "2026-07" + +[[extensions]] +name = "admin-testing-example" +handle = "admin-testing-example" +type = "ui_extension" + +[[extensions.targeting]] +module = "./src/SelectionAction.jsx" +target = "admin.product-index.selection-action.render" diff --git a/examples/testing/admin-testing-example/extensions/admin-testing-example/src/SelectionAction.jsx b/examples/testing/admin-testing-example/extensions/admin-testing-example/src/SelectionAction.jsx new file mode 100644 index 0000000000..67119d4d0d --- /dev/null +++ b/examples/testing/admin-testing-example/extensions/admin-testing-example/src/SelectionAction.jsx @@ -0,0 +1,22 @@ +import {render} from 'preact'; + +export default async () => { + render(, document.body); +}; + +function Extension() { + const {i18n, data} = shopify; + const selectedCount = data.selected.length; + + return ( + + + + {selectedCount === 1 + ? i18n.translate('single_product') + : i18n.translate('multiple_products', {count: selectedCount})} + + + + ); +} diff --git a/examples/testing/admin-testing-example/extensions/admin-testing-example/tests/SelectionAction.test.ts b/examples/testing/admin-testing-example/extensions/admin-testing-example/tests/SelectionAction.test.ts new file mode 100644 index 0000000000..4bb38be93a --- /dev/null +++ b/examples/testing/admin-testing-example/extensions/admin-testing-example/tests/SelectionAction.test.ts @@ -0,0 +1,51 @@ +/// +// ^ This defines types for custom Shopify elements supported by the target. + +import {expect, test, beforeEach, afterEach} from 'vitest'; +import {getExtension} from '@shopify/ui-extensions-tester'; + +const extension = getExtension( + 'admin.product-index.selection-action.render', +); + +beforeEach(() => { + extension.setUp(); +}); + +afterEach(() => { + extension.tearDown(); +}); + +test('shows the single_product key when one product is selected', async () => { + extension.shopify.data.selected = [ + {id: 'gid://shopify/Product/1'}, + ]; + + await extension.render(); + + const text = document.body.querySelector('s-text')!; + expect(text.textContent).toEqual('single_product'); +}); + +test('shows the multiple_products key when multiple products are selected', async () => { + extension.shopify.data.selected = [ + {id: 'gid://shopify/Product/1'}, + {id: 'gid://shopify/Product/2'}, + ]; + + await extension.render(); + + const text = document.body.querySelector('s-text')!; + expect(text.textContent).toEqual('multiple_products'); +}); + +test('uses the heading key for the action heading', async () => { + extension.shopify.data.selected = [ + {id: 'gid://shopify/Product/1'}, + ]; + + await extension.render(); + + const action = document.body.querySelector('s-admin-action')!; + expect(action.getAttribute('heading')).toEqual('heading'); +}); diff --git a/examples/testing/admin-testing-example/extensions/admin-testing-example/tsconfig.json b/examples/testing/admin-testing-example/extensions/admin-testing-example/tsconfig.json new file mode 100644 index 0000000000..c083a75321 --- /dev/null +++ b/examples/testing/admin-testing-example/extensions/admin-testing-example/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "jsx": "react-jsx", + "jsxImportSource": "preact", + "target": "ES2020", + "allowJs": true, + "module": "esnext", + "moduleResolution": "node", + "esModuleInterop": true, + "strict": true, + "skipLibCheck": true, + "baseUrl": ".", + // Monorepo only: file: deps create symlinks that cause TS to + // resolve a different preact instance. Not needed with published packages. + "paths": { + "preact": ["../../node_modules/preact"], + "preact/*": ["../../node_modules/preact/*"] + } + }, + "include": ["./src", "./tests", "./shopify.d.ts"] +} diff --git a/examples/testing/admin-testing-example/package-lock.json b/examples/testing/admin-testing-example/package-lock.json new file mode 100644 index 0000000000..b5ec965a13 --- /dev/null +++ b/examples/testing/admin-testing-example/package-lock.json @@ -0,0 +1,2853 @@ +{ + "name": "admin-testing-example", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "admin-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "@shopify/ui-extensions": "file:../../../packages/ui-extensions" + }, + "devDependencies": { + "@shopify/ui-extensions-tester": "file:../../../packages/ui-extensions-tester", + "@testing-library/preact": "^3.2.0", + "typescript": "^5.0.0", + "vitest": "^3.0.0" + } + }, + "../../../packages/ui-extensions": { + "name": "@shopify/ui-extensions", + "version": "2026.4.0-rc.2", + "license": "MIT", + "dependencies": { + "ts-morph": "^25.0.1" + }, + "devDependencies": { + "@faker-js/faker": "^8.4.1", + "@preact/signals": "^2.3.x", + "@quilted/react-testing": "^0.6.11", + "@remote-ui/async-subscription": "^2.1.16", + "@shopify/generate-docs": "https://registry.npmjs.org/@shopify/generate-docs/-/generate-docs-0.19.8.tgz", + "preact": "^10.10.x", + "typescript": "^4.9.0" + }, + "peerDependencies": { + "@preact/signals": "*", + "preact": "*" + }, + "peerDependenciesMeta": { + "@preact/signals": { + "optional": true + }, + "preact": { + "optional": true + } + } + }, + "../../../packages/ui-extensions-tester": { + "name": "@shopify/ui-extensions-tester", + "version": "2026.4.0-rc.2", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/ui-extensions": "2026.4.0-rc.2" + }, + "devDependencies": { + "typescript": "^4.9.0" + }, + "peerDependencies": { + "preact": "^10.0.0" + }, + "peerDependenciesMeta": { + "preact": { + "optional": true + } + } + }, + "node_modules/@babel/code-frame": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.28.5", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/runtime": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.28.6.tgz", + "integrity": "sha512-05WQkdpL9COIMz4LjTxGpPNCdlpyimKppYNoJ5Di5EUObifl8t4tuLuUBBZEpoLYOmfvIWrsp9fCl0HoPRVTdA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.3.tgz", + "integrity": "sha512-9fJMTNFTWZMh5qwrBItuziu834eOCUcEqymSH7pY+zoMVEZg3gcPuBNxH1EvfVYe9h0x/Ptw8KBzv7qxb7l8dg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.3.tgz", + "integrity": "sha512-i5D1hPY7GIQmXlXhs2w8AWHhenb00+GxjxRncS2ZM7YNVGNfaMxgzSGuO8o8SJzRc/oZwU2bcScvVERk03QhzA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.3.tgz", + "integrity": "sha512-YdghPYUmj/FX2SYKJ0OZxf+iaKgMsKHVPF1MAq/P8WirnSpCStzKJFjOjzsW0QQ7oIAiccHdcqjbHmJxRb/dmg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.3.tgz", + "integrity": "sha512-IN/0BNTkHtk8lkOM8JWAYFg4ORxBkZQf9zXiEOfERX/CzxW3Vg1ewAhU7QSWQpVIzTW+b8Xy+lGzdYXV6UZObQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.3.tgz", + "integrity": "sha512-Re491k7ByTVRy0t3EKWajdLIr0gz2kKKfzafkth4Q8A5n1xTHrkqZgLLjFEHVD+AXdUGgQMq+Godfq45mGpCKg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.3.tgz", + "integrity": "sha512-vHk/hA7/1AckjGzRqi6wbo+jaShzRowYip6rt6q7VYEDX4LEy1pZfDpdxCBnGtl+A5zq8iXDcyuxwtv3hNtHFg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.3.tgz", + "integrity": "sha512-ipTYM2fjt3kQAYOvo6vcxJx3nBYAzPjgTCk7QEgZG8AUO3ydUhvelmhrbOheMnGOlaSFUoHXB6un+A7q4ygY9w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.3.tgz", + "integrity": "sha512-dDk0X87T7mI6U3K9VjWtHOXqwAMJBNN2r7bejDsc+j03SEjtD9HrOl8gVFByeM0aJksoUuUVU9TBaZa2rgj0oA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.3.tgz", + "integrity": "sha512-s6nPv2QkSupJwLYyfS+gwdirm0ukyTFNl3KTgZEAiJDd+iHZcbTPPcWCcRYH+WlNbwChgH2QkE9NSlNrMT8Gfw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.3.tgz", + "integrity": "sha512-sZOuFz/xWnZ4KH3YfFrKCf1WyPZHakVzTiqji3WDc0BCl2kBwiJLCXpzLzUBLgmp4veFZdvN5ChW4Eq/8Fc2Fg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.3.tgz", + "integrity": "sha512-yGlQYjdxtLdh0a3jHjuwOrxQjOZYD/C9PfdbgJJF3TIZWnm/tMd/RcNiLngiu4iwcBAOezdnSLAwQDPqTmtTYg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.3.tgz", + "integrity": "sha512-WO60Sn8ly3gtzhyjATDgieJNet/KqsDlX5nRC5Y3oTFcS1l0KWba+SEa9Ja1GfDqSF1z6hif/SkpQJbL63cgOA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.3.tgz", + "integrity": "sha512-APsymYA6sGcZ4pD6k+UxbDjOFSvPWyZhjaiPyl/f79xKxwTnrn5QUnXR5prvetuaSMsb4jgeHewIDCIWljrSxw==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.3.tgz", + "integrity": "sha512-eizBnTeBefojtDb9nSh4vvVQ3V9Qf9Df01PfawPcRzJH4gFSgrObw+LveUyDoKU3kxi5+9RJTCWlj4FjYXVPEA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.3.tgz", + "integrity": "sha512-3Emwh0r5wmfm3ssTWRQSyVhbOHvqegUDRd0WhmXKX2mkHJe1SFCMJhagUleMq+Uci34wLSipf8Lagt4LlpRFWQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.3.tgz", + "integrity": "sha512-pBHUx9LzXWBc7MFIEEL0yD/ZVtNgLytvx60gES28GcWMqil8ElCYR4kvbV2BDqsHOvVDRrOxGySBM9Fcv744hw==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.3.tgz", + "integrity": "sha512-Czi8yzXUWIQYAtL/2y6vogER8pvcsOsk5cpwL4Gk5nJqH5UZiVByIY8Eorm5R13gq+DQKYg0+JyQoytLQas4dA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.3.tgz", + "integrity": "sha512-sDpk0RgmTCR/5HguIZa9n9u+HVKf40fbEUt+iTzSnCaGvY9kFP0YKBWZtJaraonFnqef5SlJ8/TiPAxzyS+UoA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.3.tgz", + "integrity": "sha512-P14lFKJl/DdaE00LItAukUdZO5iqNH7+PjoBm+fLQjtxfcfFE20Xf5CrLsmZdq5LFFZzb5JMZ9grUwvtVYzjiA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.3.tgz", + "integrity": "sha512-AIcMP77AvirGbRl/UZFTq5hjXK+2wC7qFRGoHSDrZ5v5b8DK/GYpXW3CPRL53NkvDqb9D+alBiC/dV0Fb7eJcw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.3.tgz", + "integrity": "sha512-DnW2sRrBzA+YnE70LKqnM3P+z8vehfJWHXECbwBmH/CU51z6FiqTQTHFenPlHmo3a8UgpLyH3PT+87OViOh1AQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.3.tgz", + "integrity": "sha512-NinAEgr/etERPTsZJ7aEZQvvg/A6IsZG/LgZy+81wON2huV7SrK3e63dU0XhyZP4RKGyTm7aOgmQk0bGp0fy2g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.3.tgz", + "integrity": "sha512-PanZ+nEz+eWoBJ8/f8HKxTTD172SKwdXebZ0ndd953gt1HRBbhMsaNqjTyYLGLPdoWHy4zLU7bDVJztF5f3BHA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.3.tgz", + "integrity": "sha512-B2t59lWWYrbRDw/tjiWOuzSsFh1Y/E95ofKz7rIVYSQkUYBjfSgf6oeYPNWHToFRr2zx52JKApIcAS/D5TUBnA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.3.tgz", + "integrity": "sha512-QLKSFeXNS8+tHW7tZpMtjlNb7HKau0QDpwm49u0vUp9y1WOF+PEzkU84y9GqYaAVW8aH8f3GcBck26jh54cX4Q==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.3.tgz", + "integrity": "sha512-4uJGhsxuptu3OcpVAzli+/gWusVGwZZHTlS63hh++ehExkVT8SgiEf7/uC/PclrPPkLhZqGgCTjd0VWLo6xMqA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "dev": true, + "license": "MIT" + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.59.0.tgz", + "integrity": "sha512-upnNBkA6ZH2VKGcBj9Fyl9IGNPULcjXRlg0LLeaioQWueH30p6IXtJEbKAgvyv+mJaMxSm1l6xwDXYjpEMiLMg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.59.0.tgz", + "integrity": "sha512-hZ+Zxj3SySm4A/DylsDKZAeVg0mvi++0PYVceVyX7hemkw7OreKdCvW2oQ3T1FMZvCaQXqOTHb8qmBShoqk69Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.59.0.tgz", + "integrity": "sha512-W2Psnbh1J8ZJw0xKAd8zdNgF9HRLkdWwwdWqubSVk0pUuQkoHnv7rx4GiF9rT4t5DIZGAsConRE3AxCdJ4m8rg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.59.0.tgz", + "integrity": "sha512-ZW2KkwlS4lwTv7ZVsYDiARfFCnSGhzYPdiOU4IM2fDbL+QGlyAbjgSFuqNRbSthybLbIJ915UtZBtmuLrQAT/w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.59.0.tgz", + "integrity": "sha512-EsKaJ5ytAu9jI3lonzn3BgG8iRBjV4LxZexygcQbpiU0wU0ATxhNVEpXKfUa0pS05gTcSDMKpn3Sx+QB9RlTTA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.59.0.tgz", + "integrity": "sha512-d3DuZi2KzTMjImrxoHIAODUZYoUUMsuUiY4SRRcJy6NJoZ6iIqWnJu9IScV9jXysyGMVuW+KNzZvBLOcpdl3Vg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.59.0.tgz", + "integrity": "sha512-t4ONHboXi/3E0rT6OZl1pKbl2Vgxf9vJfWgmUoCEVQVxhW6Cw/c8I6hbbu7DAvgp82RKiH7TpLwxnJeKv2pbsw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.59.0.tgz", + "integrity": "sha512-CikFT7aYPA2ufMD086cVORBYGHffBo4K8MQ4uPS/ZnY54GKj36i196u8U+aDVT2LX4eSMbyHtyOh7D7Zvk2VvA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.59.0.tgz", + "integrity": "sha512-jYgUGk5aLd1nUb1CtQ8E+t5JhLc9x5WdBKew9ZgAXg7DBk0ZHErLHdXM24rfX+bKrFe+Xp5YuJo54I5HFjGDAA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.59.0.tgz", + "integrity": "sha512-peZRVEdnFWZ5Bh2KeumKG9ty7aCXzzEsHShOZEFiCQlDEepP1dpUl/SrUNXNg13UmZl+gzVDPsiCwnV1uI0RUA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.59.0.tgz", + "integrity": "sha512-gbUSW/97f7+r4gHy3Jlup8zDG190AuodsWnNiXErp9mT90iCy9NKKU0Xwx5k8VlRAIV2uU9CsMnEFg/xXaOfXg==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.59.0.tgz", + "integrity": "sha512-yTRONe79E+o0FWFijasoTjtzG9EBedFXJMl888NBEDCDV9I2wGbFFfJQQe63OijbFCUZqxpHz1GzpbtSFikJ4Q==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.59.0.tgz", + "integrity": "sha512-sw1o3tfyk12k3OEpRddF68a1unZ5VCN7zoTNtSn2KndUE+ea3m3ROOKRCZxEpmT9nsGnogpFP9x6mnLTCaoLkA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.59.0.tgz", + "integrity": "sha512-+2kLtQ4xT3AiIxkzFVFXfsmlZiG5FXYW7ZyIIvGA7Bdeuh9Z0aN4hVyXS/G1E9bTP/vqszNIN/pUKCk/BTHsKA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.59.0.tgz", + "integrity": "sha512-NDYMpsXYJJaj+I7UdwIuHHNxXZ/b/N2hR15NyH3m2qAtb/hHPA4g4SuuvrdxetTdndfj9b1WOmy73kcPRoERUg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.59.0.tgz", + "integrity": "sha512-nLckB8WOqHIf1bhymk+oHxvM9D3tyPndZH8i8+35p/1YiVoVswPid2yLzgX7ZJP0KQvnkhM4H6QZ5m0LzbyIAg==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.59.0.tgz", + "integrity": "sha512-oF87Ie3uAIvORFBpwnCvUzdeYUqi2wY6jRFWJAy1qus/udHFYIkplYRW+wo+GRUP4sKzYdmE1Y3+rY5Gc4ZO+w==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.59.0.tgz", + "integrity": "sha512-3AHmtQq/ppNuUspKAlvA8HtLybkDflkMuLK4DPo77DfthRb71V84/c4MlWJXixZz4uruIH4uaa07IqoAkG64fg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.59.0.tgz", + "integrity": "sha512-2UdiwS/9cTAx7qIUZB/fWtToJwvt0Vbo0zmnYt7ED35KPg13Q0ym1g442THLC7VyI6JfYTP4PiSOWyoMdV2/xg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.59.0.tgz", + "integrity": "sha512-M3bLRAVk6GOwFlPTIxVBSYKUaqfLrn8l0psKinkCFxl4lQvOSz8ZrKDz2gxcBwHFpci0B6rttydI4IpS4IS/jQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.59.0.tgz", + "integrity": "sha512-tt9KBJqaqp5i5HUZzoafHZX8b5Q2Fe7UjYERADll83O4fGqJ49O1FsL6LpdzVFQcpwvnyd0i+K/VSwu/o/nWlA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.59.0.tgz", + "integrity": "sha512-V5B6mG7OrGTwnxaNUzZTDTjDS7F75PO1ae6MJYdiMu60sq0CqN5CVeVsbhPxalupvTX8gXVSU9gq+Rx1/hvu6A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.59.0.tgz", + "integrity": "sha512-UKFMHPuM9R0iBegwzKF4y0C4J9u8C6MEJgFuXTBerMk7EJ92GFVFYBfOZaSGLu6COf7FxpQNqhNS4c4icUPqxA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.59.0.tgz", + "integrity": "sha512-laBkYlSS1n2L8fSo1thDNGrCTQMmxjYY5G0WFWjFFYZkKPjsMBsgJfGf4TLxXrF6RyhI60L8TMOjBMvXiTcxeA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.59.0.tgz", + "integrity": "sha512-2HRCml6OztYXyJXAvdDXPKcawukWY2GpR5/nxKp4iBgiO3wcoEGkAaqctIbZcNB6KlUQBIqt8VYkNSj2397EfA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@shopify/ui-extensions": { + "resolved": "../../../packages/ui-extensions", + "link": true + }, + "node_modules/@shopify/ui-extensions-tester": { + "resolved": "../../../packages/ui-extensions-tester", + "link": true + }, + "node_modules/@testing-library/dom": { + "version": "8.20.1", + "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-8.20.1.tgz", + "integrity": "sha512-/DiOQ5xBxgdYRC8LNk7U+RWat0S3qRLeIw3ZIkMQ9kkVlRmwD/Eg8k8CqIpD6GW7u20JIUOfMKbxtiLutpjQ4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.10.4", + "@babel/runtime": "^7.12.5", + "@types/aria-query": "^5.0.1", + "aria-query": "5.1.3", + "chalk": "^4.1.0", + "dom-accessibility-api": "^0.5.9", + "lz-string": "^1.5.0", + "pretty-format": "^27.0.2" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@testing-library/preact": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@testing-library/preact/-/preact-3.2.4.tgz", + "integrity": "sha512-F+kJ243LP6VmEK1M809unzTE/ijg+bsMNuiRN0JEDIJBELKKDNhdgC/WrUSZ7klwJvtlO3wQZ9ix+jhObG07Fg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@testing-library/dom": "^8.11.1" + }, + "engines": { + "node": ">= 12" + }, + "peerDependencies": { + "preact": ">=10 || ^10.0.0-alpha.0 || ^10.0.0-beta.0" + } + }, + "node_modules/@types/aria-query": { + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", + "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/chai": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", + "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/deep-eql": "*", + "assertion-error": "^2.0.1" + } + }, + "node_modules/@types/deep-eql": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", + "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@vitest/expect": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", + "integrity": "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/mocker": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.2.4.tgz", + "integrity": "sha512-46ryTE9RZO/rfDd7pEqFl7etuyzekzEhUbTW3BvmeO/BcCMEgq59BKhek3dXDWgAj4oMK6OZi+vRr1wPW6qjEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "3.2.4", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.17" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "msw": "^2.4.9", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } + } + }, + "node_modules/@vitest/pretty-format": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.2.4.tgz", + "integrity": "sha512-IVNZik8IVRJRTr9fxlitMKeJeXFFFN0JaB9PHPGQ8NKQbGpfjlTx9zO4RefN8gp7eqjNy8nyK3NZmBzOPeIxtA==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/runner": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.2.4.tgz", + "integrity": "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/utils": "3.2.4", + "pathe": "^2.0.3", + "strip-literal": "^3.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/snapshot": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.2.4.tgz", + "integrity": "sha512-dEYtS7qQP2CjU27QBC5oUOxLE/v5eLkGqPE0ZKEIDGMs4vKWe7IjgLOeauHsR0D5YuuycGRO5oSRXnwnmA78fQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "magic-string": "^0.30.17", + "pathe": "^2.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/spy": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.2.4.tgz", + "integrity": "sha512-vAfasCOe6AIK70iP5UD11Ac4siNUNJ9i/9PZ3NKx07sG6sUxeag1LWdNrMWeKKYBLlzuK+Gn65Yd5nyL6ds+nw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyspy": "^4.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/utils": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.2.4.tgz", + "integrity": "sha512-fB2V0JFrQSMsCo9HiSq3Ezpdv4iYaXRG1Sx8edX3MwxfyNn83mKiGzOcH+Fkxt4MHxr3y42fQi1oeAInqgX2QA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "loupe": "^3.1.4", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/aria-query": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.1.3.tgz", + "integrity": "sha512-R5iJ5lkuHybztUfuOAznmboyjWq8O6sqNqtK7CLOqdydi54VNbORp49mb14KbWgG1QD3JFO9hJdZ+y4KutfdOQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "deep-equal": "^2.0.5" + } + }, + "node_modules/array-buffer-byte-length": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.2.tgz", + "integrity": "sha512-LHE+8BuR7RYGDKvnrmcuSq3tDcKv9OFEXQt/HpbZhY7V6h0zlUXutnAD82GiFx9rdieCMjkvtcsPqBwgUl1Iiw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "is-array-buffer": "^3.0.5" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/assertion-error": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", + "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/available-typed-arrays": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/cac": { + "version": "6.7.14", + "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", + "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/call-bind": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", + "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.0", + "es-define-property": "^1.0.0", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/chai": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz", + "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==", + "dev": true, + "license": "MIT", + "dependencies": { + "assertion-error": "^2.0.1", + "check-error": "^2.1.1", + "deep-eql": "^5.0.1", + "loupe": "^3.1.0", + "pathval": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/check-error": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz", + "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 16" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deep-eql": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", + "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/deep-equal": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-2.2.3.tgz", + "integrity": "sha512-ZIwpnevOurS8bpT4192sqAowWM76JDKSHYzMLty3BZGSswgq6pBaH3DhCSW5xVAZICZyKdOBPjwww5wfgT/6PA==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.0", + "call-bind": "^1.0.5", + "es-get-iterator": "^1.1.3", + "get-intrinsic": "^1.2.2", + "is-arguments": "^1.1.1", + "is-array-buffer": "^3.0.2", + "is-date-object": "^1.0.5", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.2", + "isarray": "^2.0.5", + "object-is": "^1.1.5", + "object-keys": "^1.1.1", + "object.assign": "^4.1.4", + "regexp.prototype.flags": "^1.5.1", + "side-channel": "^1.0.4", + "which-boxed-primitive": "^1.0.2", + "which-collection": "^1.0.1", + "which-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/dom-accessibility-api": { + "version": "0.5.16", + "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.5.16.tgz", + "integrity": "sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==", + "dev": true, + "license": "MIT" + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-get-iterator": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.3.tgz", + "integrity": "sha512-sPZmqHBe6JIiTfN5q2pEi//TwxmAFHwj/XEuYjTuse78i8KxaqMTTzxPoFKuzRpDpTJ+0NAbpfenkmH2rePtuw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.3", + "has-symbols": "^1.0.3", + "is-arguments": "^1.1.1", + "is-map": "^2.0.2", + "is-set": "^2.0.2", + "is-string": "^1.0.7", + "isarray": "^2.0.5", + "stop-iteration-iterator": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-module-lexer": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", + "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "dev": true, + "license": "MIT" + }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/esbuild": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.3.tgz", + "integrity": "sha512-8VwMnyGCONIs6cWue2IdpHxHnAjzxnw2Zr7MkVxB2vjmQ2ivqGFb4LEG3SMnv0Gb2F/G/2yA8zUaiL1gywDCCg==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.27.3", + "@esbuild/android-arm": "0.27.3", + "@esbuild/android-arm64": "0.27.3", + "@esbuild/android-x64": "0.27.3", + "@esbuild/darwin-arm64": "0.27.3", + "@esbuild/darwin-x64": "0.27.3", + "@esbuild/freebsd-arm64": "0.27.3", + "@esbuild/freebsd-x64": "0.27.3", + "@esbuild/linux-arm": "0.27.3", + "@esbuild/linux-arm64": "0.27.3", + "@esbuild/linux-ia32": "0.27.3", + "@esbuild/linux-loong64": "0.27.3", + "@esbuild/linux-mips64el": "0.27.3", + "@esbuild/linux-ppc64": "0.27.3", + "@esbuild/linux-riscv64": "0.27.3", + "@esbuild/linux-s390x": "0.27.3", + "@esbuild/linux-x64": "0.27.3", + "@esbuild/netbsd-arm64": "0.27.3", + "@esbuild/netbsd-x64": "0.27.3", + "@esbuild/openbsd-arm64": "0.27.3", + "@esbuild/openbsd-x64": "0.27.3", + "@esbuild/openharmony-arm64": "0.27.3", + "@esbuild/sunos-x64": "0.27.3", + "@esbuild/win32-arm64": "0.27.3", + "@esbuild/win32-ia32": "0.27.3", + "@esbuild/win32-x64": "0.27.3" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/expect-type": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", + "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/for-each": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.5.tgz", + "integrity": "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.2.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "dev": true, + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-bigints": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", + "integrity": "sha512-R3pbpkcIqv2Pm3dUwgjclDRVmWpTJW2DcMzcIhEXEx1oh/CEMObMm3KLmRJOdvhM7o4uQBnwr8pzRK2sJWIqfg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/internal-slot": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", + "integrity": "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "hasown": "^2.0.2", + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-arguments": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.2.0.tgz", + "integrity": "sha512-7bVbi0huj/wrIAOzb8U1aszg9kdi3KN/CyU19CTI7tAoZYEZoL9yCDXpbXN+uPsuWnP02cyug1gleqq+TU+YCA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-array-buffer": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.5.tgz", + "integrity": "sha512-DDfANUiiG2wC1qawP66qlTugJeL5HyzMpfr8lLK+jMQirGzNod0B12cFB/9q838Ru27sBwfw78/rdoU7RERz6A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-bigint": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.1.0.tgz", + "integrity": "sha512-n4ZT37wG78iz03xPRKJrHTdZbe3IicyucEtdRsV5yglwc3GyUfbAfpSeD0FJ41NbUNSt5wbhqfp1fS+BgnvDFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-bigints": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-boolean-object": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.2.2.tgz", + "integrity": "sha512-wa56o2/ElJMYqjCjGkXri7it5FbebW5usLw/nPmCMs5DeZ7eziSYZhSmPRn0txqeW4LnAmQQU7FgqLpsEFKM4A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-callable": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.1.0.tgz", + "integrity": "sha512-PwwhEakHVKTdRNVOw+/Gyh0+MzlCl4R6qKvkhuvLtPMggI1WAHt9sOwZxQLSGpUaDnrdyDsomoRgNnCfKNSXXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-map": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", + "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number-object": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.1.1.tgz", + "integrity": "sha512-lZhclumE1G6VYD8VHe35wFaIif+CTy5SJIi5+3y4psDgWu4wPDoBhF8NxUOinEc7pHgiTsT6MaBb92rKhhD+Xw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-regex": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.2.1.tgz", + "integrity": "sha512-MjYsKHO5O7mCsmRGxWcLWheFqN9DJ/2TmngvjKXihe6efViPqc274+Fx/4fYj/r03+ESvBdTXK0V6tA3rgez1g==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-set": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", + "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.4.tgz", + "integrity": "sha512-ISWac8drv4ZGfwKl5slpHG9OwPNty4jOWPRIhBpxOoD+hqITiwuipOQ2bNthAzwA3B4fIjO4Nln74N0S9byq8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-string": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.1.1.tgz", + "integrity": "sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.1.1.tgz", + "integrity": "sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-symbols": "^1.1.0", + "safe-regex-test": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakmap": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", + "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakset": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.4.tgz", + "integrity": "sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "license": "MIT" + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/loupe": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz", + "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/lz-string": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", + "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", + "dev": true, + "license": "MIT", + "bin": { + "lz-string": "bin/bin.js" + } + }, + "node_modules/magic-string": { + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.5" + } + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true, + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/object-inspect": { + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-is": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", + "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", + "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0", + "has-symbols": "^1.1.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/pathe": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", + "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", + "dev": true, + "license": "MIT" + }, + "node_modules/pathval": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz", + "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 14.16" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/possible-typed-array-names": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", + "integrity": "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/postcss": { + "version": "8.5.8", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz", + "integrity": "sha512-OW/rX8O/jXnm82Ey1k44pObPtdblfiuWnrd8X7GJ7emImCOstunGbXUpp7HdBrFQX6rJzn3sPT397Wp5aCwCHg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/preact": { + "version": "10.28.4", + "resolved": "https://registry.npmjs.org/preact/-/preact-10.28.4.tgz", + "integrity": "sha512-uKFfOHWuSNpRFVTnljsCluEFq57OKT+0QdOiQo8XWnQ/pSvg7OpX5eNOejELXJMWy+BwM2nobz0FkvzmnpCNsQ==", + "dev": true, + "license": "MIT", + "peer": true, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/pretty-format": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", + "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^17.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/pretty-format/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/react-is": { + "version": "17.0.2", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", + "dev": true, + "license": "MIT" + }, + "node_modules/regexp.prototype.flags": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", + "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "set-function-name": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/rollup": { + "version": "4.59.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.59.0.tgz", + "integrity": "sha512-2oMpl67a3zCH9H79LeMcbDhXW/UmWG/y2zuqnF2jQq5uq9TbM9TVyXvA4+t+ne2IIkBdrLpAaRQAvo7YI/Yyeg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.59.0", + "@rollup/rollup-android-arm64": "4.59.0", + "@rollup/rollup-darwin-arm64": "4.59.0", + "@rollup/rollup-darwin-x64": "4.59.0", + "@rollup/rollup-freebsd-arm64": "4.59.0", + "@rollup/rollup-freebsd-x64": "4.59.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.59.0", + "@rollup/rollup-linux-arm-musleabihf": "4.59.0", + "@rollup/rollup-linux-arm64-gnu": "4.59.0", + "@rollup/rollup-linux-arm64-musl": "4.59.0", + "@rollup/rollup-linux-loong64-gnu": "4.59.0", + "@rollup/rollup-linux-loong64-musl": "4.59.0", + "@rollup/rollup-linux-ppc64-gnu": "4.59.0", + "@rollup/rollup-linux-ppc64-musl": "4.59.0", + "@rollup/rollup-linux-riscv64-gnu": "4.59.0", + "@rollup/rollup-linux-riscv64-musl": "4.59.0", + "@rollup/rollup-linux-s390x-gnu": "4.59.0", + "@rollup/rollup-linux-x64-gnu": "4.59.0", + "@rollup/rollup-linux-x64-musl": "4.59.0", + "@rollup/rollup-openbsd-x64": "4.59.0", + "@rollup/rollup-openharmony-arm64": "4.59.0", + "@rollup/rollup-win32-arm64-msvc": "4.59.0", + "@rollup/rollup-win32-ia32-msvc": "4.59.0", + "@rollup/rollup-win32-x64-gnu": "4.59.0", + "@rollup/rollup-win32-x64-msvc": "4.59.0", + "fsevents": "~2.3.2" + } + }, + "node_modules/safe-regex-test": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.1.0.tgz", + "integrity": "sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "is-regex": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/side-channel": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", + "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/siginfo": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", + "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", + "dev": true, + "license": "ISC" + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stackback": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", + "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", + "dev": true, + "license": "MIT" + }, + "node_modules/std-env": { + "version": "3.10.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", + "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "dev": true, + "license": "MIT" + }, + "node_modules/stop-iteration-iterator": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz", + "integrity": "sha512-eLoXW/DHyl62zxY4SCaIgnRhuMr6ri4juEYARS8E6sCEqzKpOiE521Ucofdx+KnDZl5xmvGYaaKCk5FEOxJCoQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "internal-slot": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/strip-literal": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz", + "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "js-tokens": "^9.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/antfu" + } + }, + "node_modules/strip-literal/node_modules/js-tokens": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", + "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/tinybench": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", + "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyexec": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", + "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyglobby": { + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "fdir": "^6.5.0", + "picomatch": "^4.0.3" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/tinypool": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", + "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18.0.0 || >=20.0.0" + } + }, + "node_modules/tinyrainbow": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", + "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/tinyspy": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-4.0.4.tgz", + "integrity": "sha512-azl+t0z7pw/z958Gy9svOTuzqIk6xq+NSheJzn5MMWtWTFywIacg2wUlzKFGtt3cthx0r2SxMK0yzJOR0IES7Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/vite": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.1.tgz", + "integrity": "sha512-w+N7Hifpc3gRjZ63vYBXA56dvvRlNWRczTdmCBBa+CotUzAPf5b7YMdMR/8CQoeYE5LX3W4wj6RYTgonm1b9DA==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.27.0", + "fdir": "^6.5.0", + "picomatch": "^4.0.3", + "postcss": "^8.5.6", + "rollup": "^4.43.0", + "tinyglobby": "^0.2.15" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^20.19.0 || >=22.12.0", + "jiti": ">=1.21.0", + "less": "^4.0.0", + "lightningcss": "^1.21.0", + "sass": "^1.70.0", + "sass-embedded": "^1.70.0", + "stylus": ">=0.54.8", + "sugarss": "^5.0.0", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vite-node": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.2.4.tgz", + "integrity": "sha512-EbKSKh+bh1E1IFxeO0pg1n4dvoOTt0UDiXMd/qn++r98+jPO1xtJilvXldeuQ8giIB5IkpjCgMleHMNEsGH6pg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cac": "^6.7.14", + "debug": "^4.4.1", + "es-module-lexer": "^1.7.0", + "pathe": "^2.0.3", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "bin": { + "vite-node": "vite-node.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/vitest": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", + "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/expect": "3.2.4", + "@vitest/mocker": "3.2.4", + "@vitest/pretty-format": "^3.2.4", + "@vitest/runner": "3.2.4", + "@vitest/snapshot": "3.2.4", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "debug": "^4.4.1", + "expect-type": "^1.2.1", + "magic-string": "^0.30.17", + "pathe": "^2.0.3", + "picomatch": "^4.0.2", + "std-env": "^3.9.0", + "tinybench": "^2.9.0", + "tinyexec": "^0.3.2", + "tinyglobby": "^0.2.14", + "tinypool": "^1.1.1", + "tinyrainbow": "^2.0.0", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0", + "vite-node": "3.2.4", + "why-is-node-running": "^2.3.0" + }, + "bin": { + "vitest": "vitest.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@edge-runtime/vm": "*", + "@types/debug": "^4.1.12", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@vitest/browser": "3.2.4", + "@vitest/ui": "3.2.4", + "happy-dom": "*", + "jsdom": "*" + }, + "peerDependenciesMeta": { + "@edge-runtime/vm": { + "optional": true + }, + "@types/debug": { + "optional": true + }, + "@types/node": { + "optional": true + }, + "@vitest/browser": { + "optional": true + }, + "@vitest/ui": { + "optional": true + }, + "happy-dom": { + "optional": true + }, + "jsdom": { + "optional": true + } + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.1.1.tgz", + "integrity": "sha512-TbX3mj8n0odCBFVlY8AxkqcHASw3L60jIuF8jFP78az3C2YhmGvqbHBpAjTRH2/xqYunrJ9g1jSyjCjpoWzIAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-bigint": "^1.1.0", + "is-boolean-object": "^1.2.1", + "is-number-object": "^1.1.1", + "is-string": "^1.1.1", + "is-symbol": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-collection": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", + "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-map": "^2.0.3", + "is-set": "^2.0.3", + "is-weakmap": "^2.0.2", + "is-weakset": "^2.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-typed-array": { + "version": "1.1.20", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.20.tgz", + "integrity": "sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", + "for-each": "^0.3.5", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/why-is-node-running": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", + "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", + "dev": true, + "license": "MIT", + "dependencies": { + "siginfo": "^2.0.0", + "stackback": "0.0.2" + }, + "bin": { + "why-is-node-running": "cli.js" + }, + "engines": { + "node": ">=8" + } + } + } +} diff --git a/examples/testing/admin-testing-example/package.json b/examples/testing/admin-testing-example/package.json new file mode 100644 index 0000000000..4a7be8e76f --- /dev/null +++ b/examples/testing/admin-testing-example/package.json @@ -0,0 +1,29 @@ +{ + "name": "admin-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "scripts": { + "shopify": "shopify", + "build": "shopify app build", + "dev": "shopify app dev", + "info": "shopify app info", + "generate": "shopify app generate", + "deploy": "shopify app deploy", + "test": "vitest run", + "typecheck": "tsc --noEmit --project extensions/admin-testing-example/tsconfig.json" + }, + "dependencies": { + "@shopify/ui-extensions": "file:../../../packages/ui-extensions" + }, + "devDependencies": { + "@shopify/ui-extensions-tester": "file:../../../packages/ui-extensions-tester", + "@testing-library/preact": "^3.2.0", + "typescript": "^5.0.0", + "vitest": "^3.0.0" + }, + "trustedDependencies": [ + "@shopify/plugin-cloudflare" + ], + "author": "kumar", + "private": true +} diff --git a/examples/testing/admin-testing-example/shopify.app.toml b/examples/testing/admin-testing-example/shopify.app.toml new file mode 100644 index 0000000000..b10064c1dd --- /dev/null +++ b/examples/testing/admin-testing-example/shopify.app.toml @@ -0,0 +1,19 @@ +# Learn more about configuring your app at https://shopify.dev/docs/apps/tools/cli/configuration + +name = "admin-testing-example" +application_url = "https://shopify.dev/apps/default-app-home" +embedded = true + +[build] +automatically_update_urls_on_dev = true +include_config_on_deploy = true + +[webhooks] +api_version = "2026-04" + +[access_scopes] +# Learn more at https://shopify.dev/docs/apps/tools/cli/configuration#access_scopes +scopes = "" + +[auth] +redirect_urls = [ "https://shopify.dev/apps/default-app-home/api/auth" ] diff --git a/examples/testing/admin-testing-example/vitest.config.ts b/examples/testing/admin-testing-example/vitest.config.ts new file mode 100644 index 0000000000..68e3ffd6d8 --- /dev/null +++ b/examples/testing/admin-testing-example/vitest.config.ts @@ -0,0 +1,11 @@ +import {defineConfig} from 'vitest/config'; + +export default defineConfig({ + esbuild: { + jsx: 'automatic', + jsxImportSource: 'preact', + }, + test: { + environment: 'jsdom', + }, +}); diff --git a/examples/testing/checkout-basic-testing-example/.gitignore b/examples/testing/checkout-basic-testing-example/.gitignore new file mode 100644 index 0000000000..43a02ea149 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/.gitignore @@ -0,0 +1,29 @@ +# Environment Configuration +.env +.env.* + +# Dependency directory +node_modules + +# Test coverage directory +coverage + +# Ignore Apple macOS Desktop Services Store +.DS_Store + +# Logs +logs +*.log + +# extensions build output +extensions/*/build +extensions/*/dist + +# lock files + + + + +# Ignore shopify files created during app dev +.shopify/* +.shopify.lock \ No newline at end of file diff --git a/examples/testing/checkout-basic-testing-example/.graphqlrc.js b/examples/testing/checkout-basic-testing-example/.graphqlrc.js new file mode 100644 index 0000000000..b58eae185c --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/.graphqlrc.js @@ -0,0 +1,30 @@ +const fs = require("node:fs"); + +function getConfig() { + const config = { + projects: {}, + }; + + let extensions = []; + try { + extensions = fs.readdirSync("./extensions"); + } catch { + // ignore if no extensions + } + + for (const entry of extensions) { + const extensionPath = `./extensions/${entry}`; + const schema = `${extensionPath}/schema.graphql`; + if (!fs.existsSync(schema)) { + continue; + } + config.projects[entry] = { + schema, + documents: [`${extensionPath}/**/*.graphql`], + }; + } + + return config; +} + +module.exports = getConfig(); diff --git a/examples/testing/checkout-basic-testing-example/README.md b/examples/testing/checkout-basic-testing-example/README.md new file mode 100644 index 0000000000..312c3238d2 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/README.md @@ -0,0 +1,24 @@ +This extension was created with: + +``` +shopify app init --name checkout-basic-testing-example +cd checkout-basic-testing-example +shopify app generate extension +# I chose 'Checkout UI' +``` + +See it in action: + +Build the root package: + +``` +yarn build +``` + +Change into this example package and run: + +``` +npm install +npm run typecheck +npm test +``` diff --git a/examples/testing/checkout-basic-testing-example/extensions/.gitkeep b/examples/testing/checkout-basic-testing-example/extensions/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/README.md b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/README.md new file mode 100644 index 0000000000..a4eebe612f --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/README.md @@ -0,0 +1 @@ +Instructions are in [app's README](../../) diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/locales/en.default.json b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/locales/en.default.json new file mode 100644 index 0000000000..7cf280ba87 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/locales/en.default.json @@ -0,0 +1,6 @@ +{ + "welcome": "Welcome to the {{target}} extension!", + "iWouldLikeAFreeGiftWithMyOrder": "I would like to receive a free gift with my order", + "addAFreeGiftToMyOrder": "Add a free gift to my order", + "attributeChangesAreNotSupported": "Attribute changes are not supported in this checkout" +} diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/locales/fr.json b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/locales/fr.json new file mode 100644 index 0000000000..95da7867e2 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/locales/fr.json @@ -0,0 +1,6 @@ +{ + "welcome": "Bienvenue dans l'extension {{target}}!", + "iWouldLikeAFreeGiftWithMyOrder": "Je souhaite recevoir un cadeau gratuit avec ma commande", + "addAFreeGiftToMyOrder": "Ajouter un cadeau gratuit à ma commande", + "attributeChangesAreNotSupported": "Les modifications d'attribut ne sont pas prises en charge dans cette commande" +} diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/package-lock.json b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/package-lock.json new file mode 100644 index 0000000000..94df13c99f --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/package-lock.json @@ -0,0 +1,363 @@ +{ + "name": "checkout-basic-testing-example", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "checkout-basic-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "@preact/signals": "^2.3.x", + "@shopify/ui-extensions": "2026.1.x", + "preact": "^10.10.x" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@preact/signals": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/@preact/signals/-/signals-2.8.0.tgz", + "integrity": "sha512-lcILM82mei8s/53n2M6uZlrDHLlgLld8Squ0PVSUL5Ae1M45uEstWfHm+wcDqp2U5I/ZYrBvCY65udFyTo5OZw==", + "license": "MIT", + "dependencies": { + "@preact/signals-core": "^1.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + }, + "peerDependencies": { + "preact": ">= 10.25.0 || >=11.0.0-0" + } + }, + "node_modules/@preact/signals-core": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/@preact/signals-core/-/signals-core-1.13.0.tgz", + "integrity": "sha512-slT6XeTCAbdql61GVLlGU4x7XHI7kCZV5Um5uhE4zLX4ApgiiXc0UYFvVOKq06xcovzp7p+61l68oPi563ARKg==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/@shopify/ui-extensions": { + "version": "2026.1.1", + "resolved": "https://npm.shopify.io/node/@shopify/ui-extensions/-/ui-extensions-2026.1.1.tgz", + "integrity": "sha512-QjyU/PsbmEM0f/UmPA0MVwPjMy4tZxecBtoh7YqZk0D3RrAK9fw5FTn+yDVw6YOIcH97/Wk5zJCUuXVCJ85C1A==", + "license": "MIT", + "dependencies": { + "ts-morph": "^25.0.1" + }, + "peerDependencies": { + "@preact/signals": "*", + "preact": "*" + }, + "peerDependenciesMeta": { + "@preact/signals": { + "optional": true + }, + "preact": { + "optional": true + } + } + }, + "node_modules/@ts-morph/common": { + "version": "0.26.1", + "resolved": "https://registry.npmjs.org/@ts-morph/common/-/common-0.26.1.tgz", + "integrity": "sha512-Sn28TGl/4cFpcM+jwsH1wLncYq3FtN/BIpem+HOygfBWPT5pAeS5dB4VFVzV8FbnOKHpDLZmvAl4AjPEev5idA==", + "license": "MIT", + "dependencies": { + "fast-glob": "^3.3.2", + "minimatch": "^9.0.4", + "path-browserify": "^1.0.1" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" + }, + "node_modules/brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/code-block-writer": { + "version": "13.0.3", + "resolved": "https://registry.npmjs.org/code-block-writer/-/code-block-writer-13.0.3.tgz", + "integrity": "sha512-Oofo0pq3IKnsFtuHqSF7TqBfr71aeyZDVJ0HpmqB7FBM2qEigL0iPONSCZSO9pE9dZTAxANe5XHG9Uy0YMv8cg==", + "license": "MIT" + }, + "node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fastq": { + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/path-browserify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz", + "integrity": "sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==", + "license": "MIT" + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/preact": { + "version": "10.28.3", + "resolved": "https://registry.npmjs.org/preact/-/preact-10.28.3.tgz", + "integrity": "sha512-tCmoRkPQLpBeWzpmbhryairGnhW9tKV6c6gr/w+RhoRoKEJwsjzipwp//1oCpGPOchvSLaAPlpcJi9MwMmoPyA==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/reusify": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", + "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/ts-morph": { + "version": "25.0.1", + "resolved": "https://registry.npmjs.org/ts-morph/-/ts-morph-25.0.1.tgz", + "integrity": "sha512-QJEiTdnz1YjrB3JFhd626gX4rKHDLSjSVMvGGG4v7ONc3RBwa0Eei98G9AT9uNFDMtV54JyuXsFeC+OH0n6bXQ==", + "license": "MIT", + "dependencies": { + "@ts-morph/common": "~0.26.0", + "code-block-writer": "^13.0.3" + } + } + } +} diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/package.json b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/package.json new file mode 100644 index 0000000000..f37be01d84 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/package.json @@ -0,0 +1,11 @@ +{ + "name": "checkout-basic-testing-example", + "private": true, + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "preact": "^10.10.x", + "@preact/signals": "^2.3.x", + "@shopify/ui-extensions": "2026.4.x" + } +} diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/shopify.d.ts b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/shopify.d.ts new file mode 100644 index 0000000000..c3cf46770f --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/shopify.d.ts @@ -0,0 +1,7 @@ +import '@shopify/ui-extensions'; + +//@ts-ignore +declare module './src/Checkout.jsx' { + const shopify: import('@shopify/ui-extensions/purchase.checkout.block.render').Api; + const globalThis: { shopify: typeof shopify }; +} diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/shopify.extension.toml b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/shopify.extension.toml new file mode 100644 index 0000000000..4067f051ca --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/shopify.extension.toml @@ -0,0 +1,52 @@ +# Learn more about configuring your checkout UI extension: +# https://shopify.dev/docs/api/checkout-ui-extensions/latest/configuration + +# The version of APIs your extension will receive. Learn more: +# https://shopify.dev/docs/api/usage/versioning +api_version = "2026-07" + +[[extensions]] +name = "checkout-basic-testing-example" +handle = "checkout-basic-testing-example" +type = "ui_extension" +uid = "4aeff854-b3f4-8d93-1398-b0fa7256818fc0502641" + +# Controls where in Shopify your extension will be injected, +# and the file that contains your extension’s source code. Learn more: +# https://shopify.dev/docs/api/checkout-ui-extensions/latest/extension-targets-overview + +[[extensions.targeting]] +module = "./src/Checkout.jsx" +target = "purchase.checkout.block.render" + +[extensions.capabilities] +# Gives your extension access to directly query Shopify’s storefront API. +# https://shopify.dev/docs/api/checkout-ui-extensions/latest/configuration#api-access +api_access = true + +# Gives your extension access to make external network calls, using the +# JavaScript `fetch()` API. Learn more: +# https://shopify.dev/docs/api/checkout-ui-extensions/latest/configuration#network-access +network_access = true + +# Loads metafields on checkout resources, including the cart, +# products, customers, and more. Learn more: +# https://shopify.dev/docs/api/checkout-ui-extensions/latest/configuration#metafields + +# [[extensions.metafields]] +# namespace = "my_namespace" +# key = "my_key" +# [[extensions.metafields]] +# namespace = "my_namespace" +# key = "my_other_key" + +# Defines settings that will be collected from merchants installing +# your extension. Learn more: +# https://shopify.dev/docs/api/checkout-ui-extensions/latest/configuration#settings-definition + +# [extensions.settings] +# [[extensions.settings.fields]] +# key = "banner_title" +# type = "single_line_text_field" +# name = "Banner title" +# description = "Enter a title for the banner" diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/src/Checkout.jsx b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/src/Checkout.jsx new file mode 100644 index 0000000000..6d1035ad9e --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/src/Checkout.jsx @@ -0,0 +1,53 @@ +import '@shopify/ui-extensions/preact'; +import {render} from 'preact'; +import {useRef, useState} from 'preact/hooks'; + +export default async () => { + render(, document.body); +}; + +function Extension() { + const dateRef = useRef(/** @type {any} */ (null)); + const [result, setResult] = useState(/** @type {any} */ (null)); + const [greeting, setGreeting] = useState(/** @type {string|null} */ (null)); + + const existingEntry = shopify.appMetafields.value.find( + (entry) => + entry.target.type === 'cart' && entry.metafield.key === 'user-birth-date', + ); + + async function handleClick() { + const value = dateRef.current?.value ?? ''; + const result = await shopify.applyMetafieldChange({ + type: 'updateCartMetafield', + metafield: { + key: 'user-birth-date', + value, + type: 'date', + }, + }); + setResult(result); + } + + async function handleFetchGreeting() { + const response = await fetch('https://httpbin.org/get?message=Hello!'); + const data = await response.json(); + setGreeting(data.args.message); + } + + return ( + <> + + Enter + {result?.type === 'success' && ( + Saved successfully + )} + Fetch greeting + {greeting && {greeting}} + + ); +} diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/tests/Checkout.test.ts b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/tests/Checkout.test.ts new file mode 100644 index 0000000000..6195ca5ebf --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/tests/Checkout.test.ts @@ -0,0 +1,96 @@ +/// +// ^ This defines types for custom Shopify elements supported by the target. + +import {expect, test, vi, beforeEach, afterEach} from 'vitest'; +import {fireEvent, waitFor} from '@testing-library/preact'; +import {getExtension} from '@shopify/ui-extensions-tester'; +import {createResult} from '@shopify/ui-extensions-tester/checkout'; + +const extension = getExtension('purchase.checkout.block.render'); + +beforeEach(() => { + extension.setUp(); +}); + +afterEach(() => { + extension.tearDown(); +}); + +test('shows the existing birth date from appMetafields', async () => { + extension.shopify.appMetafields.value = [ + { + target: {type: 'cart', id: '1'}, + metafield: { + key: 'user-birth-date', + namespace: '$app', + value: '2000-01-15', + valueType: 'string', + type: 'date', + }, + }, + ]; + + await extension.render(); + + const dateField = document.body.querySelector('s-date-field')!; + expect(dateField.getAttribute('value')).toEqual('2000-01-15'); +}); + +test('calls applyMetafieldChange with the entered date when clicking Enter', async () => { + const applyMetafieldChange = vi + .fn() + .mockResolvedValue(createResult('applyMetafieldChange', {type: 'success'})); + extension.shopify.applyMetafieldChange = applyMetafieldChange; + + await extension.render(); + + const dateField = document.body.querySelector('s-date-field')!; + dateField.value = '1990-05-20'; + dateField.dispatchEvent(new Event('change')); + + const button = document.body.querySelector('s-button')!; + fireEvent.click(button); + + await waitFor(() => { + expect(applyMetafieldChange).toHaveBeenCalledWith({ + type: 'updateCartMetafield', + metafield: { + key: 'user-birth-date', + value: '1990-05-20', + type: 'date', + }, + }); + }); + + await waitFor(() => { + const banner = document.body.querySelector('s-banner')!; + expect(banner.textContent).toEqual('Saved successfully'); + }); +}); + +test('fetches a greeting and displays it', async () => { + extension.fetch = vi + .fn() + .mockResolvedValue( + new Response(JSON.stringify({args: {message: 'Hello!'}})), + ); + + await extension.render(); + + const buttons = Array.from(document.body.querySelectorAll('s-button')); + const fetchButton = buttons.find( + (btn) => btn.textContent === 'Fetch greeting', + )!; + fireEvent.click(fetchButton); + + await waitFor(() => { + expect(extension.fetch).toHaveBeenCalledWith( + 'https://httpbin.org/get?message=Hello!', + ); + }); + + await waitFor(() => { + const greeting = document.body.querySelector('#greeting')!; + expect(greeting.textContent).toEqual('Hello!'); + }); +}); diff --git a/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/tsconfig.json b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/tsconfig.json new file mode 100644 index 0000000000..1861d4dd36 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "jsx": "react-jsx", + "jsxImportSource": "preact", + "target": "ES2020", + "checkJs": true, + "allowJs": true, + "module": "esnext", + "moduleResolution": "bundler", + "esModuleInterop": true, + "strict": true, + "skipLibCheck": true, + "baseUrl": ".", + "paths": { + "preact": ["../../node_modules/preact"], + "preact/*": ["../../node_modules/preact/*"] + } + }, + "include": ["./src", "./tests", "./shopify.d.ts"] +} diff --git a/examples/testing/checkout-basic-testing-example/package-lock.json b/examples/testing/checkout-basic-testing-example/package-lock.json new file mode 100644 index 0000000000..51117b7b2a --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/package-lock.json @@ -0,0 +1,2853 @@ +{ + "name": "checkout-basic-testing-example", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "checkout-basic-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "@shopify/ui-extensions": "file:../../../packages/ui-extensions" + }, + "devDependencies": { + "@shopify/ui-extensions-tester": "file:../../../packages/ui-extensions-tester", + "@testing-library/preact": "^3.2.0", + "typescript": "^5.0.0", + "vitest": "^3.0.0" + } + }, + "../../../packages/ui-extensions": { + "name": "@shopify/ui-extensions", + "version": "2026.4.0-rc.2", + "license": "MIT", + "dependencies": { + "ts-morph": "^25.0.1" + }, + "devDependencies": { + "@faker-js/faker": "^8.4.1", + "@preact/signals": "^2.3.x", + "@quilted/react-testing": "^0.6.11", + "@remote-ui/async-subscription": "^2.1.16", + "@shopify/generate-docs": "https://registry.npmjs.org/@shopify/generate-docs/-/generate-docs-0.19.8.tgz", + "preact": "^10.10.x", + "typescript": "^4.9.0" + }, + "peerDependencies": { + "@preact/signals": "*", + "preact": "*" + }, + "peerDependenciesMeta": { + "@preact/signals": { + "optional": true + }, + "preact": { + "optional": true + } + } + }, + "../../../packages/ui-extensions-tester": { + "name": "@shopify/ui-extensions-tester", + "version": "2026.4.0-rc.2", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/ui-extensions": "2026.4.0-rc.2" + }, + "devDependencies": { + "typescript": "^4.9.0" + }, + "peerDependencies": { + "preact": "^10.0.0" + }, + "peerDependenciesMeta": { + "preact": { + "optional": true + } + } + }, + "node_modules/@babel/code-frame": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.28.5", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/code-frame/node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/runtime": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.28.6.tgz", + "integrity": "sha512-05WQkdpL9COIMz4LjTxGpPNCdlpyimKppYNoJ5Di5EUObifl8t4tuLuUBBZEpoLYOmfvIWrsp9fCl0HoPRVTdA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.3.tgz", + "integrity": "sha512-9fJMTNFTWZMh5qwrBItuziu834eOCUcEqymSH7pY+zoMVEZg3gcPuBNxH1EvfVYe9h0x/Ptw8KBzv7qxb7l8dg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.3.tgz", + "integrity": "sha512-i5D1hPY7GIQmXlXhs2w8AWHhenb00+GxjxRncS2ZM7YNVGNfaMxgzSGuO8o8SJzRc/oZwU2bcScvVERk03QhzA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.3.tgz", + "integrity": "sha512-YdghPYUmj/FX2SYKJ0OZxf+iaKgMsKHVPF1MAq/P8WirnSpCStzKJFjOjzsW0QQ7oIAiccHdcqjbHmJxRb/dmg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.3.tgz", + "integrity": "sha512-IN/0BNTkHtk8lkOM8JWAYFg4ORxBkZQf9zXiEOfERX/CzxW3Vg1ewAhU7QSWQpVIzTW+b8Xy+lGzdYXV6UZObQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.3.tgz", + "integrity": "sha512-Re491k7ByTVRy0t3EKWajdLIr0gz2kKKfzafkth4Q8A5n1xTHrkqZgLLjFEHVD+AXdUGgQMq+Godfq45mGpCKg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.3.tgz", + "integrity": "sha512-vHk/hA7/1AckjGzRqi6wbo+jaShzRowYip6rt6q7VYEDX4LEy1pZfDpdxCBnGtl+A5zq8iXDcyuxwtv3hNtHFg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.3.tgz", + "integrity": "sha512-ipTYM2fjt3kQAYOvo6vcxJx3nBYAzPjgTCk7QEgZG8AUO3ydUhvelmhrbOheMnGOlaSFUoHXB6un+A7q4ygY9w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.3.tgz", + "integrity": "sha512-dDk0X87T7mI6U3K9VjWtHOXqwAMJBNN2r7bejDsc+j03SEjtD9HrOl8gVFByeM0aJksoUuUVU9TBaZa2rgj0oA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.3.tgz", + "integrity": "sha512-s6nPv2QkSupJwLYyfS+gwdirm0ukyTFNl3KTgZEAiJDd+iHZcbTPPcWCcRYH+WlNbwChgH2QkE9NSlNrMT8Gfw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.3.tgz", + "integrity": "sha512-sZOuFz/xWnZ4KH3YfFrKCf1WyPZHakVzTiqji3WDc0BCl2kBwiJLCXpzLzUBLgmp4veFZdvN5ChW4Eq/8Fc2Fg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.3.tgz", + "integrity": "sha512-yGlQYjdxtLdh0a3jHjuwOrxQjOZYD/C9PfdbgJJF3TIZWnm/tMd/RcNiLngiu4iwcBAOezdnSLAwQDPqTmtTYg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.3.tgz", + "integrity": "sha512-WO60Sn8ly3gtzhyjATDgieJNet/KqsDlX5nRC5Y3oTFcS1l0KWba+SEa9Ja1GfDqSF1z6hif/SkpQJbL63cgOA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.3.tgz", + "integrity": "sha512-APsymYA6sGcZ4pD6k+UxbDjOFSvPWyZhjaiPyl/f79xKxwTnrn5QUnXR5prvetuaSMsb4jgeHewIDCIWljrSxw==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.3.tgz", + "integrity": "sha512-eizBnTeBefojtDb9nSh4vvVQ3V9Qf9Df01PfawPcRzJH4gFSgrObw+LveUyDoKU3kxi5+9RJTCWlj4FjYXVPEA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.3.tgz", + "integrity": "sha512-3Emwh0r5wmfm3ssTWRQSyVhbOHvqegUDRd0WhmXKX2mkHJe1SFCMJhagUleMq+Uci34wLSipf8Lagt4LlpRFWQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.3.tgz", + "integrity": "sha512-pBHUx9LzXWBc7MFIEEL0yD/ZVtNgLytvx60gES28GcWMqil8ElCYR4kvbV2BDqsHOvVDRrOxGySBM9Fcv744hw==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.3.tgz", + "integrity": "sha512-Czi8yzXUWIQYAtL/2y6vogER8pvcsOsk5cpwL4Gk5nJqH5UZiVByIY8Eorm5R13gq+DQKYg0+JyQoytLQas4dA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.3.tgz", + "integrity": "sha512-sDpk0RgmTCR/5HguIZa9n9u+HVKf40fbEUt+iTzSnCaGvY9kFP0YKBWZtJaraonFnqef5SlJ8/TiPAxzyS+UoA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.3.tgz", + "integrity": "sha512-P14lFKJl/DdaE00LItAukUdZO5iqNH7+PjoBm+fLQjtxfcfFE20Xf5CrLsmZdq5LFFZzb5JMZ9grUwvtVYzjiA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.3.tgz", + "integrity": "sha512-AIcMP77AvirGbRl/UZFTq5hjXK+2wC7qFRGoHSDrZ5v5b8DK/GYpXW3CPRL53NkvDqb9D+alBiC/dV0Fb7eJcw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.3.tgz", + "integrity": "sha512-DnW2sRrBzA+YnE70LKqnM3P+z8vehfJWHXECbwBmH/CU51z6FiqTQTHFenPlHmo3a8UgpLyH3PT+87OViOh1AQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.3.tgz", + "integrity": "sha512-NinAEgr/etERPTsZJ7aEZQvvg/A6IsZG/LgZy+81wON2huV7SrK3e63dU0XhyZP4RKGyTm7aOgmQk0bGp0fy2g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.3.tgz", + "integrity": "sha512-PanZ+nEz+eWoBJ8/f8HKxTTD172SKwdXebZ0ndd953gt1HRBbhMsaNqjTyYLGLPdoWHy4zLU7bDVJztF5f3BHA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.3.tgz", + "integrity": "sha512-B2t59lWWYrbRDw/tjiWOuzSsFh1Y/E95ofKz7rIVYSQkUYBjfSgf6oeYPNWHToFRr2zx52JKApIcAS/D5TUBnA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.3.tgz", + "integrity": "sha512-QLKSFeXNS8+tHW7tZpMtjlNb7HKau0QDpwm49u0vUp9y1WOF+PEzkU84y9GqYaAVW8aH8f3GcBck26jh54cX4Q==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.3.tgz", + "integrity": "sha512-4uJGhsxuptu3OcpVAzli+/gWusVGwZZHTlS63hh++ehExkVT8SgiEf7/uC/PclrPPkLhZqGgCTjd0VWLo6xMqA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "dev": true, + "license": "MIT" + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.57.1.tgz", + "integrity": "sha512-A6ehUVSiSaaliTxai040ZpZ2zTevHYbvu/lDoeAteHI8QnaosIzm4qwtezfRg1jOYaUmnzLX1AOD6Z+UJjtifg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.57.1.tgz", + "integrity": "sha512-dQaAddCY9YgkFHZcFNS/606Exo8vcLHwArFZ7vxXq4rigo2bb494/xKMMwRRQW6ug7Js6yXmBZhSBRuBvCCQ3w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.57.1.tgz", + "integrity": "sha512-crNPrwJOrRxagUYeMn/DZwqN88SDmwaJ8Cvi/TN1HnWBU7GwknckyosC2gd0IqYRsHDEnXf328o9/HC6OkPgOg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.57.1.tgz", + "integrity": "sha512-Ji8g8ChVbKrhFtig5QBV7iMaJrGtpHelkB3lsaKzadFBe58gmjfGXAOfI5FV0lYMH8wiqsxKQ1C9B0YTRXVy4w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.57.1.tgz", + "integrity": "sha512-R+/WwhsjmwodAcz65guCGFRkMb4gKWTcIeLy60JJQbXrJ97BOXHxnkPFrP+YwFlaS0m+uWJTstrUA9o+UchFug==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.57.1.tgz", + "integrity": "sha512-IEQTCHeiTOnAUC3IDQdzRAGj3jOAYNr9kBguI7MQAAZK3caezRrg0GxAb6Hchg4lxdZEI5Oq3iov/w/hnFWY9Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.57.1.tgz", + "integrity": "sha512-F8sWbhZ7tyuEfsmOxwc2giKDQzN3+kuBLPwwZGyVkLlKGdV1nvnNwYD0fKQ8+XS6hp9nY7B+ZeK01EBUE7aHaw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.57.1.tgz", + "integrity": "sha512-rGfNUfn0GIeXtBP1wL5MnzSj98+PZe/AXaGBCRmT0ts80lU5CATYGxXukeTX39XBKsxzFpEeK+Mrp9faXOlmrw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.57.1.tgz", + "integrity": "sha512-MMtej3YHWeg/0klK2Qodf3yrNzz6CGjo2UntLvk2RSPlhzgLvYEB3frRvbEF2wRKh1Z2fDIg9KRPe1fawv7C+g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.57.1.tgz", + "integrity": "sha512-1a/qhaaOXhqXGpMFMET9VqwZakkljWHLmZOX48R0I/YLbhdxr1m4gtG1Hq7++VhVUmf+L3sTAf9op4JlhQ5u1Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.57.1.tgz", + "integrity": "sha512-QWO6RQTZ/cqYtJMtxhkRkidoNGXc7ERPbZN7dVW5SdURuLeVU7lwKMpo18XdcmpWYd0qsP1bwKPf7DNSUinhvA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.57.1.tgz", + "integrity": "sha512-xpObYIf+8gprgWaPP32xiN5RVTi/s5FCR+XMXSKmhfoJjrpRAjCuuqQXyxUa/eJTdAE6eJ+KDKaoEqjZQxh3Gw==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.57.1.tgz", + "integrity": "sha512-4BrCgrpZo4hvzMDKRqEaW1zeecScDCR+2nZ86ATLhAoJ5FQ+lbHVD3ttKe74/c7tNT9c6F2viwB3ufwp01Oh2w==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.57.1.tgz", + "integrity": "sha512-NOlUuzesGauESAyEYFSe3QTUguL+lvrN1HtwEEsU2rOwdUDeTMJdO5dUYl/2hKf9jWydJrO9OL/XSSf65R5+Xw==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.57.1.tgz", + "integrity": "sha512-ptA88htVp0AwUUqhVghwDIKlvJMD/fmL/wrQj99PRHFRAG6Z5nbWoWG4o81Nt9FT+IuqUQi+L31ZKAFeJ5Is+A==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.57.1.tgz", + "integrity": "sha512-S51t7aMMTNdmAMPpBg7OOsTdn4tySRQvklmL3RpDRyknk87+Sp3xaumlatU+ppQ+5raY7sSTcC2beGgvhENfuw==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.57.1.tgz", + "integrity": "sha512-Bl00OFnVFkL82FHbEqy3k5CUCKH6OEJL54KCyx2oqsmZnFTR8IoNqBF+mjQVcRCT5sB6yOvK8A37LNm/kPJiZg==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.57.1.tgz", + "integrity": "sha512-ABca4ceT4N+Tv/GtotnWAeXZUZuM/9AQyCyKYyKnpk4yoA7QIAuBt6Hkgpw8kActYlew2mvckXkvx0FfoInnLg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.57.1.tgz", + "integrity": "sha512-HFps0JeGtuOR2convgRRkHCekD7j+gdAuXM+/i6kGzQtFhlCtQkpwtNzkNj6QhCDp7DRJ7+qC/1Vg2jt5iSOFw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.57.1.tgz", + "integrity": "sha512-H+hXEv9gdVQuDTgnqD+SQffoWoc0Of59AStSzTEj/feWTBAnSfSD3+Dql1ZruJQxmykT/JVY0dE8Ka7z0DH1hw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.57.1.tgz", + "integrity": "sha512-4wYoDpNg6o/oPximyc/NG+mYUejZrCU2q+2w6YZqrAs2UcNUChIZXjtafAiiZSUc7On8v5NyNj34Kzj/Ltk6dQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.57.1.tgz", + "integrity": "sha512-O54mtsV/6LW3P8qdTcamQmuC990HDfR71lo44oZMZlXU4tzLrbvTii87Ni9opq60ds0YzuAlEr/GNwuNluZyMQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.57.1.tgz", + "integrity": "sha512-P3dLS+IerxCT/7D2q2FYcRdWRl22dNbrbBEtxdWhXrfIMPP9lQhb5h4Du04mdl5Woq05jVCDPCMF7Ub0NAjIew==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.57.1.tgz", + "integrity": "sha512-VMBH2eOOaKGtIJYleXsi2B8CPVADrh+TyNxJ4mWPnKfLB/DBUmzW+5m1xUrcwWoMfSLagIRpjUFeW5CO5hyciQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.57.1.tgz", + "integrity": "sha512-mxRFDdHIWRxg3UfIIAwCm6NzvxG0jDX/wBN6KsQFTvKFqqg9vTrWUE68qEjHt19A5wwx5X5aUi2zuZT7YR0jrA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@shopify/ui-extensions": { + "resolved": "../../../packages/ui-extensions", + "link": true + }, + "node_modules/@shopify/ui-extensions-tester": { + "resolved": "../../../packages/ui-extensions-tester", + "link": true + }, + "node_modules/@testing-library/dom": { + "version": "8.20.1", + "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-8.20.1.tgz", + "integrity": "sha512-/DiOQ5xBxgdYRC8LNk7U+RWat0S3qRLeIw3ZIkMQ9kkVlRmwD/Eg8k8CqIpD6GW7u20JIUOfMKbxtiLutpjQ4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.10.4", + "@babel/runtime": "^7.12.5", + "@types/aria-query": "^5.0.1", + "aria-query": "5.1.3", + "chalk": "^4.1.0", + "dom-accessibility-api": "^0.5.9", + "lz-string": "^1.5.0", + "pretty-format": "^27.0.2" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@testing-library/preact": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@testing-library/preact/-/preact-3.2.4.tgz", + "integrity": "sha512-F+kJ243LP6VmEK1M809unzTE/ijg+bsMNuiRN0JEDIJBELKKDNhdgC/WrUSZ7klwJvtlO3wQZ9ix+jhObG07Fg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@testing-library/dom": "^8.11.1" + }, + "engines": { + "node": ">= 12" + }, + "peerDependencies": { + "preact": ">=10 || ^10.0.0-alpha.0 || ^10.0.0-beta.0" + } + }, + "node_modules/@types/aria-query": { + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", + "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/chai": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", + "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/deep-eql": "*", + "assertion-error": "^2.0.1" + } + }, + "node_modules/@types/deep-eql": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", + "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@vitest/expect": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", + "integrity": "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/mocker": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.2.4.tgz", + "integrity": "sha512-46ryTE9RZO/rfDd7pEqFl7etuyzekzEhUbTW3BvmeO/BcCMEgq59BKhek3dXDWgAj4oMK6OZi+vRr1wPW6qjEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "3.2.4", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.17" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "msw": "^2.4.9", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } + } + }, + "node_modules/@vitest/pretty-format": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.2.4.tgz", + "integrity": "sha512-IVNZik8IVRJRTr9fxlitMKeJeXFFFN0JaB9PHPGQ8NKQbGpfjlTx9zO4RefN8gp7eqjNy8nyK3NZmBzOPeIxtA==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/runner": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.2.4.tgz", + "integrity": "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/utils": "3.2.4", + "pathe": "^2.0.3", + "strip-literal": "^3.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/snapshot": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.2.4.tgz", + "integrity": "sha512-dEYtS7qQP2CjU27QBC5oUOxLE/v5eLkGqPE0ZKEIDGMs4vKWe7IjgLOeauHsR0D5YuuycGRO5oSRXnwnmA78fQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "magic-string": "^0.30.17", + "pathe": "^2.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/spy": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.2.4.tgz", + "integrity": "sha512-vAfasCOe6AIK70iP5UD11Ac4siNUNJ9i/9PZ3NKx07sG6sUxeag1LWdNrMWeKKYBLlzuK+Gn65Yd5nyL6ds+nw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyspy": "^4.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/utils": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.2.4.tgz", + "integrity": "sha512-fB2V0JFrQSMsCo9HiSq3Ezpdv4iYaXRG1Sx8edX3MwxfyNn83mKiGzOcH+Fkxt4MHxr3y42fQi1oeAInqgX2QA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "loupe": "^3.1.4", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/aria-query": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.1.3.tgz", + "integrity": "sha512-R5iJ5lkuHybztUfuOAznmboyjWq8O6sqNqtK7CLOqdydi54VNbORp49mb14KbWgG1QD3JFO9hJdZ+y4KutfdOQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "deep-equal": "^2.0.5" + } + }, + "node_modules/array-buffer-byte-length": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.2.tgz", + "integrity": "sha512-LHE+8BuR7RYGDKvnrmcuSq3tDcKv9OFEXQt/HpbZhY7V6h0zlUXutnAD82GiFx9rdieCMjkvtcsPqBwgUl1Iiw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "is-array-buffer": "^3.0.5" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/assertion-error": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", + "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/available-typed-arrays": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/cac": { + "version": "6.7.14", + "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", + "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/call-bind": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", + "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.0", + "es-define-property": "^1.0.0", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/chai": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz", + "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==", + "dev": true, + "license": "MIT", + "dependencies": { + "assertion-error": "^2.0.1", + "check-error": "^2.1.1", + "deep-eql": "^5.0.1", + "loupe": "^3.1.0", + "pathval": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/check-error": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz", + "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 16" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deep-eql": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", + "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/deep-equal": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-2.2.3.tgz", + "integrity": "sha512-ZIwpnevOurS8bpT4192sqAowWM76JDKSHYzMLty3BZGSswgq6pBaH3DhCSW5xVAZICZyKdOBPjwww5wfgT/6PA==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.0", + "call-bind": "^1.0.5", + "es-get-iterator": "^1.1.3", + "get-intrinsic": "^1.2.2", + "is-arguments": "^1.1.1", + "is-array-buffer": "^3.0.2", + "is-date-object": "^1.0.5", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.2", + "isarray": "^2.0.5", + "object-is": "^1.1.5", + "object-keys": "^1.1.1", + "object.assign": "^4.1.4", + "regexp.prototype.flags": "^1.5.1", + "side-channel": "^1.0.4", + "which-boxed-primitive": "^1.0.2", + "which-collection": "^1.0.1", + "which-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/dom-accessibility-api": { + "version": "0.5.16", + "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.5.16.tgz", + "integrity": "sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==", + "dev": true, + "license": "MIT" + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-get-iterator": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.3.tgz", + "integrity": "sha512-sPZmqHBe6JIiTfN5q2pEi//TwxmAFHwj/XEuYjTuse78i8KxaqMTTzxPoFKuzRpDpTJ+0NAbpfenkmH2rePtuw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.3", + "has-symbols": "^1.0.3", + "is-arguments": "^1.1.1", + "is-map": "^2.0.2", + "is-set": "^2.0.2", + "is-string": "^1.0.7", + "isarray": "^2.0.5", + "stop-iteration-iterator": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-module-lexer": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", + "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "dev": true, + "license": "MIT" + }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/esbuild": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.3.tgz", + "integrity": "sha512-8VwMnyGCONIs6cWue2IdpHxHnAjzxnw2Zr7MkVxB2vjmQ2ivqGFb4LEG3SMnv0Gb2F/G/2yA8zUaiL1gywDCCg==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.27.3", + "@esbuild/android-arm": "0.27.3", + "@esbuild/android-arm64": "0.27.3", + "@esbuild/android-x64": "0.27.3", + "@esbuild/darwin-arm64": "0.27.3", + "@esbuild/darwin-x64": "0.27.3", + "@esbuild/freebsd-arm64": "0.27.3", + "@esbuild/freebsd-x64": "0.27.3", + "@esbuild/linux-arm": "0.27.3", + "@esbuild/linux-arm64": "0.27.3", + "@esbuild/linux-ia32": "0.27.3", + "@esbuild/linux-loong64": "0.27.3", + "@esbuild/linux-mips64el": "0.27.3", + "@esbuild/linux-ppc64": "0.27.3", + "@esbuild/linux-riscv64": "0.27.3", + "@esbuild/linux-s390x": "0.27.3", + "@esbuild/linux-x64": "0.27.3", + "@esbuild/netbsd-arm64": "0.27.3", + "@esbuild/netbsd-x64": "0.27.3", + "@esbuild/openbsd-arm64": "0.27.3", + "@esbuild/openbsd-x64": "0.27.3", + "@esbuild/openharmony-arm64": "0.27.3", + "@esbuild/sunos-x64": "0.27.3", + "@esbuild/win32-arm64": "0.27.3", + "@esbuild/win32-ia32": "0.27.3", + "@esbuild/win32-x64": "0.27.3" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/expect-type": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", + "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/for-each": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.5.tgz", + "integrity": "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.2.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "dev": true, + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-bigints": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", + "integrity": "sha512-R3pbpkcIqv2Pm3dUwgjclDRVmWpTJW2DcMzcIhEXEx1oh/CEMObMm3KLmRJOdvhM7o4uQBnwr8pzRK2sJWIqfg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/internal-slot": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", + "integrity": "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "hasown": "^2.0.2", + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-arguments": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.2.0.tgz", + "integrity": "sha512-7bVbi0huj/wrIAOzb8U1aszg9kdi3KN/CyU19CTI7tAoZYEZoL9yCDXpbXN+uPsuWnP02cyug1gleqq+TU+YCA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-array-buffer": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.5.tgz", + "integrity": "sha512-DDfANUiiG2wC1qawP66qlTugJeL5HyzMpfr8lLK+jMQirGzNod0B12cFB/9q838Ru27sBwfw78/rdoU7RERz6A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-bigint": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.1.0.tgz", + "integrity": "sha512-n4ZT37wG78iz03xPRKJrHTdZbe3IicyucEtdRsV5yglwc3GyUfbAfpSeD0FJ41NbUNSt5wbhqfp1fS+BgnvDFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-bigints": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-boolean-object": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.2.2.tgz", + "integrity": "sha512-wa56o2/ElJMYqjCjGkXri7it5FbebW5usLw/nPmCMs5DeZ7eziSYZhSmPRn0txqeW4LnAmQQU7FgqLpsEFKM4A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-callable": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.1.0.tgz", + "integrity": "sha512-PwwhEakHVKTdRNVOw+/Gyh0+MzlCl4R6qKvkhuvLtPMggI1WAHt9sOwZxQLSGpUaDnrdyDsomoRgNnCfKNSXXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-map": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", + "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number-object": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.1.1.tgz", + "integrity": "sha512-lZhclumE1G6VYD8VHe35wFaIif+CTy5SJIi5+3y4psDgWu4wPDoBhF8NxUOinEc7pHgiTsT6MaBb92rKhhD+Xw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-regex": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.2.1.tgz", + "integrity": "sha512-MjYsKHO5O7mCsmRGxWcLWheFqN9DJ/2TmngvjKXihe6efViPqc274+Fx/4fYj/r03+ESvBdTXK0V6tA3rgez1g==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-set": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", + "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.4.tgz", + "integrity": "sha512-ISWac8drv4ZGfwKl5slpHG9OwPNty4jOWPRIhBpxOoD+hqITiwuipOQ2bNthAzwA3B4fIjO4Nln74N0S9byq8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-string": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.1.1.tgz", + "integrity": "sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.1.1.tgz", + "integrity": "sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-symbols": "^1.1.0", + "safe-regex-test": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakmap": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", + "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakset": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.4.tgz", + "integrity": "sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "license": "MIT" + }, + "node_modules/js-tokens": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", + "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/loupe": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz", + "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/lz-string": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", + "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", + "dev": true, + "license": "MIT", + "bin": { + "lz-string": "bin/bin.js" + } + }, + "node_modules/magic-string": { + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.5" + } + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true, + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/object-inspect": { + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-is": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", + "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", + "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0", + "has-symbols": "^1.1.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/pathe": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", + "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", + "dev": true, + "license": "MIT" + }, + "node_modules/pathval": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz", + "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 14.16" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/possible-typed-array-names": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", + "integrity": "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/postcss": { + "version": "8.5.6", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", + "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/preact": { + "version": "10.28.3", + "resolved": "https://registry.npmjs.org/preact/-/preact-10.28.3.tgz", + "integrity": "sha512-tCmoRkPQLpBeWzpmbhryairGnhW9tKV6c6gr/w+RhoRoKEJwsjzipwp//1oCpGPOchvSLaAPlpcJi9MwMmoPyA==", + "dev": true, + "license": "MIT", + "peer": true, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/pretty-format": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", + "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^17.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/pretty-format/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/react-is": { + "version": "17.0.2", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", + "dev": true, + "license": "MIT" + }, + "node_modules/regexp.prototype.flags": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", + "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "set-function-name": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/rollup": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.57.1.tgz", + "integrity": "sha512-oQL6lgK3e2QZeQ7gcgIkS2YZPg5slw37hYufJ3edKlfQSGGm8ICoxswK15ntSzF/a8+h7ekRy7k7oWc3BQ7y8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.57.1", + "@rollup/rollup-android-arm64": "4.57.1", + "@rollup/rollup-darwin-arm64": "4.57.1", + "@rollup/rollup-darwin-x64": "4.57.1", + "@rollup/rollup-freebsd-arm64": "4.57.1", + "@rollup/rollup-freebsd-x64": "4.57.1", + "@rollup/rollup-linux-arm-gnueabihf": "4.57.1", + "@rollup/rollup-linux-arm-musleabihf": "4.57.1", + "@rollup/rollup-linux-arm64-gnu": "4.57.1", + "@rollup/rollup-linux-arm64-musl": "4.57.1", + "@rollup/rollup-linux-loong64-gnu": "4.57.1", + "@rollup/rollup-linux-loong64-musl": "4.57.1", + "@rollup/rollup-linux-ppc64-gnu": "4.57.1", + "@rollup/rollup-linux-ppc64-musl": "4.57.1", + "@rollup/rollup-linux-riscv64-gnu": "4.57.1", + "@rollup/rollup-linux-riscv64-musl": "4.57.1", + "@rollup/rollup-linux-s390x-gnu": "4.57.1", + "@rollup/rollup-linux-x64-gnu": "4.57.1", + "@rollup/rollup-linux-x64-musl": "4.57.1", + "@rollup/rollup-openbsd-x64": "4.57.1", + "@rollup/rollup-openharmony-arm64": "4.57.1", + "@rollup/rollup-win32-arm64-msvc": "4.57.1", + "@rollup/rollup-win32-ia32-msvc": "4.57.1", + "@rollup/rollup-win32-x64-gnu": "4.57.1", + "@rollup/rollup-win32-x64-msvc": "4.57.1", + "fsevents": "~2.3.2" + } + }, + "node_modules/safe-regex-test": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.1.0.tgz", + "integrity": "sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "is-regex": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/side-channel": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", + "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/siginfo": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", + "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", + "dev": true, + "license": "ISC" + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stackback": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", + "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", + "dev": true, + "license": "MIT" + }, + "node_modules/std-env": { + "version": "3.10.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", + "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "dev": true, + "license": "MIT" + }, + "node_modules/stop-iteration-iterator": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz", + "integrity": "sha512-eLoXW/DHyl62zxY4SCaIgnRhuMr6ri4juEYARS8E6sCEqzKpOiE521Ucofdx+KnDZl5xmvGYaaKCk5FEOxJCoQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "internal-slot": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/strip-literal": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz", + "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "js-tokens": "^9.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/antfu" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/tinybench": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", + "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyexec": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", + "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyglobby": { + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "fdir": "^6.5.0", + "picomatch": "^4.0.3" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/tinypool": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", + "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18.0.0 || >=20.0.0" + } + }, + "node_modules/tinyrainbow": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", + "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/tinyspy": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-4.0.4.tgz", + "integrity": "sha512-azl+t0z7pw/z958Gy9svOTuzqIk6xq+NSheJzn5MMWtWTFywIacg2wUlzKFGtt3cthx0r2SxMK0yzJOR0IES7Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/vite": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.1.tgz", + "integrity": "sha512-w+N7Hifpc3gRjZ63vYBXA56dvvRlNWRczTdmCBBa+CotUzAPf5b7YMdMR/8CQoeYE5LX3W4wj6RYTgonm1b9DA==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.27.0", + "fdir": "^6.5.0", + "picomatch": "^4.0.3", + "postcss": "^8.5.6", + "rollup": "^4.43.0", + "tinyglobby": "^0.2.15" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^20.19.0 || >=22.12.0", + "jiti": ">=1.21.0", + "less": "^4.0.0", + "lightningcss": "^1.21.0", + "sass": "^1.70.0", + "sass-embedded": "^1.70.0", + "stylus": ">=0.54.8", + "sugarss": "^5.0.0", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vite-node": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.2.4.tgz", + "integrity": "sha512-EbKSKh+bh1E1IFxeO0pg1n4dvoOTt0UDiXMd/qn++r98+jPO1xtJilvXldeuQ8giIB5IkpjCgMleHMNEsGH6pg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cac": "^6.7.14", + "debug": "^4.4.1", + "es-module-lexer": "^1.7.0", + "pathe": "^2.0.3", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "bin": { + "vite-node": "vite-node.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/vitest": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", + "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/expect": "3.2.4", + "@vitest/mocker": "3.2.4", + "@vitest/pretty-format": "^3.2.4", + "@vitest/runner": "3.2.4", + "@vitest/snapshot": "3.2.4", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "debug": "^4.4.1", + "expect-type": "^1.2.1", + "magic-string": "^0.30.17", + "pathe": "^2.0.3", + "picomatch": "^4.0.2", + "std-env": "^3.9.0", + "tinybench": "^2.9.0", + "tinyexec": "^0.3.2", + "tinyglobby": "^0.2.14", + "tinypool": "^1.1.1", + "tinyrainbow": "^2.0.0", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0", + "vite-node": "3.2.4", + "why-is-node-running": "^2.3.0" + }, + "bin": { + "vitest": "vitest.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@edge-runtime/vm": "*", + "@types/debug": "^4.1.12", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@vitest/browser": "3.2.4", + "@vitest/ui": "3.2.4", + "happy-dom": "*", + "jsdom": "*" + }, + "peerDependenciesMeta": { + "@edge-runtime/vm": { + "optional": true + }, + "@types/debug": { + "optional": true + }, + "@types/node": { + "optional": true + }, + "@vitest/browser": { + "optional": true + }, + "@vitest/ui": { + "optional": true + }, + "happy-dom": { + "optional": true + }, + "jsdom": { + "optional": true + } + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.1.1.tgz", + "integrity": "sha512-TbX3mj8n0odCBFVlY8AxkqcHASw3L60jIuF8jFP78az3C2YhmGvqbHBpAjTRH2/xqYunrJ9g1jSyjCjpoWzIAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-bigint": "^1.1.0", + "is-boolean-object": "^1.2.1", + "is-number-object": "^1.1.1", + "is-string": "^1.1.1", + "is-symbol": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-collection": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", + "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-map": "^2.0.3", + "is-set": "^2.0.3", + "is-weakmap": "^2.0.2", + "is-weakset": "^2.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-typed-array": { + "version": "1.1.20", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.20.tgz", + "integrity": "sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", + "for-each": "^0.3.5", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/why-is-node-running": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", + "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", + "dev": true, + "license": "MIT", + "dependencies": { + "siginfo": "^2.0.0", + "stackback": "0.0.2" + }, + "bin": { + "why-is-node-running": "cli.js" + }, + "engines": { + "node": ">=8" + } + } + } +} diff --git a/examples/testing/checkout-basic-testing-example/package.json b/examples/testing/checkout-basic-testing-example/package.json new file mode 100644 index 0000000000..c9e4089476 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/package.json @@ -0,0 +1,29 @@ +{ + "name": "checkout-basic-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "scripts": { + "shopify": "shopify", + "build": "shopify app build", + "dev": "shopify app dev", + "info": "shopify app info", + "generate": "shopify app generate", + "deploy": "shopify app deploy", + "test": "vitest run", + "typecheck": "tsc --noEmit --project extensions/checkout-basic-testing-example/tsconfig.json" + }, + "dependencies": { + "@shopify/ui-extensions": "file:../../../packages/ui-extensions" + }, + "devDependencies": { + "@shopify/ui-extensions-tester": "file:../../../packages/ui-extensions-tester", + "@testing-library/preact": "^3.2.0", + "typescript": "^5.0.0", + "vitest": "^3.0.0" + }, + "trustedDependencies": [ + "@shopify/plugin-cloudflare" + ], + "author": "kumar", + "private": true +} diff --git a/examples/testing/checkout-basic-testing-example/pnpm-workspace.yaml b/examples/testing/checkout-basic-testing-example/pnpm-workspace.yaml new file mode 100644 index 0000000000..2115b27617 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/pnpm-workspace.yaml @@ -0,0 +1,2 @@ +packages: + - 'extensions/*' diff --git a/examples/testing/checkout-basic-testing-example/shopify.app.toml b/examples/testing/checkout-basic-testing-example/shopify.app.toml new file mode 100644 index 0000000000..6d925afda2 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/shopify.app.toml @@ -0,0 +1,20 @@ +# Learn more about configuring your app at https://shopify.dev/docs/apps/tools/cli/configuration + +client_id = "528cbcda5989f92eb2e3b95acde92d82" +name = "checkout-basic-testing-example" +application_url = "https://shopify.dev/apps/default-app-home" +embedded = true + +[build] +automatically_update_urls_on_dev = true +include_config_on_deploy = true + +[webhooks] +api_version = "2026-04" + +[access_scopes] +# Learn more at https://shopify.dev/docs/apps/tools/cli/configuration#access_scopes +scopes = "" + +[auth] +redirect_urls = [ "https://shopify.dev/apps/default-app-home/api/auth" ] diff --git a/examples/testing/checkout-basic-testing-example/tsconfig.json b/examples/testing/checkout-basic-testing-example/tsconfig.json new file mode 100644 index 0000000000..ae5483c38a --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/tsconfig.json @@ -0,0 +1,12 @@ +{ + "compilerOptions": { + "target": "ES2020", + "module": "esnext", + "moduleResolution": "bundler", + "esModuleInterop": true, + "skipLibCheck": true, + "strict": true, + "noEmit": true + }, + "include": ["extensions/checkout-basic-testing-example/tests"] +} diff --git a/examples/testing/checkout-basic-testing-example/vitest.config.ts b/examples/testing/checkout-basic-testing-example/vitest.config.ts new file mode 100644 index 0000000000..68e3ffd6d8 --- /dev/null +++ b/examples/testing/checkout-basic-testing-example/vitest.config.ts @@ -0,0 +1,11 @@ +import {defineConfig} from 'vitest/config'; + +export default defineConfig({ + esbuild: { + jsx: 'automatic', + jsxImportSource: 'preact', + }, + test: { + environment: 'jsdom', + }, +}); diff --git a/examples/testing/customer-account-testing-example/.gitignore b/examples/testing/customer-account-testing-example/.gitignore new file mode 100644 index 0000000000..43a02ea149 --- /dev/null +++ b/examples/testing/customer-account-testing-example/.gitignore @@ -0,0 +1,29 @@ +# Environment Configuration +.env +.env.* + +# Dependency directory +node_modules + +# Test coverage directory +coverage + +# Ignore Apple macOS Desktop Services Store +.DS_Store + +# Logs +logs +*.log + +# extensions build output +extensions/*/build +extensions/*/dist + +# lock files + + + + +# Ignore shopify files created during app dev +.shopify/* +.shopify.lock \ No newline at end of file diff --git a/examples/testing/customer-account-testing-example/.graphqlrc.js b/examples/testing/customer-account-testing-example/.graphqlrc.js new file mode 100644 index 0000000000..b58eae185c --- /dev/null +++ b/examples/testing/customer-account-testing-example/.graphqlrc.js @@ -0,0 +1,30 @@ +const fs = require("node:fs"); + +function getConfig() { + const config = { + projects: {}, + }; + + let extensions = []; + try { + extensions = fs.readdirSync("./extensions"); + } catch { + // ignore if no extensions + } + + for (const entry of extensions) { + const extensionPath = `./extensions/${entry}`; + const schema = `${extensionPath}/schema.graphql`; + if (!fs.existsSync(schema)) { + continue; + } + config.projects[entry] = { + schema, + documents: [`${extensionPath}/**/*.graphql`], + }; + } + + return config; +} + +module.exports = getConfig(); diff --git a/examples/testing/customer-account-testing-example/README.md b/examples/testing/customer-account-testing-example/README.md new file mode 100644 index 0000000000..6f54a035e4 --- /dev/null +++ b/examples/testing/customer-account-testing-example/README.md @@ -0,0 +1,24 @@ +This extension was created with: + +``` +shopify app init --name customer-account-testing-example +cd customer-account-testing-example +shopify app generate extension +# I chose 'Customer account UI' +``` + +See it in action: + +Build the root package: + +``` +yarn build +``` + +Change into this example package and run: + +``` +npm install +npm run typecheck +npm test +``` diff --git a/examples/testing/customer-account-testing-example/extensions/.gitkeep b/examples/testing/customer-account-testing-example/extensions/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/package-lock.json b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/package-lock.json new file mode 100644 index 0000000000..a601d98d80 --- /dev/null +++ b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/package-lock.json @@ -0,0 +1,55 @@ +{ + "name": "customer-account-testing-example-ext", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "customer-account-testing-example-ext", + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "@preact/signals": "^2.3.x", + "@shopify/ui-extensions": "file:../../../../packages/ui-extensions", + "preact": "^10.10.x" + } + }, + "../../../../packages/ui-extensions": {}, + "node_modules/@preact/signals": { + "version": "2.7.1", + "license": "MIT", + "dependencies": { + "@preact/signals-core": "^1.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + }, + "peerDependencies": { + "preact": ">= 10.25.0 || >=11.0.0-0" + } + }, + "node_modules/@preact/signals-core": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/@preact/signals-core/-/signals-core-1.13.0.tgz", + "integrity": "sha512-slT6XeTCAbdql61GVLlGU4x7XHI7kCZV5Um5uhE4zLX4ApgiiXc0UYFvVOKq06xcovzp7p+61l68oPi563ARKg==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/@shopify/ui-extensions": { + "resolved": "../../../../packages/ui-extensions", + "link": true + }, + "node_modules/preact": { + "version": "10.28.3", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + } + } +} diff --git a/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/package.json b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/package.json new file mode 100644 index 0000000000..216110a73c --- /dev/null +++ b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/package.json @@ -0,0 +1,11 @@ +{ + "name": "customer-account-testing-example-ext", + "private": true, + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "preact": "^10.10.x", + "@preact/signals": "^2.3.x", + "@shopify/ui-extensions": "file:../../../../packages/ui-extensions" + } +} diff --git a/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/shopify.d.ts b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/shopify.d.ts new file mode 100644 index 0000000000..29be807e3e --- /dev/null +++ b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/shopify.d.ts @@ -0,0 +1,7 @@ +import '@shopify/ui-extensions'; + +//@ts-ignore +declare module './src/OrderStatusBlock.jsx' { + const shopify: import('@shopify/ui-extensions/customer-account.order-status.block.render').Api; + const globalThis: { shopify: typeof shopify }; +} diff --git a/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/shopify.extension.toml b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/shopify.extension.toml new file mode 100644 index 0000000000..4786d71534 --- /dev/null +++ b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/shopify.extension.toml @@ -0,0 +1,19 @@ +# Learn more about configuring your Customer account UI extension: +# https://shopify.dev/api/customer-account-ui-extensions/unstable/configuration + +# The version of APIs your extension will receive. Learn more: +# https://shopify.dev/docs/api/usage/versioning +api_version = "2026-07" + +[[extensions]] +name = "customer-account-testing-example" +handle = "customer-account-testing-example" +type = "ui_extension" +uid = "9ebaa5f0-a0d8-25bf-6290-c55f579e4dfac7c7fcd2" + +[[extensions.targeting]] +module = "./src/OrderStatusBlock.jsx" +target = "customer-account.order-status.block.render" + +[extensions.capabilities] +api_access = true diff --git a/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/src/OrderStatusBlock.jsx b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/src/OrderStatusBlock.jsx new file mode 100644 index 0000000000..d1570a487b --- /dev/null +++ b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/src/OrderStatusBlock.jsx @@ -0,0 +1,20 @@ +import '@shopify/ui-extensions/preact'; +import {render} from 'preact'; + +export default async () => { + render(, document.body); +}; + +function Extension() { + const order = shopify.order.value; + const totalAmount = shopify.cost.totalAmount.value; + + return ( + + {order ? `Order ${order.name}` : 'Order Summary'} + + Total: {totalAmount.amount} {totalAmount.currencyCode} + + + ); +} diff --git a/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/tests/OrderStatusBlock.test.ts b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/tests/OrderStatusBlock.test.ts new file mode 100644 index 0000000000..c3add6a4a6 --- /dev/null +++ b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/tests/OrderStatusBlock.test.ts @@ -0,0 +1,44 @@ +/// +// ^ This defines types for custom Shopify elements supported by the target. + +import {expect, test, beforeEach, afterEach} from 'vitest'; +import {getExtension} from '@shopify/ui-extensions-tester'; + +const extension = getExtension( + 'customer-account.order-status.block.render', +); + +beforeEach(() => { + extension.setUp(); +}); + +afterEach(() => { + extension.tearDown(); +}); + +test('shows a generic heading when there is no order', async () => { + extension.shopify.order.value = undefined; + + await extension.render(); + + const heading = document.body.querySelector('s-heading')!; + expect(heading.textContent).toEqual('Order Summary'); +}); + +test('shows the order name in the heading', async () => { + extension.shopify.order.value!.name = '#1042'; + + await extension.render(); + + const heading = document.body.querySelector('s-heading')!; + expect(heading.textContent).toEqual('Order #1042'); +}); + +test('shows the total amount with currency', async () => { + await extension.render(); + + const texts = Array.from(document.body.querySelectorAll('s-text')); + const content = texts.map((el) => el.textContent).join(''); + expect(content).toContain('0'); + expect(content).toContain('USD'); +}); diff --git a/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/tsconfig.json b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/tsconfig.json new file mode 100644 index 0000000000..71a533a7ed --- /dev/null +++ b/examples/testing/customer-account-testing-example/extensions/customer-account-testing-example/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "jsx": "react-jsx", + "jsxImportSource": "preact", + "target": "ES2020", + "allowJs": true, + "moduleResolution": "node", + "esModuleInterop": true, + "noEmit": true, + "strict": true, + "skipLibCheck": true, + // Monorepo only: file: deps create symlinks that cause TS to + // resolve a different preact instance. Not needed with published packages. + "paths": { + "preact": ["../../node_modules/preact"], + "preact/*": ["../../node_modules/preact/*"] + } + }, + "include": ["./src", "./tests", "./shopify.d.ts"] +} diff --git a/examples/testing/customer-account-testing-example/package-lock.json b/examples/testing/customer-account-testing-example/package-lock.json new file mode 100644 index 0000000000..12b739b5ca --- /dev/null +++ b/examples/testing/customer-account-testing-example/package-lock.json @@ -0,0 +1,2897 @@ +{ + "name": "customer-account-testing-example", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "customer-account-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "@shopify/ui-extensions": "file:../../../packages/ui-extensions" + }, + "devDependencies": { + "@shopify/ui-extensions-tester": "file:../../../packages/ui-extensions-tester", + "@testing-library/preact": "^3.2.0", + "typescript": "^5.0.0", + "vitest": "^3.0.0" + } + }, + "../../../packages/ui-extensions": { + "name": "@shopify/ui-extensions", + "version": "2026.4.0-rc.2", + "license": "MIT", + "dependencies": { + "ts-morph": "^25.0.1" + }, + "devDependencies": { + "@faker-js/faker": "^8.4.1", + "@preact/signals": "^2.3.x", + "@quilted/react-testing": "^0.6.11", + "@remote-ui/async-subscription": "^2.1.16", + "@shopify/generate-docs": "https://registry.npmjs.org/@shopify/generate-docs/-/generate-docs-0.19.8.tgz", + "preact": "^10.10.x", + "typescript": "^4.9.0" + }, + "peerDependencies": { + "@preact/signals": "*", + "preact": "*" + }, + "peerDependenciesMeta": { + "@preact/signals": { + "optional": true + }, + "preact": { + "optional": true + } + } + }, + "../../../packages/ui-extensions-tester": { + "name": "@shopify/ui-extensions-tester", + "version": "2026.4.0-rc.2", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/ui-extensions": "2026.4.0-rc.2" + }, + "devDependencies": { + "typescript": "^4.9.0" + }, + "peerDependencies": { + "preact": "^10.0.0" + }, + "peerDependenciesMeta": { + "preact": { + "optional": true + } + } + }, + "node_modules/@babel/code-frame": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.28.5", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/code-frame/node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/runtime": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.28.6.tgz", + "integrity": "sha512-05WQkdpL9COIMz4LjTxGpPNCdlpyimKppYNoJ5Di5EUObifl8t4tuLuUBBZEpoLYOmfvIWrsp9fCl0HoPRVTdA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.3.tgz", + "integrity": "sha512-9fJMTNFTWZMh5qwrBItuziu834eOCUcEqymSH7pY+zoMVEZg3gcPuBNxH1EvfVYe9h0x/Ptw8KBzv7qxb7l8dg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.3.tgz", + "integrity": "sha512-i5D1hPY7GIQmXlXhs2w8AWHhenb00+GxjxRncS2ZM7YNVGNfaMxgzSGuO8o8SJzRc/oZwU2bcScvVERk03QhzA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.3.tgz", + "integrity": "sha512-YdghPYUmj/FX2SYKJ0OZxf+iaKgMsKHVPF1MAq/P8WirnSpCStzKJFjOjzsW0QQ7oIAiccHdcqjbHmJxRb/dmg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.3.tgz", + "integrity": "sha512-IN/0BNTkHtk8lkOM8JWAYFg4ORxBkZQf9zXiEOfERX/CzxW3Vg1ewAhU7QSWQpVIzTW+b8Xy+lGzdYXV6UZObQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.3.tgz", + "integrity": "sha512-Re491k7ByTVRy0t3EKWajdLIr0gz2kKKfzafkth4Q8A5n1xTHrkqZgLLjFEHVD+AXdUGgQMq+Godfq45mGpCKg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.3.tgz", + "integrity": "sha512-vHk/hA7/1AckjGzRqi6wbo+jaShzRowYip6rt6q7VYEDX4LEy1pZfDpdxCBnGtl+A5zq8iXDcyuxwtv3hNtHFg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.3.tgz", + "integrity": "sha512-ipTYM2fjt3kQAYOvo6vcxJx3nBYAzPjgTCk7QEgZG8AUO3ydUhvelmhrbOheMnGOlaSFUoHXB6un+A7q4ygY9w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.3.tgz", + "integrity": "sha512-dDk0X87T7mI6U3K9VjWtHOXqwAMJBNN2r7bejDsc+j03SEjtD9HrOl8gVFByeM0aJksoUuUVU9TBaZa2rgj0oA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.3.tgz", + "integrity": "sha512-s6nPv2QkSupJwLYyfS+gwdirm0ukyTFNl3KTgZEAiJDd+iHZcbTPPcWCcRYH+WlNbwChgH2QkE9NSlNrMT8Gfw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.3.tgz", + "integrity": "sha512-sZOuFz/xWnZ4KH3YfFrKCf1WyPZHakVzTiqji3WDc0BCl2kBwiJLCXpzLzUBLgmp4veFZdvN5ChW4Eq/8Fc2Fg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.3.tgz", + "integrity": "sha512-yGlQYjdxtLdh0a3jHjuwOrxQjOZYD/C9PfdbgJJF3TIZWnm/tMd/RcNiLngiu4iwcBAOezdnSLAwQDPqTmtTYg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.3.tgz", + "integrity": "sha512-WO60Sn8ly3gtzhyjATDgieJNet/KqsDlX5nRC5Y3oTFcS1l0KWba+SEa9Ja1GfDqSF1z6hif/SkpQJbL63cgOA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.3.tgz", + "integrity": "sha512-APsymYA6sGcZ4pD6k+UxbDjOFSvPWyZhjaiPyl/f79xKxwTnrn5QUnXR5prvetuaSMsb4jgeHewIDCIWljrSxw==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.3.tgz", + "integrity": "sha512-eizBnTeBefojtDb9nSh4vvVQ3V9Qf9Df01PfawPcRzJH4gFSgrObw+LveUyDoKU3kxi5+9RJTCWlj4FjYXVPEA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.3.tgz", + "integrity": "sha512-3Emwh0r5wmfm3ssTWRQSyVhbOHvqegUDRd0WhmXKX2mkHJe1SFCMJhagUleMq+Uci34wLSipf8Lagt4LlpRFWQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.3.tgz", + "integrity": "sha512-pBHUx9LzXWBc7MFIEEL0yD/ZVtNgLytvx60gES28GcWMqil8ElCYR4kvbV2BDqsHOvVDRrOxGySBM9Fcv744hw==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.3.tgz", + "integrity": "sha512-Czi8yzXUWIQYAtL/2y6vogER8pvcsOsk5cpwL4Gk5nJqH5UZiVByIY8Eorm5R13gq+DQKYg0+JyQoytLQas4dA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.3.tgz", + "integrity": "sha512-sDpk0RgmTCR/5HguIZa9n9u+HVKf40fbEUt+iTzSnCaGvY9kFP0YKBWZtJaraonFnqef5SlJ8/TiPAxzyS+UoA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.3.tgz", + "integrity": "sha512-P14lFKJl/DdaE00LItAukUdZO5iqNH7+PjoBm+fLQjtxfcfFE20Xf5CrLsmZdq5LFFZzb5JMZ9grUwvtVYzjiA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.3.tgz", + "integrity": "sha512-AIcMP77AvirGbRl/UZFTq5hjXK+2wC7qFRGoHSDrZ5v5b8DK/GYpXW3CPRL53NkvDqb9D+alBiC/dV0Fb7eJcw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.3.tgz", + "integrity": "sha512-DnW2sRrBzA+YnE70LKqnM3P+z8vehfJWHXECbwBmH/CU51z6FiqTQTHFenPlHmo3a8UgpLyH3PT+87OViOh1AQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.3.tgz", + "integrity": "sha512-NinAEgr/etERPTsZJ7aEZQvvg/A6IsZG/LgZy+81wON2huV7SrK3e63dU0XhyZP4RKGyTm7aOgmQk0bGp0fy2g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.3.tgz", + "integrity": "sha512-PanZ+nEz+eWoBJ8/f8HKxTTD172SKwdXebZ0ndd953gt1HRBbhMsaNqjTyYLGLPdoWHy4zLU7bDVJztF5f3BHA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.3.tgz", + "integrity": "sha512-B2t59lWWYrbRDw/tjiWOuzSsFh1Y/E95ofKz7rIVYSQkUYBjfSgf6oeYPNWHToFRr2zx52JKApIcAS/D5TUBnA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.3.tgz", + "integrity": "sha512-QLKSFeXNS8+tHW7tZpMtjlNb7HKau0QDpwm49u0vUp9y1WOF+PEzkU84y9GqYaAVW8aH8f3GcBck26jh54cX4Q==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.3.tgz", + "integrity": "sha512-4uJGhsxuptu3OcpVAzli+/gWusVGwZZHTlS63hh++ehExkVT8SgiEf7/uC/PclrPPkLhZqGgCTjd0VWLo6xMqA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "dev": true, + "license": "MIT" + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.57.1.tgz", + "integrity": "sha512-A6ehUVSiSaaliTxai040ZpZ2zTevHYbvu/lDoeAteHI8QnaosIzm4qwtezfRg1jOYaUmnzLX1AOD6Z+UJjtifg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.57.1.tgz", + "integrity": "sha512-dQaAddCY9YgkFHZcFNS/606Exo8vcLHwArFZ7vxXq4rigo2bb494/xKMMwRRQW6ug7Js6yXmBZhSBRuBvCCQ3w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.57.1.tgz", + "integrity": "sha512-crNPrwJOrRxagUYeMn/DZwqN88SDmwaJ8Cvi/TN1HnWBU7GwknckyosC2gd0IqYRsHDEnXf328o9/HC6OkPgOg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.57.1.tgz", + "integrity": "sha512-Ji8g8ChVbKrhFtig5QBV7iMaJrGtpHelkB3lsaKzadFBe58gmjfGXAOfI5FV0lYMH8wiqsxKQ1C9B0YTRXVy4w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.57.1.tgz", + "integrity": "sha512-R+/WwhsjmwodAcz65guCGFRkMb4gKWTcIeLy60JJQbXrJ97BOXHxnkPFrP+YwFlaS0m+uWJTstrUA9o+UchFug==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.57.1.tgz", + "integrity": "sha512-IEQTCHeiTOnAUC3IDQdzRAGj3jOAYNr9kBguI7MQAAZK3caezRrg0GxAb6Hchg4lxdZEI5Oq3iov/w/hnFWY9Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.57.1.tgz", + "integrity": "sha512-F8sWbhZ7tyuEfsmOxwc2giKDQzN3+kuBLPwwZGyVkLlKGdV1nvnNwYD0fKQ8+XS6hp9nY7B+ZeK01EBUE7aHaw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.57.1.tgz", + "integrity": "sha512-rGfNUfn0GIeXtBP1wL5MnzSj98+PZe/AXaGBCRmT0ts80lU5CATYGxXukeTX39XBKsxzFpEeK+Mrp9faXOlmrw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.57.1.tgz", + "integrity": "sha512-MMtej3YHWeg/0klK2Qodf3yrNzz6CGjo2UntLvk2RSPlhzgLvYEB3frRvbEF2wRKh1Z2fDIg9KRPe1fawv7C+g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.57.1.tgz", + "integrity": "sha512-1a/qhaaOXhqXGpMFMET9VqwZakkljWHLmZOX48R0I/YLbhdxr1m4gtG1Hq7++VhVUmf+L3sTAf9op4JlhQ5u1Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.57.1.tgz", + "integrity": "sha512-QWO6RQTZ/cqYtJMtxhkRkidoNGXc7ERPbZN7dVW5SdURuLeVU7lwKMpo18XdcmpWYd0qsP1bwKPf7DNSUinhvA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.57.1.tgz", + "integrity": "sha512-xpObYIf+8gprgWaPP32xiN5RVTi/s5FCR+XMXSKmhfoJjrpRAjCuuqQXyxUa/eJTdAE6eJ+KDKaoEqjZQxh3Gw==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.57.1.tgz", + "integrity": "sha512-4BrCgrpZo4hvzMDKRqEaW1zeecScDCR+2nZ86ATLhAoJ5FQ+lbHVD3ttKe74/c7tNT9c6F2viwB3ufwp01Oh2w==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.57.1.tgz", + "integrity": "sha512-NOlUuzesGauESAyEYFSe3QTUguL+lvrN1HtwEEsU2rOwdUDeTMJdO5dUYl/2hKf9jWydJrO9OL/XSSf65R5+Xw==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.57.1.tgz", + "integrity": "sha512-ptA88htVp0AwUUqhVghwDIKlvJMD/fmL/wrQj99PRHFRAG6Z5nbWoWG4o81Nt9FT+IuqUQi+L31ZKAFeJ5Is+A==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.57.1.tgz", + "integrity": "sha512-S51t7aMMTNdmAMPpBg7OOsTdn4tySRQvklmL3RpDRyknk87+Sp3xaumlatU+ppQ+5raY7sSTcC2beGgvhENfuw==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.57.1.tgz", + "integrity": "sha512-Bl00OFnVFkL82FHbEqy3k5CUCKH6OEJL54KCyx2oqsmZnFTR8IoNqBF+mjQVcRCT5sB6yOvK8A37LNm/kPJiZg==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.57.1.tgz", + "integrity": "sha512-ABca4ceT4N+Tv/GtotnWAeXZUZuM/9AQyCyKYyKnpk4yoA7QIAuBt6Hkgpw8kActYlew2mvckXkvx0FfoInnLg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.57.1.tgz", + "integrity": "sha512-HFps0JeGtuOR2convgRRkHCekD7j+gdAuXM+/i6kGzQtFhlCtQkpwtNzkNj6QhCDp7DRJ7+qC/1Vg2jt5iSOFw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.57.1.tgz", + "integrity": "sha512-H+hXEv9gdVQuDTgnqD+SQffoWoc0Of59AStSzTEj/feWTBAnSfSD3+Dql1ZruJQxmykT/JVY0dE8Ka7z0DH1hw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.57.1.tgz", + "integrity": "sha512-4wYoDpNg6o/oPximyc/NG+mYUejZrCU2q+2w6YZqrAs2UcNUChIZXjtafAiiZSUc7On8v5NyNj34Kzj/Ltk6dQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.57.1.tgz", + "integrity": "sha512-O54mtsV/6LW3P8qdTcamQmuC990HDfR71lo44oZMZlXU4tzLrbvTii87Ni9opq60ds0YzuAlEr/GNwuNluZyMQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.57.1.tgz", + "integrity": "sha512-P3dLS+IerxCT/7D2q2FYcRdWRl22dNbrbBEtxdWhXrfIMPP9lQhb5h4Du04mdl5Woq05jVCDPCMF7Ub0NAjIew==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.57.1.tgz", + "integrity": "sha512-VMBH2eOOaKGtIJYleXsi2B8CPVADrh+TyNxJ4mWPnKfLB/DBUmzW+5m1xUrcwWoMfSLagIRpjUFeW5CO5hyciQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.57.1.tgz", + "integrity": "sha512-mxRFDdHIWRxg3UfIIAwCm6NzvxG0jDX/wBN6KsQFTvKFqqg9vTrWUE68qEjHt19A5wwx5X5aUi2zuZT7YR0jrA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@shopify/ui-extensions": { + "resolved": "../../../packages/ui-extensions", + "link": true + }, + "node_modules/@shopify/ui-extensions-tester": { + "resolved": "../../../packages/ui-extensions-tester", + "link": true + }, + "node_modules/@testing-library/dom": { + "version": "8.20.1", + "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-8.20.1.tgz", + "integrity": "sha512-/DiOQ5xBxgdYRC8LNk7U+RWat0S3qRLeIw3ZIkMQ9kkVlRmwD/Eg8k8CqIpD6GW7u20JIUOfMKbxtiLutpjQ4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.10.4", + "@babel/runtime": "^7.12.5", + "@types/aria-query": "^5.0.1", + "aria-query": "5.1.3", + "chalk": "^4.1.0", + "dom-accessibility-api": "^0.5.9", + "lz-string": "^1.5.0", + "pretty-format": "^27.0.2" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@testing-library/preact": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@testing-library/preact/-/preact-3.2.4.tgz", + "integrity": "sha512-F+kJ243LP6VmEK1M809unzTE/ijg+bsMNuiRN0JEDIJBELKKDNhdgC/WrUSZ7klwJvtlO3wQZ9ix+jhObG07Fg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@testing-library/dom": "^8.11.1" + }, + "engines": { + "node": ">= 12" + }, + "peerDependencies": { + "preact": ">=10 || ^10.0.0-alpha.0 || ^10.0.0-beta.0" + } + }, + "node_modules/@types/aria-query": { + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", + "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/chai": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", + "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/deep-eql": "*", + "assertion-error": "^2.0.1" + } + }, + "node_modules/@types/deep-eql": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", + "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@vitest/expect": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", + "integrity": "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/mocker": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.2.4.tgz", + "integrity": "sha512-46ryTE9RZO/rfDd7pEqFl7etuyzekzEhUbTW3BvmeO/BcCMEgq59BKhek3dXDWgAj4oMK6OZi+vRr1wPW6qjEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "3.2.4", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.17" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "msw": "^2.4.9", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } + } + }, + "node_modules/@vitest/pretty-format": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.2.4.tgz", + "integrity": "sha512-IVNZik8IVRJRTr9fxlitMKeJeXFFFN0JaB9PHPGQ8NKQbGpfjlTx9zO4RefN8gp7eqjNy8nyK3NZmBzOPeIxtA==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/runner": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.2.4.tgz", + "integrity": "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/utils": "3.2.4", + "pathe": "^2.0.3", + "strip-literal": "^3.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/snapshot": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.2.4.tgz", + "integrity": "sha512-dEYtS7qQP2CjU27QBC5oUOxLE/v5eLkGqPE0ZKEIDGMs4vKWe7IjgLOeauHsR0D5YuuycGRO5oSRXnwnmA78fQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "magic-string": "^0.30.17", + "pathe": "^2.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/spy": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.2.4.tgz", + "integrity": "sha512-vAfasCOe6AIK70iP5UD11Ac4siNUNJ9i/9PZ3NKx07sG6sUxeag1LWdNrMWeKKYBLlzuK+Gn65Yd5nyL6ds+nw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyspy": "^4.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/utils": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.2.4.tgz", + "integrity": "sha512-fB2V0JFrQSMsCo9HiSq3Ezpdv4iYaXRG1Sx8edX3MwxfyNn83mKiGzOcH+Fkxt4MHxr3y42fQi1oeAInqgX2QA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "loupe": "^3.1.4", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/aria-query": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.1.3.tgz", + "integrity": "sha512-R5iJ5lkuHybztUfuOAznmboyjWq8O6sqNqtK7CLOqdydi54VNbORp49mb14KbWgG1QD3JFO9hJdZ+y4KutfdOQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "deep-equal": "^2.0.5" + } + }, + "node_modules/array-buffer-byte-length": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.2.tgz", + "integrity": "sha512-LHE+8BuR7RYGDKvnrmcuSq3tDcKv9OFEXQt/HpbZhY7V6h0zlUXutnAD82GiFx9rdieCMjkvtcsPqBwgUl1Iiw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "is-array-buffer": "^3.0.5" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/assertion-error": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", + "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/available-typed-arrays": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/cac": { + "version": "6.7.14", + "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", + "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/call-bind": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", + "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.0", + "es-define-property": "^1.0.0", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/chai": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz", + "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==", + "dev": true, + "license": "MIT", + "dependencies": { + "assertion-error": "^2.0.1", + "check-error": "^2.1.1", + "deep-eql": "^5.0.1", + "loupe": "^3.1.0", + "pathval": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/check-error": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz", + "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 16" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deep-eql": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", + "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/deep-equal": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-2.2.3.tgz", + "integrity": "sha512-ZIwpnevOurS8bpT4192sqAowWM76JDKSHYzMLty3BZGSswgq6pBaH3DhCSW5xVAZICZyKdOBPjwww5wfgT/6PA==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.0", + "call-bind": "^1.0.5", + "es-get-iterator": "^1.1.3", + "get-intrinsic": "^1.2.2", + "is-arguments": "^1.1.1", + "is-array-buffer": "^3.0.2", + "is-date-object": "^1.0.5", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.2", + "isarray": "^2.0.5", + "object-is": "^1.1.5", + "object-keys": "^1.1.1", + "object.assign": "^4.1.4", + "regexp.prototype.flags": "^1.5.1", + "side-channel": "^1.0.4", + "which-boxed-primitive": "^1.0.2", + "which-collection": "^1.0.1", + "which-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/dom-accessibility-api": { + "version": "0.5.16", + "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.5.16.tgz", + "integrity": "sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==", + "dev": true, + "license": "MIT" + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-get-iterator": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.3.tgz", + "integrity": "sha512-sPZmqHBe6JIiTfN5q2pEi//TwxmAFHwj/XEuYjTuse78i8KxaqMTTzxPoFKuzRpDpTJ+0NAbpfenkmH2rePtuw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.3", + "has-symbols": "^1.0.3", + "is-arguments": "^1.1.1", + "is-map": "^2.0.2", + "is-set": "^2.0.2", + "is-string": "^1.0.7", + "isarray": "^2.0.5", + "stop-iteration-iterator": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-module-lexer": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", + "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "dev": true, + "license": "MIT" + }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/esbuild": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.3.tgz", + "integrity": "sha512-8VwMnyGCONIs6cWue2IdpHxHnAjzxnw2Zr7MkVxB2vjmQ2ivqGFb4LEG3SMnv0Gb2F/G/2yA8zUaiL1gywDCCg==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.27.3", + "@esbuild/android-arm": "0.27.3", + "@esbuild/android-arm64": "0.27.3", + "@esbuild/android-x64": "0.27.3", + "@esbuild/darwin-arm64": "0.27.3", + "@esbuild/darwin-x64": "0.27.3", + "@esbuild/freebsd-arm64": "0.27.3", + "@esbuild/freebsd-x64": "0.27.3", + "@esbuild/linux-arm": "0.27.3", + "@esbuild/linux-arm64": "0.27.3", + "@esbuild/linux-ia32": "0.27.3", + "@esbuild/linux-loong64": "0.27.3", + "@esbuild/linux-mips64el": "0.27.3", + "@esbuild/linux-ppc64": "0.27.3", + "@esbuild/linux-riscv64": "0.27.3", + "@esbuild/linux-s390x": "0.27.3", + "@esbuild/linux-x64": "0.27.3", + "@esbuild/netbsd-arm64": "0.27.3", + "@esbuild/netbsd-x64": "0.27.3", + "@esbuild/openbsd-arm64": "0.27.3", + "@esbuild/openbsd-x64": "0.27.3", + "@esbuild/openharmony-arm64": "0.27.3", + "@esbuild/sunos-x64": "0.27.3", + "@esbuild/win32-arm64": "0.27.3", + "@esbuild/win32-ia32": "0.27.3", + "@esbuild/win32-x64": "0.27.3" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/expect-type": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", + "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/for-each": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.5.tgz", + "integrity": "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.2.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "dev": true, + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-bigints": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", + "integrity": "sha512-R3pbpkcIqv2Pm3dUwgjclDRVmWpTJW2DcMzcIhEXEx1oh/CEMObMm3KLmRJOdvhM7o4uQBnwr8pzRK2sJWIqfg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/internal-slot": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", + "integrity": "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "hasown": "^2.0.2", + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-arguments": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.2.0.tgz", + "integrity": "sha512-7bVbi0huj/wrIAOzb8U1aszg9kdi3KN/CyU19CTI7tAoZYEZoL9yCDXpbXN+uPsuWnP02cyug1gleqq+TU+YCA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-array-buffer": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.5.tgz", + "integrity": "sha512-DDfANUiiG2wC1qawP66qlTugJeL5HyzMpfr8lLK+jMQirGzNod0B12cFB/9q838Ru27sBwfw78/rdoU7RERz6A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-bigint": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.1.0.tgz", + "integrity": "sha512-n4ZT37wG78iz03xPRKJrHTdZbe3IicyucEtdRsV5yglwc3GyUfbAfpSeD0FJ41NbUNSt5wbhqfp1fS+BgnvDFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-bigints": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-boolean-object": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.2.2.tgz", + "integrity": "sha512-wa56o2/ElJMYqjCjGkXri7it5FbebW5usLw/nPmCMs5DeZ7eziSYZhSmPRn0txqeW4LnAmQQU7FgqLpsEFKM4A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-callable": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.1.0.tgz", + "integrity": "sha512-PwwhEakHVKTdRNVOw+/Gyh0+MzlCl4R6qKvkhuvLtPMggI1WAHt9sOwZxQLSGpUaDnrdyDsomoRgNnCfKNSXXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-map": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", + "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number-object": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.1.1.tgz", + "integrity": "sha512-lZhclumE1G6VYD8VHe35wFaIif+CTy5SJIi5+3y4psDgWu4wPDoBhF8NxUOinEc7pHgiTsT6MaBb92rKhhD+Xw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-regex": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.2.1.tgz", + "integrity": "sha512-MjYsKHO5O7mCsmRGxWcLWheFqN9DJ/2TmngvjKXihe6efViPqc274+Fx/4fYj/r03+ESvBdTXK0V6tA3rgez1g==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-set": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", + "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.4.tgz", + "integrity": "sha512-ISWac8drv4ZGfwKl5slpHG9OwPNty4jOWPRIhBpxOoD+hqITiwuipOQ2bNthAzwA3B4fIjO4Nln74N0S9byq8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-string": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.1.1.tgz", + "integrity": "sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.1.1.tgz", + "integrity": "sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-symbols": "^1.1.0", + "safe-regex-test": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakmap": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", + "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakset": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.4.tgz", + "integrity": "sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "license": "MIT" + }, + "node_modules/js-tokens": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", + "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/loupe": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz", + "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/lz-string": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", + "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", + "dev": true, + "license": "MIT", + "bin": { + "lz-string": "bin/bin.js" + } + }, + "node_modules/magic-string": { + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.5" + } + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true, + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/object-inspect": { + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-is": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", + "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", + "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0", + "has-symbols": "^1.1.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/pathe": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", + "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", + "dev": true, + "license": "MIT" + }, + "node_modules/pathval": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz", + "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 14.16" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/possible-typed-array-names": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", + "integrity": "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/postcss": { + "version": "8.5.6", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", + "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/preact": { + "version": "10.28.3", + "resolved": "https://registry.npmjs.org/preact/-/preact-10.28.3.tgz", + "integrity": "sha512-tCmoRkPQLpBeWzpmbhryairGnhW9tKV6c6gr/w+RhoRoKEJwsjzipwp//1oCpGPOchvSLaAPlpcJi9MwMmoPyA==", + "dev": true, + "license": "MIT", + "peer": true, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/pretty-format": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", + "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^17.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/pretty-format/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/react-is": { + "version": "17.0.2", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", + "dev": true, + "license": "MIT" + }, + "node_modules/regexp.prototype.flags": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", + "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "set-function-name": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/rollup": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.57.1.tgz", + "integrity": "sha512-oQL6lgK3e2QZeQ7gcgIkS2YZPg5slw37hYufJ3edKlfQSGGm8ICoxswK15ntSzF/a8+h7ekRy7k7oWc3BQ7y8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.57.1", + "@rollup/rollup-android-arm64": "4.57.1", + "@rollup/rollup-darwin-arm64": "4.57.1", + "@rollup/rollup-darwin-x64": "4.57.1", + "@rollup/rollup-freebsd-arm64": "4.57.1", + "@rollup/rollup-freebsd-x64": "4.57.1", + "@rollup/rollup-linux-arm-gnueabihf": "4.57.1", + "@rollup/rollup-linux-arm-musleabihf": "4.57.1", + "@rollup/rollup-linux-arm64-gnu": "4.57.1", + "@rollup/rollup-linux-arm64-musl": "4.57.1", + "@rollup/rollup-linux-loong64-gnu": "4.57.1", + "@rollup/rollup-linux-loong64-musl": "4.57.1", + "@rollup/rollup-linux-ppc64-gnu": "4.57.1", + "@rollup/rollup-linux-ppc64-musl": "4.57.1", + "@rollup/rollup-linux-riscv64-gnu": "4.57.1", + "@rollup/rollup-linux-riscv64-musl": "4.57.1", + "@rollup/rollup-linux-s390x-gnu": "4.57.1", + "@rollup/rollup-linux-x64-gnu": "4.57.1", + "@rollup/rollup-linux-x64-musl": "4.57.1", + "@rollup/rollup-openbsd-x64": "4.57.1", + "@rollup/rollup-openharmony-arm64": "4.57.1", + "@rollup/rollup-win32-arm64-msvc": "4.57.1", + "@rollup/rollup-win32-ia32-msvc": "4.57.1", + "@rollup/rollup-win32-x64-gnu": "4.57.1", + "@rollup/rollup-win32-x64-msvc": "4.57.1", + "fsevents": "~2.3.2" + } + }, + "node_modules/safe-regex-test": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.1.0.tgz", + "integrity": "sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "is-regex": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/side-channel": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", + "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/siginfo": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", + "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", + "dev": true, + "license": "ISC" + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stackback": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", + "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", + "dev": true, + "license": "MIT" + }, + "node_modules/std-env": { + "version": "3.10.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", + "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "dev": true, + "license": "MIT" + }, + "node_modules/stop-iteration-iterator": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz", + "integrity": "sha512-eLoXW/DHyl62zxY4SCaIgnRhuMr6ri4juEYARS8E6sCEqzKpOiE521Ucofdx+KnDZl5xmvGYaaKCk5FEOxJCoQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "internal-slot": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/strip-literal": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz", + "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "js-tokens": "^9.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/antfu" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/tinybench": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", + "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyexec": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", + "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyglobby": { + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "fdir": "^6.5.0", + "picomatch": "^4.0.3" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/tinyglobby/node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/tinyglobby/node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/tinypool": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", + "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18.0.0 || >=20.0.0" + } + }, + "node_modules/tinyrainbow": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", + "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/tinyspy": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-4.0.4.tgz", + "integrity": "sha512-azl+t0z7pw/z958Gy9svOTuzqIk6xq+NSheJzn5MMWtWTFywIacg2wUlzKFGtt3cthx0r2SxMK0yzJOR0IES7Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/vite": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.1.tgz", + "integrity": "sha512-w+N7Hifpc3gRjZ63vYBXA56dvvRlNWRczTdmCBBa+CotUzAPf5b7YMdMR/8CQoeYE5LX3W4wj6RYTgonm1b9DA==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.27.0", + "fdir": "^6.5.0", + "picomatch": "^4.0.3", + "postcss": "^8.5.6", + "rollup": "^4.43.0", + "tinyglobby": "^0.2.15" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^20.19.0 || >=22.12.0", + "jiti": ">=1.21.0", + "less": "^4.0.0", + "lightningcss": "^1.21.0", + "sass": "^1.70.0", + "sass-embedded": "^1.70.0", + "stylus": ">=0.54.8", + "sugarss": "^5.0.0", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vite-node": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.2.4.tgz", + "integrity": "sha512-EbKSKh+bh1E1IFxeO0pg1n4dvoOTt0UDiXMd/qn++r98+jPO1xtJilvXldeuQ8giIB5IkpjCgMleHMNEsGH6pg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cac": "^6.7.14", + "debug": "^4.4.1", + "es-module-lexer": "^1.7.0", + "pathe": "^2.0.3", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "bin": { + "vite-node": "vite-node.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/vite/node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/vite/node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/vitest": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", + "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/expect": "3.2.4", + "@vitest/mocker": "3.2.4", + "@vitest/pretty-format": "^3.2.4", + "@vitest/runner": "3.2.4", + "@vitest/snapshot": "3.2.4", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "debug": "^4.4.1", + "expect-type": "^1.2.1", + "magic-string": "^0.30.17", + "pathe": "^2.0.3", + "picomatch": "^4.0.2", + "std-env": "^3.9.0", + "tinybench": "^2.9.0", + "tinyexec": "^0.3.2", + "tinyglobby": "^0.2.14", + "tinypool": "^1.1.1", + "tinyrainbow": "^2.0.0", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0", + "vite-node": "3.2.4", + "why-is-node-running": "^2.3.0" + }, + "bin": { + "vitest": "vitest.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@edge-runtime/vm": "*", + "@types/debug": "^4.1.12", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@vitest/browser": "3.2.4", + "@vitest/ui": "3.2.4", + "happy-dom": "*", + "jsdom": "*" + }, + "peerDependenciesMeta": { + "@edge-runtime/vm": { + "optional": true + }, + "@types/debug": { + "optional": true + }, + "@types/node": { + "optional": true + }, + "@vitest/browser": { + "optional": true + }, + "@vitest/ui": { + "optional": true + }, + "happy-dom": { + "optional": true + }, + "jsdom": { + "optional": true + } + } + }, + "node_modules/vitest/node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.1.1.tgz", + "integrity": "sha512-TbX3mj8n0odCBFVlY8AxkqcHASw3L60jIuF8jFP78az3C2YhmGvqbHBpAjTRH2/xqYunrJ9g1jSyjCjpoWzIAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-bigint": "^1.1.0", + "is-boolean-object": "^1.2.1", + "is-number-object": "^1.1.1", + "is-string": "^1.1.1", + "is-symbol": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-collection": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", + "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-map": "^2.0.3", + "is-set": "^2.0.3", + "is-weakmap": "^2.0.2", + "is-weakset": "^2.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-typed-array": { + "version": "1.1.20", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.20.tgz", + "integrity": "sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", + "for-each": "^0.3.5", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/why-is-node-running": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", + "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", + "dev": true, + "license": "MIT", + "dependencies": { + "siginfo": "^2.0.0", + "stackback": "0.0.2" + }, + "bin": { + "why-is-node-running": "cli.js" + }, + "engines": { + "node": ">=8" + } + } + } +} diff --git a/examples/testing/customer-account-testing-example/package.json b/examples/testing/customer-account-testing-example/package.json new file mode 100644 index 0000000000..3f366fe51f --- /dev/null +++ b/examples/testing/customer-account-testing-example/package.json @@ -0,0 +1,29 @@ +{ + "name": "customer-account-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "private": true, + "scripts": { + "shopify": "shopify", + "build": "shopify app build", + "dev": "shopify app dev", + "info": "shopify app info", + "generate": "shopify app generate", + "deploy": "shopify app deploy", + "test": "vitest run", + "typecheck": "tsc --noEmit --project extensions/customer-account-testing-example/tsconfig.json" + }, + "dependencies": { + "@shopify/ui-extensions": "file:../../../packages/ui-extensions" + }, + "devDependencies": { + "@shopify/ui-extensions-tester": "file:../../../packages/ui-extensions-tester", + "@testing-library/preact": "^3.2.0", + "typescript": "^5.0.0", + "vitest": "^3.0.0" + }, + "trustedDependencies": [ + "@shopify/plugin-cloudflare" + ], + "author": "kumar" +} diff --git a/examples/testing/customer-account-testing-example/shopify.app.toml b/examples/testing/customer-account-testing-example/shopify.app.toml new file mode 100644 index 0000000000..adbeecfa36 --- /dev/null +++ b/examples/testing/customer-account-testing-example/shopify.app.toml @@ -0,0 +1,20 @@ +# Learn more about configuring your app at https://shopify.dev/docs/apps/tools/cli/configuration + +client_id = "3a5d8892875c182cc9f593c6c53a623c" +name = "customer-account-test-ex" +application_url = "https://shopify.dev/apps/default-app-home" +embedded = true + +[build] +automatically_update_urls_on_dev = true +include_config_on_deploy = true + +[webhooks] +api_version = "2026-04" + +[access_scopes] +# Learn more at https://shopify.dev/docs/apps/tools/cli/configuration#access_scopes +scopes = "" + +[auth] +redirect_urls = [ "https://shopify.dev/apps/default-app-home/api/auth" ] diff --git a/examples/testing/customer-account-testing-example/vitest.config.ts b/examples/testing/customer-account-testing-example/vitest.config.ts new file mode 100644 index 0000000000..7739a60a1c --- /dev/null +++ b/examples/testing/customer-account-testing-example/vitest.config.ts @@ -0,0 +1,20 @@ +import path from 'path'; +import {defineConfig} from 'vitest/config'; + +const extensionModules = path.resolve( + __dirname, + 'extensions/customer-account-testing-example/node_modules', +); + +export default defineConfig({ + esbuild: { + jsx: 'automatic', + jsxImportSource: 'preact', + }, + resolve: { + modules: [extensionModules, 'node_modules'], + }, + test: { + environment: 'jsdom', + }, +}); diff --git a/examples/testing/point-of-sale-testing-example/.gitignore b/examples/testing/point-of-sale-testing-example/.gitignore new file mode 100644 index 0000000000..cced47e983 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/.gitignore @@ -0,0 +1,28 @@ +# Environment Configuration +.env +.env.* + +# Dependency directory +node_modules + +# Test coverage directory +coverage + +# Ignore Apple macOS Desktop Services Store +.DS_Store + +# Logs +logs +*.log + +# extensions build output +extensions/*/build +extensions/*/dist + +# lock files + + + +# Ignore shopify files created during app dev +.shopify/* +.shopify.lock diff --git a/examples/testing/point-of-sale-testing-example/.graphqlrc.js b/examples/testing/point-of-sale-testing-example/.graphqlrc.js new file mode 100644 index 0000000000..b58eae185c --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/.graphqlrc.js @@ -0,0 +1,30 @@ +const fs = require("node:fs"); + +function getConfig() { + const config = { + projects: {}, + }; + + let extensions = []; + try { + extensions = fs.readdirSync("./extensions"); + } catch { + // ignore if no extensions + } + + for (const entry of extensions) { + const extensionPath = `./extensions/${entry}`; + const schema = `${extensionPath}/schema.graphql`; + if (!fs.existsSync(schema)) { + continue; + } + config.projects[entry] = { + schema, + documents: [`${extensionPath}/**/*.graphql`], + }; + } + + return config; +} + +module.exports = getConfig(); diff --git a/examples/testing/point-of-sale-testing-example/README.md b/examples/testing/point-of-sale-testing-example/README.md new file mode 100644 index 0000000000..4d0f363d71 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/README.md @@ -0,0 +1,24 @@ +This extension was created with: + +``` +shopify app init --name point-of-sale-testing-example +cd point-of-sale-testing-example +shopify app generate extension +# I chose 'POS block' +``` + +See it in action: + +Build the root package: + +``` +yarn build +``` + +Change into this example package and run: + +``` +npm install +npm run typecheck +npm test +``` diff --git a/examples/testing/point-of-sale-testing-example/extensions/.gitkeep b/examples/testing/point-of-sale-testing-example/extensions/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/package-lock.json b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/package-lock.json new file mode 100644 index 0000000000..5cb5ea263d --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/package-lock.json @@ -0,0 +1,32 @@ +{ + "name": "point-of-sale-testing-example-ext", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "point-of-sale-testing-example-ext", + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "@shopify/ui-extensions": "file:../../../../packages/ui-extensions", + "preact": "^10.10.x" + } + }, + "../../../../packages/ui-extensions": {}, + "node_modules/@shopify/ui-extensions": { + "resolved": "../../../../packages/ui-extensions", + "link": true + }, + "node_modules/preact": { + "version": "10.28.3", + "resolved": "https://registry.npmjs.org/preact/-/preact-10.28.3.tgz", + "integrity": "sha512-tCmoRkPQLpBeWzpmbhryairGnhW9tKV6c6gr/w+RhoRoKEJwsjzipwp//1oCpGPOchvSLaAPlpcJi9MwMmoPyA==", + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + } + } +} diff --git a/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/package.json b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/package.json new file mode 100644 index 0000000000..934b74555b --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/package.json @@ -0,0 +1,10 @@ +{ + "name": "point-of-sale-testing-example-ext", + "private": true, + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "@shopify/ui-extensions": "file:../../../../packages/ui-extensions", + "preact": "^10.10.x" + } +} diff --git a/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/shopify.d.ts b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/shopify.d.ts new file mode 100644 index 0000000000..7cbfcaa9d2 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/shopify.d.ts @@ -0,0 +1,13 @@ +import '@shopify/ui-extensions'; + +//@ts-ignore +declare module './src/Tile.jsx' { + const shopify: import('@shopify/ui-extensions/pos.home.tile.render').Api; + const globalThis: { shopify: typeof shopify }; +} + +//@ts-ignore +declare module './src/Modal.jsx' { + const shopify: import('@shopify/ui-extensions/pos.home.modal.render').Api; + const globalThis: { shopify: typeof shopify }; +} diff --git a/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/shopify.extension.toml b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/shopify.extension.toml new file mode 100644 index 0000000000..62b713376b --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/shopify.extension.toml @@ -0,0 +1,21 @@ +# Learn more about configuring your POS UI extension: +# https://shopify.dev/docs/api/pos-ui-extensions + +# The version of APIs your extension will receive. Learn more: +# https://shopify.dev/docs/api/usage/versioning +api_version = "2026-07" + +[[extensions]] +uid = "80f617f3-cfaf-bcfc-f4bd-8bf4faabbc38dc0e7226" +type = "ui_extension" +name = "point-of-sale-testing-example" +handle = "point-of-sale-testing-example" +description = "A preact POS UI extension" + +[[extensions.targeting]] +module = "./src/Tile.jsx" +target = "pos.home.tile.render" + +[[extensions.targeting]] +module = "./src/Modal.jsx" +target = "pos.home.modal.render" diff --git a/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/src/Modal.jsx b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/src/Modal.jsx new file mode 100644 index 0000000000..efcf0131a2 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/src/Modal.jsx @@ -0,0 +1,27 @@ +import {render} from 'preact'; + +export default async () => { + render(, document.body); +}; + +function Extension() { + const cart = shopify.cart.current.value; + const lineItems = cart ? cart.lineItems : []; + + return ( + + + {lineItems.length === 0 ? ( + No items in cart + ) : ( + lineItems.map((item) => ( + + {item.title} + Qty: {item.quantity} + + )) + )} + + + ); +} diff --git a/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/src/Tile.jsx b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/src/Tile.jsx new file mode 100644 index 0000000000..2d0913d4ca --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/src/Tile.jsx @@ -0,0 +1,36 @@ +import {render} from 'preact'; + +export default async () => { + render(, document.body); +}; + +function Extension() { + const cart = shopify.cart.current.value; + const lineItems = cart ? cart.lineItems : []; + const itemCount = lineItems.length; + + function handleClick() { + shopify.action.presentModal(); + } + + function handleAddQuantity() { + shopify.cart.bulkCartUpdate({ + lineItems: lineItems.map((item) => ({ + ...item, + quantity: item.quantity + 1, + })), + cartDiscounts: cart ? cart.cartDiscounts : [], + properties: cart ? cart.properties : {}, + }); + } + + return ( + + Increment all quantities + + ); +} diff --git a/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/tests/Modal.test.ts b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/tests/Modal.test.ts new file mode 100644 index 0000000000..30739125f8 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/tests/Modal.test.ts @@ -0,0 +1,41 @@ +/// +// ^ This defines types for custom Shopify elements supported by the target. + +import {expect, test, beforeEach, afterEach} from 'vitest'; +import {getExtension} from '@shopify/ui-extensions-tester'; +import {createCartLineItem} from '@shopify/ui-extensions-tester/point-of-sale'; + +const extension = getExtension('pos.home.modal.render'); + +beforeEach(() => { + extension.setUp(); +}); + +afterEach(() => { + extension.tearDown(); +}); + +test('shows "No items in cart" when the cart is empty', async () => { + await extension.render(); + + const firstText = document.body.querySelector('s-text')!; + expect(firstText.textContent).toEqual('No items in cart'); +}); + +test('shows each line item with its title and quantity', async () => { + extension.shopify.cart.current.value.lineItems = [ + createCartLineItem({title: 'Widget', quantity: 3}), + createCartLineItem({title: 'Gadget', quantity: 1}), + ]; + + await extension.render(); + + const textNodes = Array.from( + document.body.querySelectorAll('s-text'), + ); + const textContents = textNodes.map((t) => t.textContent); + expect(textContents).toContain('Widget'); + expect(textContents).toContain('Qty: 3'); + expect(textContents).toContain('Gadget'); + expect(textContents).toContain('Qty: 1'); +}); diff --git a/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/tests/Tile.test.ts b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/tests/Tile.test.ts new file mode 100644 index 0000000000..1e9606e8a1 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/tests/Tile.test.ts @@ -0,0 +1,73 @@ +/// +// ^ This defines types for custom Shopify elements supported by the target. + +import {expect, test, vi, beforeEach, afterEach} from 'vitest'; +import {fireEvent, waitFor} from '@testing-library/preact'; +import {getExtension} from '@shopify/ui-extensions-tester'; +import {createCartLineItem} from '@shopify/ui-extensions-tester/point-of-sale'; + +const extension = getExtension('pos.home.tile.render'); + +beforeEach(() => { + extension.setUp(); +}); + +afterEach(() => { + extension.tearDown(); +}); + +test('shows "0 item(s)" when the cart is empty', async () => { + await extension.render(); + + const tile = document.body.querySelector('s-tile')!; + expect(tile.getAttribute('subheading')).toEqual('0 item(s)'); +}); + +test('shows the line item count when the cart has items', async () => { + extension.shopify.cart.current.value.lineItems = [ + createCartLineItem(), + createCartLineItem(), + ]; + + await extension.render(); + + const tile = document.body.querySelector('s-tile')!; + expect(tile.getAttribute('subheading')).toEqual('2 item(s)'); +}); + +test('calls action.presentModal when the tile is clicked', async () => { + const presentModal = vi.fn(); + extension.shopify.action.presentModal = presentModal; + + await extension.render(); + + const tile = document.body.querySelector('s-tile')!; + fireEvent.click(tile); + + await waitFor(() => { + expect(presentModal).toHaveBeenCalled(); + }); +}); + +test('increments all line item quantities via bulkCartUpdate on button click', async () => { + const widget = createCartLineItem({uuid: 'widget', quantity: 2}); + const gadget = createCartLineItem({uuid: 'gadget', quantity: 5}); + extension.shopify.cart.current.value.lineItems = [widget, gadget]; + const bulkCartUpdate = vi.spyOn(extension.shopify.cart, 'bulkCartUpdate'); + + await extension.render(); + + const button = document.body.querySelector('s-button')!; + fireEvent.click(button); + + await waitFor(() => { + expect(bulkCartUpdate).toHaveBeenCalledWith( + expect.objectContaining({ + lineItems: [ + expect.objectContaining({uuid: 'widget', quantity: 3}), + expect.objectContaining({uuid: 'gadget', quantity: 6}), + ], + }), + ); + }); +}); diff --git a/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/tsconfig.json b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/tsconfig.json new file mode 100644 index 0000000000..26ff642803 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/extensions/point-of-sale-testing-example/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "jsx": "react-jsx", + "jsxImportSource": "preact", + "target": "ES2020", + "checkJs": true, + "allowJs": true, + "moduleResolution": "node", + "esModuleInterop": true, + "noEmit": true, + "strict": true, + "skipLibCheck": true, + // Monorepo only: file: deps create symlinks that cause TS to + // resolve a different preact instance. Not needed with published packages. + "paths": { + "preact": ["../../node_modules/preact"], + "preact/*": ["../../node_modules/preact/*"] + } + }, + "include": ["./src", "./tests", "./shopify.d.ts"] +} diff --git a/examples/testing/point-of-sale-testing-example/package-lock.json b/examples/testing/point-of-sale-testing-example/package-lock.json new file mode 100644 index 0000000000..1fea4c0f37 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/package-lock.json @@ -0,0 +1,2853 @@ +{ + "name": "point-of-sale-testing-example", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "point-of-sale-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "dependencies": { + "@shopify/ui-extensions": "file:../../../packages/ui-extensions" + }, + "devDependencies": { + "@shopify/ui-extensions-tester": "file:../../../packages/ui-extensions-tester", + "@testing-library/preact": "^3.2.0", + "typescript": "^5.0.0", + "vitest": "^3.0.0" + } + }, + "../../../packages/ui-extensions": { + "name": "@shopify/ui-extensions", + "version": "2026.4.0-rc.2", + "license": "MIT", + "dependencies": { + "ts-morph": "^25.0.1" + }, + "devDependencies": { + "@faker-js/faker": "^8.4.1", + "@preact/signals": "^2.3.x", + "@quilted/react-testing": "^0.6.11", + "@remote-ui/async-subscription": "^2.1.16", + "@shopify/generate-docs": "https://registry.npmjs.org/@shopify/generate-docs/-/generate-docs-0.19.8.tgz", + "preact": "^10.10.x", + "typescript": "^4.9.0" + }, + "peerDependencies": { + "@preact/signals": "*", + "preact": "*" + }, + "peerDependenciesMeta": { + "@preact/signals": { + "optional": true + }, + "preact": { + "optional": true + } + } + }, + "../../../packages/ui-extensions-tester": { + "name": "@shopify/ui-extensions-tester", + "version": "2026.4.0-rc.2", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/ui-extensions": "2026.4.0-rc.2" + }, + "devDependencies": { + "typescript": "^4.9.0" + }, + "peerDependencies": { + "preact": "^10.0.0" + }, + "peerDependenciesMeta": { + "preact": { + "optional": true + } + } + }, + "node_modules/@babel/code-frame": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.28.5", + "js-tokens": "^4.0.0", + "picocolors": "^1.1.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/code-frame/node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/runtime": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.28.6.tgz", + "integrity": "sha512-05WQkdpL9COIMz4LjTxGpPNCdlpyimKppYNoJ5Di5EUObifl8t4tuLuUBBZEpoLYOmfvIWrsp9fCl0HoPRVTdA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.3.tgz", + "integrity": "sha512-9fJMTNFTWZMh5qwrBItuziu834eOCUcEqymSH7pY+zoMVEZg3gcPuBNxH1EvfVYe9h0x/Ptw8KBzv7qxb7l8dg==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.3.tgz", + "integrity": "sha512-i5D1hPY7GIQmXlXhs2w8AWHhenb00+GxjxRncS2ZM7YNVGNfaMxgzSGuO8o8SJzRc/oZwU2bcScvVERk03QhzA==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.3.tgz", + "integrity": "sha512-YdghPYUmj/FX2SYKJ0OZxf+iaKgMsKHVPF1MAq/P8WirnSpCStzKJFjOjzsW0QQ7oIAiccHdcqjbHmJxRb/dmg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.3.tgz", + "integrity": "sha512-IN/0BNTkHtk8lkOM8JWAYFg4ORxBkZQf9zXiEOfERX/CzxW3Vg1ewAhU7QSWQpVIzTW+b8Xy+lGzdYXV6UZObQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.3.tgz", + "integrity": "sha512-Re491k7ByTVRy0t3EKWajdLIr0gz2kKKfzafkth4Q8A5n1xTHrkqZgLLjFEHVD+AXdUGgQMq+Godfq45mGpCKg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.3.tgz", + "integrity": "sha512-vHk/hA7/1AckjGzRqi6wbo+jaShzRowYip6rt6q7VYEDX4LEy1pZfDpdxCBnGtl+A5zq8iXDcyuxwtv3hNtHFg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.3.tgz", + "integrity": "sha512-ipTYM2fjt3kQAYOvo6vcxJx3nBYAzPjgTCk7QEgZG8AUO3ydUhvelmhrbOheMnGOlaSFUoHXB6un+A7q4ygY9w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.3.tgz", + "integrity": "sha512-dDk0X87T7mI6U3K9VjWtHOXqwAMJBNN2r7bejDsc+j03SEjtD9HrOl8gVFByeM0aJksoUuUVU9TBaZa2rgj0oA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.3.tgz", + "integrity": "sha512-s6nPv2QkSupJwLYyfS+gwdirm0ukyTFNl3KTgZEAiJDd+iHZcbTPPcWCcRYH+WlNbwChgH2QkE9NSlNrMT8Gfw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.3.tgz", + "integrity": "sha512-sZOuFz/xWnZ4KH3YfFrKCf1WyPZHakVzTiqji3WDc0BCl2kBwiJLCXpzLzUBLgmp4veFZdvN5ChW4Eq/8Fc2Fg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.3.tgz", + "integrity": "sha512-yGlQYjdxtLdh0a3jHjuwOrxQjOZYD/C9PfdbgJJF3TIZWnm/tMd/RcNiLngiu4iwcBAOezdnSLAwQDPqTmtTYg==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.3.tgz", + "integrity": "sha512-WO60Sn8ly3gtzhyjATDgieJNet/KqsDlX5nRC5Y3oTFcS1l0KWba+SEa9Ja1GfDqSF1z6hif/SkpQJbL63cgOA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.3.tgz", + "integrity": "sha512-APsymYA6sGcZ4pD6k+UxbDjOFSvPWyZhjaiPyl/f79xKxwTnrn5QUnXR5prvetuaSMsb4jgeHewIDCIWljrSxw==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.3.tgz", + "integrity": "sha512-eizBnTeBefojtDb9nSh4vvVQ3V9Qf9Df01PfawPcRzJH4gFSgrObw+LveUyDoKU3kxi5+9RJTCWlj4FjYXVPEA==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.3.tgz", + "integrity": "sha512-3Emwh0r5wmfm3ssTWRQSyVhbOHvqegUDRd0WhmXKX2mkHJe1SFCMJhagUleMq+Uci34wLSipf8Lagt4LlpRFWQ==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.3.tgz", + "integrity": "sha512-pBHUx9LzXWBc7MFIEEL0yD/ZVtNgLytvx60gES28GcWMqil8ElCYR4kvbV2BDqsHOvVDRrOxGySBM9Fcv744hw==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.3.tgz", + "integrity": "sha512-Czi8yzXUWIQYAtL/2y6vogER8pvcsOsk5cpwL4Gk5nJqH5UZiVByIY8Eorm5R13gq+DQKYg0+JyQoytLQas4dA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.3.tgz", + "integrity": "sha512-sDpk0RgmTCR/5HguIZa9n9u+HVKf40fbEUt+iTzSnCaGvY9kFP0YKBWZtJaraonFnqef5SlJ8/TiPAxzyS+UoA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.3.tgz", + "integrity": "sha512-P14lFKJl/DdaE00LItAukUdZO5iqNH7+PjoBm+fLQjtxfcfFE20Xf5CrLsmZdq5LFFZzb5JMZ9grUwvtVYzjiA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.3.tgz", + "integrity": "sha512-AIcMP77AvirGbRl/UZFTq5hjXK+2wC7qFRGoHSDrZ5v5b8DK/GYpXW3CPRL53NkvDqb9D+alBiC/dV0Fb7eJcw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.3.tgz", + "integrity": "sha512-DnW2sRrBzA+YnE70LKqnM3P+z8vehfJWHXECbwBmH/CU51z6FiqTQTHFenPlHmo3a8UgpLyH3PT+87OViOh1AQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.3.tgz", + "integrity": "sha512-NinAEgr/etERPTsZJ7aEZQvvg/A6IsZG/LgZy+81wON2huV7SrK3e63dU0XhyZP4RKGyTm7aOgmQk0bGp0fy2g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.3.tgz", + "integrity": "sha512-PanZ+nEz+eWoBJ8/f8HKxTTD172SKwdXebZ0ndd953gt1HRBbhMsaNqjTyYLGLPdoWHy4zLU7bDVJztF5f3BHA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.3.tgz", + "integrity": "sha512-B2t59lWWYrbRDw/tjiWOuzSsFh1Y/E95ofKz7rIVYSQkUYBjfSgf6oeYPNWHToFRr2zx52JKApIcAS/D5TUBnA==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.3.tgz", + "integrity": "sha512-QLKSFeXNS8+tHW7tZpMtjlNb7HKau0QDpwm49u0vUp9y1WOF+PEzkU84y9GqYaAVW8aH8f3GcBck26jh54cX4Q==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.3.tgz", + "integrity": "sha512-4uJGhsxuptu3OcpVAzli+/gWusVGwZZHTlS63hh++ehExkVT8SgiEf7/uC/PclrPPkLhZqGgCTjd0VWLo6xMqA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "dev": true, + "license": "MIT" + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.57.1.tgz", + "integrity": "sha512-A6ehUVSiSaaliTxai040ZpZ2zTevHYbvu/lDoeAteHI8QnaosIzm4qwtezfRg1jOYaUmnzLX1AOD6Z+UJjtifg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.57.1.tgz", + "integrity": "sha512-dQaAddCY9YgkFHZcFNS/606Exo8vcLHwArFZ7vxXq4rigo2bb494/xKMMwRRQW6ug7Js6yXmBZhSBRuBvCCQ3w==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.57.1.tgz", + "integrity": "sha512-crNPrwJOrRxagUYeMn/DZwqN88SDmwaJ8Cvi/TN1HnWBU7GwknckyosC2gd0IqYRsHDEnXf328o9/HC6OkPgOg==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.57.1.tgz", + "integrity": "sha512-Ji8g8ChVbKrhFtig5QBV7iMaJrGtpHelkB3lsaKzadFBe58gmjfGXAOfI5FV0lYMH8wiqsxKQ1C9B0YTRXVy4w==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.57.1.tgz", + "integrity": "sha512-R+/WwhsjmwodAcz65guCGFRkMb4gKWTcIeLy60JJQbXrJ97BOXHxnkPFrP+YwFlaS0m+uWJTstrUA9o+UchFug==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.57.1.tgz", + "integrity": "sha512-IEQTCHeiTOnAUC3IDQdzRAGj3jOAYNr9kBguI7MQAAZK3caezRrg0GxAb6Hchg4lxdZEI5Oq3iov/w/hnFWY9Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.57.1.tgz", + "integrity": "sha512-F8sWbhZ7tyuEfsmOxwc2giKDQzN3+kuBLPwwZGyVkLlKGdV1nvnNwYD0fKQ8+XS6hp9nY7B+ZeK01EBUE7aHaw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.57.1.tgz", + "integrity": "sha512-rGfNUfn0GIeXtBP1wL5MnzSj98+PZe/AXaGBCRmT0ts80lU5CATYGxXukeTX39XBKsxzFpEeK+Mrp9faXOlmrw==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.57.1.tgz", + "integrity": "sha512-MMtej3YHWeg/0klK2Qodf3yrNzz6CGjo2UntLvk2RSPlhzgLvYEB3frRvbEF2wRKh1Z2fDIg9KRPe1fawv7C+g==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.57.1.tgz", + "integrity": "sha512-1a/qhaaOXhqXGpMFMET9VqwZakkljWHLmZOX48R0I/YLbhdxr1m4gtG1Hq7++VhVUmf+L3sTAf9op4JlhQ5u1Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.57.1.tgz", + "integrity": "sha512-QWO6RQTZ/cqYtJMtxhkRkidoNGXc7ERPbZN7dVW5SdURuLeVU7lwKMpo18XdcmpWYd0qsP1bwKPf7DNSUinhvA==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.57.1.tgz", + "integrity": "sha512-xpObYIf+8gprgWaPP32xiN5RVTi/s5FCR+XMXSKmhfoJjrpRAjCuuqQXyxUa/eJTdAE6eJ+KDKaoEqjZQxh3Gw==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.57.1.tgz", + "integrity": "sha512-4BrCgrpZo4hvzMDKRqEaW1zeecScDCR+2nZ86ATLhAoJ5FQ+lbHVD3ttKe74/c7tNT9c6F2viwB3ufwp01Oh2w==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.57.1.tgz", + "integrity": "sha512-NOlUuzesGauESAyEYFSe3QTUguL+lvrN1HtwEEsU2rOwdUDeTMJdO5dUYl/2hKf9jWydJrO9OL/XSSf65R5+Xw==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.57.1.tgz", + "integrity": "sha512-ptA88htVp0AwUUqhVghwDIKlvJMD/fmL/wrQj99PRHFRAG6Z5nbWoWG4o81Nt9FT+IuqUQi+L31ZKAFeJ5Is+A==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.57.1.tgz", + "integrity": "sha512-S51t7aMMTNdmAMPpBg7OOsTdn4tySRQvklmL3RpDRyknk87+Sp3xaumlatU+ppQ+5raY7sSTcC2beGgvhENfuw==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.57.1.tgz", + "integrity": "sha512-Bl00OFnVFkL82FHbEqy3k5CUCKH6OEJL54KCyx2oqsmZnFTR8IoNqBF+mjQVcRCT5sB6yOvK8A37LNm/kPJiZg==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.57.1.tgz", + "integrity": "sha512-ABca4ceT4N+Tv/GtotnWAeXZUZuM/9AQyCyKYyKnpk4yoA7QIAuBt6Hkgpw8kActYlew2mvckXkvx0FfoInnLg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.57.1.tgz", + "integrity": "sha512-HFps0JeGtuOR2convgRRkHCekD7j+gdAuXM+/i6kGzQtFhlCtQkpwtNzkNj6QhCDp7DRJ7+qC/1Vg2jt5iSOFw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.57.1.tgz", + "integrity": "sha512-H+hXEv9gdVQuDTgnqD+SQffoWoc0Of59AStSzTEj/feWTBAnSfSD3+Dql1ZruJQxmykT/JVY0dE8Ka7z0DH1hw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.57.1.tgz", + "integrity": "sha512-4wYoDpNg6o/oPximyc/NG+mYUejZrCU2q+2w6YZqrAs2UcNUChIZXjtafAiiZSUc7On8v5NyNj34Kzj/Ltk6dQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.57.1.tgz", + "integrity": "sha512-O54mtsV/6LW3P8qdTcamQmuC990HDfR71lo44oZMZlXU4tzLrbvTii87Ni9opq60ds0YzuAlEr/GNwuNluZyMQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.57.1.tgz", + "integrity": "sha512-P3dLS+IerxCT/7D2q2FYcRdWRl22dNbrbBEtxdWhXrfIMPP9lQhb5h4Du04mdl5Woq05jVCDPCMF7Ub0NAjIew==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.57.1.tgz", + "integrity": "sha512-VMBH2eOOaKGtIJYleXsi2B8CPVADrh+TyNxJ4mWPnKfLB/DBUmzW+5m1xUrcwWoMfSLagIRpjUFeW5CO5hyciQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.57.1.tgz", + "integrity": "sha512-mxRFDdHIWRxg3UfIIAwCm6NzvxG0jDX/wBN6KsQFTvKFqqg9vTrWUE68qEjHt19A5wwx5X5aUi2zuZT7YR0jrA==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@shopify/ui-extensions": { + "resolved": "../../../packages/ui-extensions", + "link": true + }, + "node_modules/@shopify/ui-extensions-tester": { + "resolved": "../../../packages/ui-extensions-tester", + "link": true + }, + "node_modules/@testing-library/dom": { + "version": "8.20.1", + "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-8.20.1.tgz", + "integrity": "sha512-/DiOQ5xBxgdYRC8LNk7U+RWat0S3qRLeIw3ZIkMQ9kkVlRmwD/Eg8k8CqIpD6GW7u20JIUOfMKbxtiLutpjQ4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.10.4", + "@babel/runtime": "^7.12.5", + "@types/aria-query": "^5.0.1", + "aria-query": "5.1.3", + "chalk": "^4.1.0", + "dom-accessibility-api": "^0.5.9", + "lz-string": "^1.5.0", + "pretty-format": "^27.0.2" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@testing-library/preact": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@testing-library/preact/-/preact-3.2.4.tgz", + "integrity": "sha512-F+kJ243LP6VmEK1M809unzTE/ijg+bsMNuiRN0JEDIJBELKKDNhdgC/WrUSZ7klwJvtlO3wQZ9ix+jhObG07Fg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@testing-library/dom": "^8.11.1" + }, + "engines": { + "node": ">= 12" + }, + "peerDependencies": { + "preact": ">=10 || ^10.0.0-alpha.0 || ^10.0.0-beta.0" + } + }, + "node_modules/@types/aria-query": { + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", + "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/chai": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", + "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/deep-eql": "*", + "assertion-error": "^2.0.1" + } + }, + "node_modules/@types/deep-eql": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", + "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@vitest/expect": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.2.4.tgz", + "integrity": "sha512-Io0yyORnB6sikFlt8QW5K7slY4OjqNX9jmJQ02QDda8lyM6B5oNgVWoSoKPac8/kgnCUzuHQKrSLtu/uOqqrig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/mocker": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.2.4.tgz", + "integrity": "sha512-46ryTE9RZO/rfDd7pEqFl7etuyzekzEhUbTW3BvmeO/BcCMEgq59BKhek3dXDWgAj4oMK6OZi+vRr1wPW6qjEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "3.2.4", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.17" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "msw": "^2.4.9", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } + } + }, + "node_modules/@vitest/pretty-format": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.2.4.tgz", + "integrity": "sha512-IVNZik8IVRJRTr9fxlitMKeJeXFFFN0JaB9PHPGQ8NKQbGpfjlTx9zO4RefN8gp7eqjNy8nyK3NZmBzOPeIxtA==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/runner": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.2.4.tgz", + "integrity": "sha512-oukfKT9Mk41LreEW09vt45f8wx7DordoWUZMYdY/cyAk7w5TWkTRCNZYF7sX7n2wB7jyGAl74OxgwhPgKaqDMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/utils": "3.2.4", + "pathe": "^2.0.3", + "strip-literal": "^3.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/snapshot": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.2.4.tgz", + "integrity": "sha512-dEYtS7qQP2CjU27QBC5oUOxLE/v5eLkGqPE0ZKEIDGMs4vKWe7IjgLOeauHsR0D5YuuycGRO5oSRXnwnmA78fQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "magic-string": "^0.30.17", + "pathe": "^2.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/spy": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.2.4.tgz", + "integrity": "sha512-vAfasCOe6AIK70iP5UD11Ac4siNUNJ9i/9PZ3NKx07sG6sUxeag1LWdNrMWeKKYBLlzuK+Gn65Yd5nyL6ds+nw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tinyspy": "^4.0.3" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/@vitest/utils": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.2.4.tgz", + "integrity": "sha512-fB2V0JFrQSMsCo9HiSq3Ezpdv4iYaXRG1Sx8edX3MwxfyNn83mKiGzOcH+Fkxt4MHxr3y42fQi1oeAInqgX2QA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/pretty-format": "3.2.4", + "loupe": "^3.1.4", + "tinyrainbow": "^2.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/aria-query": { + "version": "5.1.3", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.1.3.tgz", + "integrity": "sha512-R5iJ5lkuHybztUfuOAznmboyjWq8O6sqNqtK7CLOqdydi54VNbORp49mb14KbWgG1QD3JFO9hJdZ+y4KutfdOQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "deep-equal": "^2.0.5" + } + }, + "node_modules/array-buffer-byte-length": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.2.tgz", + "integrity": "sha512-LHE+8BuR7RYGDKvnrmcuSq3tDcKv9OFEXQt/HpbZhY7V6h0zlUXutnAD82GiFx9rdieCMjkvtcsPqBwgUl1Iiw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "is-array-buffer": "^3.0.5" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/assertion-error": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", + "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + } + }, + "node_modules/available-typed-arrays": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/cac": { + "version": "6.7.14", + "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", + "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/call-bind": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", + "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.0", + "es-define-property": "^1.0.0", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/call-bind-apply-helpers": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", + "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/call-bound": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", + "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "get-intrinsic": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/chai": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/chai/-/chai-5.3.3.tgz", + "integrity": "sha512-4zNhdJD/iOjSH0A05ea+Ke6MU5mmpQcbQsSOkgdaUMJ9zTlDTD/GYlwohmIE2u0gaxHYiVHEn1Fw9mZ/ktJWgw==", + "dev": true, + "license": "MIT", + "dependencies": { + "assertion-error": "^2.0.1", + "check-error": "^2.1.1", + "deep-eql": "^5.0.1", + "loupe": "^3.1.0", + "pathval": "^2.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/check-error": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.3.tgz", + "integrity": "sha512-PAJdDJusoxnwm1VwW07VWwUN1sl7smmC3OKggvndJFadxxDRyFJBX/ggnu/KE4kQAB7a3Dp8f/YXC1FlUprWmA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 16" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, + "node_modules/debug": { + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.3" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/deep-eql": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", + "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/deep-equal": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-2.2.3.tgz", + "integrity": "sha512-ZIwpnevOurS8bpT4192sqAowWM76JDKSHYzMLty3BZGSswgq6pBaH3DhCSW5xVAZICZyKdOBPjwww5wfgT/6PA==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.0", + "call-bind": "^1.0.5", + "es-get-iterator": "^1.1.3", + "get-intrinsic": "^1.2.2", + "is-arguments": "^1.1.1", + "is-array-buffer": "^3.0.2", + "is-date-object": "^1.0.5", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.2", + "isarray": "^2.0.5", + "object-is": "^1.1.5", + "object-keys": "^1.1.1", + "object.assign": "^4.1.4", + "regexp.prototype.flags": "^1.5.1", + "side-channel": "^1.0.4", + "which-boxed-primitive": "^1.0.2", + "which-collection": "^1.0.1", + "which-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/dom-accessibility-api": { + "version": "0.5.16", + "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.5.16.tgz", + "integrity": "sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==", + "dev": true, + "license": "MIT" + }, + "node_modules/dunder-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", + "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.1", + "es-errors": "^1.3.0", + "gopd": "^1.2.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-define-property": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", + "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-get-iterator": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.3.tgz", + "integrity": "sha512-sPZmqHBe6JIiTfN5q2pEi//TwxmAFHwj/XEuYjTuse78i8KxaqMTTzxPoFKuzRpDpTJ+0NAbpfenkmH2rePtuw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.3", + "has-symbols": "^1.0.3", + "is-arguments": "^1.1.1", + "is-map": "^2.0.2", + "is-set": "^2.0.2", + "is-string": "^1.0.7", + "isarray": "^2.0.5", + "stop-iteration-iterator": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-module-lexer": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", + "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "dev": true, + "license": "MIT" + }, + "node_modules/es-object-atoms": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", + "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/esbuild": { + "version": "0.27.3", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.3.tgz", + "integrity": "sha512-8VwMnyGCONIs6cWue2IdpHxHnAjzxnw2Zr7MkVxB2vjmQ2ivqGFb4LEG3SMnv0Gb2F/G/2yA8zUaiL1gywDCCg==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.27.3", + "@esbuild/android-arm": "0.27.3", + "@esbuild/android-arm64": "0.27.3", + "@esbuild/android-x64": "0.27.3", + "@esbuild/darwin-arm64": "0.27.3", + "@esbuild/darwin-x64": "0.27.3", + "@esbuild/freebsd-arm64": "0.27.3", + "@esbuild/freebsd-x64": "0.27.3", + "@esbuild/linux-arm": "0.27.3", + "@esbuild/linux-arm64": "0.27.3", + "@esbuild/linux-ia32": "0.27.3", + "@esbuild/linux-loong64": "0.27.3", + "@esbuild/linux-mips64el": "0.27.3", + "@esbuild/linux-ppc64": "0.27.3", + "@esbuild/linux-riscv64": "0.27.3", + "@esbuild/linux-s390x": "0.27.3", + "@esbuild/linux-x64": "0.27.3", + "@esbuild/netbsd-arm64": "0.27.3", + "@esbuild/netbsd-x64": "0.27.3", + "@esbuild/openbsd-arm64": "0.27.3", + "@esbuild/openbsd-x64": "0.27.3", + "@esbuild/openharmony-arm64": "0.27.3", + "@esbuild/sunos-x64": "0.27.3", + "@esbuild/win32-arm64": "0.27.3", + "@esbuild/win32-ia32": "0.27.3", + "@esbuild/win32-x64": "0.27.3" + } + }, + "node_modules/estree-walker": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", + "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0" + } + }, + "node_modules/expect-type": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", + "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/for-each": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.5.tgz", + "integrity": "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.2.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-intrinsic": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", + "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind-apply-helpers": "^1.0.2", + "es-define-property": "^1.0.1", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.1.1", + "function-bind": "^1.1.2", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-symbols": "^1.1.0", + "hasown": "^2.0.2", + "math-intrinsics": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-proto": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", + "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "dev": true, + "license": "MIT", + "dependencies": { + "dunder-proto": "^1.0.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/gopd": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-bigints": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", + "integrity": "sha512-R3pbpkcIqv2Pm3dUwgjclDRVmWpTJW2DcMzcIhEXEx1oh/CEMObMm3KLmRJOdvhM7o4uQBnwr8pzRK2sJWIqfg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", + "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/internal-slot": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", + "integrity": "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "hasown": "^2.0.2", + "side-channel": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-arguments": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.2.0.tgz", + "integrity": "sha512-7bVbi0huj/wrIAOzb8U1aszg9kdi3KN/CyU19CTI7tAoZYEZoL9yCDXpbXN+uPsuWnP02cyug1gleqq+TU+YCA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-array-buffer": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.5.tgz", + "integrity": "sha512-DDfANUiiG2wC1qawP66qlTugJeL5HyzMpfr8lLK+jMQirGzNod0B12cFB/9q838Ru27sBwfw78/rdoU7RERz6A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-bigint": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.1.0.tgz", + "integrity": "sha512-n4ZT37wG78iz03xPRKJrHTdZbe3IicyucEtdRsV5yglwc3GyUfbAfpSeD0FJ41NbUNSt5wbhqfp1fS+BgnvDFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-bigints": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-boolean-object": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.2.2.tgz", + "integrity": "sha512-wa56o2/ElJMYqjCjGkXri7it5FbebW5usLw/nPmCMs5DeZ7eziSYZhSmPRn0txqeW4LnAmQQU7FgqLpsEFKM4A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-callable": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.1.0.tgz", + "integrity": "sha512-PwwhEakHVKTdRNVOw+/Gyh0+MzlCl4R6qKvkhuvLtPMggI1WAHt9sOwZxQLSGpUaDnrdyDsomoRgNnCfKNSXXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-map": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", + "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number-object": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.1.1.tgz", + "integrity": "sha512-lZhclumE1G6VYD8VHe35wFaIif+CTy5SJIi5+3y4psDgWu4wPDoBhF8NxUOinEc7pHgiTsT6MaBb92rKhhD+Xw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-regex": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.2.1.tgz", + "integrity": "sha512-MjYsKHO5O7mCsmRGxWcLWheFqN9DJ/2TmngvjKXihe6efViPqc274+Fx/4fYj/r03+ESvBdTXK0V6tA3rgez1g==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-set": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", + "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.4.tgz", + "integrity": "sha512-ISWac8drv4ZGfwKl5slpHG9OwPNty4jOWPRIhBpxOoD+hqITiwuipOQ2bNthAzwA3B4fIjO4Nln74N0S9byq8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-string": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.1.1.tgz", + "integrity": "sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-symbol": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.1.1.tgz", + "integrity": "sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "has-symbols": "^1.1.0", + "safe-regex-test": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakmap": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", + "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakset": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.4.tgz", + "integrity": "sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.3", + "get-intrinsic": "^1.2.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "license": "MIT" + }, + "node_modules/js-tokens": { + "version": "9.0.1", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz", + "integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/loupe": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.2.1.tgz", + "integrity": "sha512-CdzqowRJCeLU72bHvWqwRBBlLcMEtIvGrlvef74kMnV2AolS9Y8xUv1I0U/MNAWMhBlKIoyuEgoJ0t/bbwHbLQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/lz-string": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", + "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", + "dev": true, + "license": "MIT", + "bin": { + "lz-string": "bin/bin.js" + } + }, + "node_modules/magic-string": { + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.5" + } + }, + "node_modules/math-intrinsics": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", + "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true, + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/object-inspect": { + "version": "1.13.4", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", + "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-is": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", + "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.7", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", + "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "call-bound": "^1.0.3", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0", + "has-symbols": "^1.1.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/pathe": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", + "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", + "dev": true, + "license": "MIT" + }, + "node_modules/pathval": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.1.tgz", + "integrity": "sha512-//nshmD55c46FuFw26xV/xFAaB5HF9Xdap7HJBBnrKdAd6/GxDBaNA1870O79+9ueg61cZLSVc+OaFlfmObYVQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 14.16" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/possible-typed-array-names": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", + "integrity": "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/postcss": { + "version": "8.5.6", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.6.tgz", + "integrity": "sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/preact": { + "version": "10.28.3", + "resolved": "https://registry.npmjs.org/preact/-/preact-10.28.3.tgz", + "integrity": "sha512-tCmoRkPQLpBeWzpmbhryairGnhW9tKV6c6gr/w+RhoRoKEJwsjzipwp//1oCpGPOchvSLaAPlpcJi9MwMmoPyA==", + "dev": true, + "license": "MIT", + "peer": true, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/pretty-format": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", + "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^17.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/pretty-format/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/react-is": { + "version": "17.0.2", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", + "dev": true, + "license": "MIT" + }, + "node_modules/regexp.prototype.flags": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", + "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.8", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "set-function-name": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/rollup": { + "version": "4.57.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.57.1.tgz", + "integrity": "sha512-oQL6lgK3e2QZeQ7gcgIkS2YZPg5slw37hYufJ3edKlfQSGGm8ICoxswK15ntSzF/a8+h7ekRy7k7oWc3BQ7y8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.57.1", + "@rollup/rollup-android-arm64": "4.57.1", + "@rollup/rollup-darwin-arm64": "4.57.1", + "@rollup/rollup-darwin-x64": "4.57.1", + "@rollup/rollup-freebsd-arm64": "4.57.1", + "@rollup/rollup-freebsd-x64": "4.57.1", + "@rollup/rollup-linux-arm-gnueabihf": "4.57.1", + "@rollup/rollup-linux-arm-musleabihf": "4.57.1", + "@rollup/rollup-linux-arm64-gnu": "4.57.1", + "@rollup/rollup-linux-arm64-musl": "4.57.1", + "@rollup/rollup-linux-loong64-gnu": "4.57.1", + "@rollup/rollup-linux-loong64-musl": "4.57.1", + "@rollup/rollup-linux-ppc64-gnu": "4.57.1", + "@rollup/rollup-linux-ppc64-musl": "4.57.1", + "@rollup/rollup-linux-riscv64-gnu": "4.57.1", + "@rollup/rollup-linux-riscv64-musl": "4.57.1", + "@rollup/rollup-linux-s390x-gnu": "4.57.1", + "@rollup/rollup-linux-x64-gnu": "4.57.1", + "@rollup/rollup-linux-x64-musl": "4.57.1", + "@rollup/rollup-openbsd-x64": "4.57.1", + "@rollup/rollup-openharmony-arm64": "4.57.1", + "@rollup/rollup-win32-arm64-msvc": "4.57.1", + "@rollup/rollup-win32-ia32-msvc": "4.57.1", + "@rollup/rollup-win32-x64-gnu": "4.57.1", + "@rollup/rollup-win32-x64-msvc": "4.57.1", + "fsevents": "~2.3.2" + } + }, + "node_modules/safe-regex-test": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.1.0.tgz", + "integrity": "sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "is-regex": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/side-channel": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", + "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3", + "side-channel-list": "^1.0.0", + "side-channel-map": "^1.0.1", + "side-channel-weakmap": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-list": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", + "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-map": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", + "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/side-channel-weakmap": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", + "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bound": "^1.0.2", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.5", + "object-inspect": "^1.13.3", + "side-channel-map": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/siginfo": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", + "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", + "dev": true, + "license": "ISC" + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stackback": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", + "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", + "dev": true, + "license": "MIT" + }, + "node_modules/std-env": { + "version": "3.10.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz", + "integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==", + "dev": true, + "license": "MIT" + }, + "node_modules/stop-iteration-iterator": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz", + "integrity": "sha512-eLoXW/DHyl62zxY4SCaIgnRhuMr6ri4juEYARS8E6sCEqzKpOiE521Ucofdx+KnDZl5xmvGYaaKCk5FEOxJCoQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "internal-slot": "^1.1.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/strip-literal": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-3.1.0.tgz", + "integrity": "sha512-8r3mkIM/2+PpjHoOtiAW8Rg3jJLHaV7xPwG+YRGrv6FP0wwk/toTpATxWYOW0BKdWwl82VT2tFYi5DlROa0Mxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "js-tokens": "^9.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/antfu" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/tinybench": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", + "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyexec": { + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", + "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyglobby": { + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "fdir": "^6.5.0", + "picomatch": "^4.0.3" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/tinypool": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", + "integrity": "sha512-Zba82s87IFq9A9XmjiX5uZA/ARWDrB03OHlq+Vw1fSdt0I+4/Kutwy8BP4Y/y/aORMo61FQ0vIb5j44vSo5Pkg==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^18.0.0 || >=20.0.0" + } + }, + "node_modules/tinyrainbow": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", + "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/tinyspy": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-4.0.4.tgz", + "integrity": "sha512-azl+t0z7pw/z958Gy9svOTuzqIk6xq+NSheJzn5MMWtWTFywIacg2wUlzKFGtt3cthx0r2SxMK0yzJOR0IES7Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/vite": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.1.tgz", + "integrity": "sha512-w+N7Hifpc3gRjZ63vYBXA56dvvRlNWRczTdmCBBa+CotUzAPf5b7YMdMR/8CQoeYE5LX3W4wj6RYTgonm1b9DA==", + "dev": true, + "license": "MIT", + "dependencies": { + "esbuild": "^0.27.0", + "fdir": "^6.5.0", + "picomatch": "^4.0.3", + "postcss": "^8.5.6", + "rollup": "^4.43.0", + "tinyglobby": "^0.2.15" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^20.19.0 || >=22.12.0", + "jiti": ">=1.21.0", + "less": "^4.0.0", + "lightningcss": "^1.21.0", + "sass": "^1.70.0", + "sass-embedded": "^1.70.0", + "stylus": ">=0.54.8", + "sugarss": "^5.0.0", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vite-node": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.2.4.tgz", + "integrity": "sha512-EbKSKh+bh1E1IFxeO0pg1n4dvoOTt0UDiXMd/qn++r98+jPO1xtJilvXldeuQ8giIB5IkpjCgMleHMNEsGH6pg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cac": "^6.7.14", + "debug": "^4.4.1", + "es-module-lexer": "^1.7.0", + "pathe": "^2.0.3", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0" + }, + "bin": { + "vite-node": "vite-node.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + } + }, + "node_modules/vitest": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", + "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/chai": "^5.2.2", + "@vitest/expect": "3.2.4", + "@vitest/mocker": "3.2.4", + "@vitest/pretty-format": "^3.2.4", + "@vitest/runner": "3.2.4", + "@vitest/snapshot": "3.2.4", + "@vitest/spy": "3.2.4", + "@vitest/utils": "3.2.4", + "chai": "^5.2.0", + "debug": "^4.4.1", + "expect-type": "^1.2.1", + "magic-string": "^0.30.17", + "pathe": "^2.0.3", + "picomatch": "^4.0.2", + "std-env": "^3.9.0", + "tinybench": "^2.9.0", + "tinyexec": "^0.3.2", + "tinyglobby": "^0.2.14", + "tinypool": "^1.1.1", + "tinyrainbow": "^2.0.0", + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0-0", + "vite-node": "3.2.4", + "why-is-node-running": "^2.3.0" + }, + "bin": { + "vitest": "vitest.mjs" + }, + "engines": { + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@edge-runtime/vm": "*", + "@types/debug": "^4.1.12", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@vitest/browser": "3.2.4", + "@vitest/ui": "3.2.4", + "happy-dom": "*", + "jsdom": "*" + }, + "peerDependenciesMeta": { + "@edge-runtime/vm": { + "optional": true + }, + "@types/debug": { + "optional": true + }, + "@types/node": { + "optional": true + }, + "@vitest/browser": { + "optional": true + }, + "@vitest/ui": { + "optional": true + }, + "happy-dom": { + "optional": true + }, + "jsdom": { + "optional": true + } + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.1.1.tgz", + "integrity": "sha512-TbX3mj8n0odCBFVlY8AxkqcHASw3L60jIuF8jFP78az3C2YhmGvqbHBpAjTRH2/xqYunrJ9g1jSyjCjpoWzIAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-bigint": "^1.1.0", + "is-boolean-object": "^1.2.1", + "is-number-object": "^1.1.1", + "is-string": "^1.1.1", + "is-symbol": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-collection": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", + "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-map": "^2.0.3", + "is-set": "^2.0.3", + "is-weakmap": "^2.0.2", + "is-weakset": "^2.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-typed-array": { + "version": "1.1.20", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.20.tgz", + "integrity": "sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", + "for-each": "^0.3.5", + "get-proto": "^1.0.1", + "gopd": "^1.2.0", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/why-is-node-running": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", + "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", + "dev": true, + "license": "MIT", + "dependencies": { + "siginfo": "^2.0.0", + "stackback": "0.0.2" + }, + "bin": { + "why-is-node-running": "cli.js" + }, + "engines": { + "node": ">=8" + } + } + } +} diff --git a/examples/testing/point-of-sale-testing-example/package.json b/examples/testing/point-of-sale-testing-example/package.json new file mode 100644 index 0000000000..bb88af3019 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/package.json @@ -0,0 +1,29 @@ +{ + "name": "point-of-sale-testing-example", + "version": "1.0.0", + "license": "UNLICENSED", + "private": true, + "scripts": { + "shopify": "shopify", + "build": "shopify app build", + "dev": "shopify app dev", + "info": "shopify app info", + "generate": "shopify app generate", + "deploy": "shopify app deploy", + "test": "vitest run", + "typecheck": "tsc --noEmit --project extensions/point-of-sale-testing-example/tsconfig.json" + }, + "dependencies": { + "@shopify/ui-extensions": "file:../../../packages/ui-extensions" + }, + "devDependencies": { + "@shopify/ui-extensions-tester": "file:../../../packages/ui-extensions-tester", + "@testing-library/preact": "^3.2.0", + "typescript": "^5.0.0", + "vitest": "^3.0.0" + }, + "trustedDependencies": [ + "@shopify/plugin-cloudflare" + ], + "author": "kumar" +} diff --git a/examples/testing/point-of-sale-testing-example/shopify.app.toml b/examples/testing/point-of-sale-testing-example/shopify.app.toml new file mode 100644 index 0000000000..ded91385ee --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/shopify.app.toml @@ -0,0 +1,20 @@ +# Learn more about configuring your app at https://shopify.dev/docs/apps/tools/cli/configuration + +client_id = "528cbcda5989f92eb2e3b95acde92d82" +name = "point-of-sale-testing-example" +application_url = "https://shopify.dev/apps/default-app-home" +embedded = true + +[build] +automatically_update_urls_on_dev = true +include_config_on_deploy = true + +[webhooks] +api_version = "2026-04" + +[access_scopes] +# Learn more at https://shopify.dev/docs/apps/tools/cli/configuration#access_scopes +scopes = "" + +[auth] +redirect_urls = [ "https://shopify.dev/apps/default-app-home/api/auth" ] diff --git a/examples/testing/point-of-sale-testing-example/vitest.config.ts b/examples/testing/point-of-sale-testing-example/vitest.config.ts new file mode 100644 index 0000000000..ab3376a661 --- /dev/null +++ b/examples/testing/point-of-sale-testing-example/vitest.config.ts @@ -0,0 +1,20 @@ +import path from 'path'; +import {defineConfig} from 'vitest/config'; + +const extensionModules = path.resolve( + __dirname, + 'extensions/point-of-sale-testing-example/node_modules', +); + +export default defineConfig({ + esbuild: { + jsx: 'automatic', + jsxImportSource: 'preact', + }, + resolve: { + modules: [extensionModules, 'node_modules'], + }, + test: { + environment: 'jsdom', + }, +}); diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000000..47c218fb3a --- /dev/null +++ b/package-lock.json @@ -0,0 +1,12626 @@ +{ + "name": "ui-extensions", + "version": "0.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "ui-extensions", + "version": "0.0.0", + "workspaces": [ + "./packages/*" + ], + "devDependencies": { + "@babel/node": "^7.8.7", + "@changesets/changelog-github": "^0.5.0", + "@changesets/cli": "^2.27.0", + "@rollup/plugin-replace": "^6.0.1", + "@shopify/babel-preset": "^24.1.0", + "@shopify/browserslist-config": "^3.0.0", + "@shopify/eslint-plugin": "^42.0.0", + "@shopify/loom": "^1.0.0", + "@shopify/loom-cli": "^1.0.0", + "@shopify/loom-plugin-build-library": "^1.0.0", + "@shopify/loom-plugin-eslint": "^2.0.0", + "@shopify/loom-plugin-prettier": "^2.0.0", + "@shopify/typescript-configs": "^5.1.0", + "eslint": "^8.28.0", + "nodemon": "^2.0.4", + "prettier": "^2.8.8", + "typescript": "^4.9.0" + } + }, + "node_modules/@ampproject/remapping": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", + "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.24" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/code-frame": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.7.tgz", + "integrity": "sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/highlight": "^7.24.7", + "picocolors": "^1.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/code-frame/node_modules/picocolors": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.1.tgz", + "integrity": "sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew==", + "dev": true, + "license": "ISC" + }, + "node_modules/@babel/compat-data": { + "version": "7.25.2", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.25.2.tgz", + "integrity": "sha512-bYcppcpKBvX4znYaPEeFau03bp89ShqNMLs+rmdptMw+heSZh9+z84d2YG+K7cYLbWwzdjtDoW/uqZmPjulClQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/core": { + "version": "7.25.2", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.25.2.tgz", + "integrity": "sha512-BBt3opiCOxUr9euZ5/ro/Xv8/V7yJ5bjYMqG/C1YAo8MIKAnumZalCN+msbci3Pigy4lIQfPUpfMM27HMGaYEA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@ampproject/remapping": "^2.2.0", + "@babel/code-frame": "^7.24.7", + "@babel/generator": "^7.25.0", + "@babel/helper-compilation-targets": "^7.25.2", + "@babel/helper-module-transforms": "^7.25.2", + "@babel/helpers": "^7.25.0", + "@babel/parser": "^7.25.0", + "@babel/template": "^7.25.0", + "@babel/traverse": "^7.25.2", + "@babel/types": "^7.25.2", + "convert-source-map": "^2.0.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "node_modules/@babel/core/node_modules/convert-source-map": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@babel/eslint-parser": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/eslint-parser/-/eslint-parser-7.24.7.tgz", + "integrity": "sha512-SO5E3bVxDuxyNxM5agFv480YA2HO6ohZbGxbazZdIk3KQOPOGVNw6q78I9/lbviIf95eq6tPozeYnJLbjnC8IA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nicolo-ribaudo/eslint-scope-5-internals": "5.1.1-v1", + "eslint-visitor-keys": "^2.1.0", + "semver": "^6.3.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || >=14.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.11.0", + "eslint": "^7.5.0 || ^8.0.0 || ^9.0.0" + } + }, + "node_modules/@babel/eslint-parser/node_modules/eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=10" + } + }, + "node_modules/@babel/eslint-plugin": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/eslint-plugin/-/eslint-plugin-7.24.7.tgz", + "integrity": "sha512-lODNPJnM+OfcxxBvdmI2YmUeC0fBK3k9yET5O+1Eukr8d5VpO19c6ARtNheE2t2i/8XNYTzp3HeGEAAGZH3nnQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-rule-composer": "^0.3.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || >=14.0.0" + }, + "peerDependencies": { + "@babel/eslint-parser": "^7.11.0", + "eslint": "^7.5.0 || ^8.0.0 || ^9.0.0" + } + }, + "node_modules/@babel/generator": { + "version": "7.25.0", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.25.0.tgz", + "integrity": "sha512-3LEEcj3PVW8pW2R1SR1M89g/qrYk/m/mB/tLqn7dn4sbBUQyTqnlod+II2U4dqiGtUmkcnAmkMDralTFZttRiw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.25.0", + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.25", + "jsesc": "^2.5.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-annotate-as-pure": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.24.7.tgz", + "integrity": "sha512-BaDeOonYvhdKw+JoMVkAixAAJzG2jVPIwWoKBPdYuY9b452e2rPuI9QPYh3KpofZ3pW2akOmwZLOiOsHMiqRAg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-builder-binary-assignment-operator-visitor": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-builder-binary-assignment-operator-visitor/-/helper-builder-binary-assignment-operator-visitor-7.24.7.tgz", + "integrity": "sha512-xZeCVVdwb4MsDBkkyZ64tReWYrLRHlMN72vP7Bdm3OUOuyFZExhsHUUnuWnm2/XOlAJzR0LfPpB56WXZn0X/lA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-compilation-targets": { + "version": "7.25.2", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.25.2.tgz", + "integrity": "sha512-U2U5LsSaZ7TAt3cfaymQ8WHh0pxvdHoEk6HVpaexxixjyEquMh0L0YNJNM6CTGKMXV1iksi0iZkGw4AcFkPaaw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.25.2", + "@babel/helper-validator-option": "^7.24.8", + "browserslist": "^4.23.1", + "lru-cache": "^5.1.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-create-class-features-plugin": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.24.7.tgz", + "integrity": "sha512-kTkaDl7c9vO80zeX1rJxnuRpEsD5tA81yh11X1gQo+PhSti3JS+7qeZo9U4RHobKRiFPKaGK3svUAeb8D0Q7eg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-function-name": "^7.24.7", + "@babel/helper-member-expression-to-functions": "^7.24.7", + "@babel/helper-optimise-call-expression": "^7.24.7", + "@babel/helper-replace-supers": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7", + "@babel/helper-split-export-declaration": "^7.24.7", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-create-regexp-features-plugin": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.24.7.tgz", + "integrity": "sha512-03TCmXy2FtXJEZfbXDTSqq1fRJArk7lX9DOFC/47VthYcxyIOx+eXQmdo6DOQvrbpIix+KfXwvuXdFDZHxt+rA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "regexpu-core": "^5.3.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-define-polyfill-provider": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.2.tgz", + "integrity": "sha512-LV76g+C502biUK6AyZ3LK10vDpDyCzZnhZFXkH1L75zHPj68+qc8Zfpx2th+gzwA2MzyK+1g/3EPl62yFnVttQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-compilation-targets": "^7.22.6", + "@babel/helper-plugin-utils": "^7.22.5", + "debug": "^4.1.1", + "lodash.debounce": "^4.0.8", + "resolve": "^1.14.2" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/helper-environment-visitor": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-environment-visitor/-/helper-environment-visitor-7.24.7.tgz", + "integrity": "sha512-DoiN84+4Gnd0ncbBOM9AZENV4a5ZiL39HYMyZJGZ/AZEykHYdJw0wW3kdcsh9/Kn+BRXHLkkklZ51ecPKmI1CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-function-name": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.24.7.tgz", + "integrity": "sha512-FyoJTsj/PEUWu1/TYRiXTIHc8lbw+TDYkZuoE43opPS5TrI7MyONBE1oNvfguEXAD9yhQRrVBnXdXzSLQl9XnA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/template": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-hoist-variables": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-hoist-variables/-/helper-hoist-variables-7.24.7.tgz", + "integrity": "sha512-MJJwhkoGy5c4ehfoRyrJ/owKeMl19U54h27YYftT0o2teQ3FJ3nQUf/I3LlJsX4l3qlw7WRXUmiyajvHXoTubQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-member-expression-to-functions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.24.7.tgz", + "integrity": "sha512-LGeMaf5JN4hAT471eJdBs/GK1DoYIJ5GCtZN/EsL6KUiiDZOvO/eKE11AMZJa2zP4zk4qe9V2O/hxAmkRc8p6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-imports": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.24.7.tgz", + "integrity": "sha512-8AyH3C+74cgCVVXow/myrynrAGv+nTVg5vKu2nZph9x7RcRwzmh0VFallJuFTZ9mx6u4eSdXZfcOzSqTUm0HCA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-module-transforms": { + "version": "7.25.2", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.25.2.tgz", + "integrity": "sha512-BjyRAbix6j/wv83ftcVJmBt72QtHI56C7JXZoG2xATiLpmoC7dpd8WnkikExHDVPpi/3qCmO6WY1EaXOluiecQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.24.7", + "@babel/helper-simple-access": "^7.24.7", + "@babel/helper-validator-identifier": "^7.24.7", + "@babel/traverse": "^7.25.2" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-optimise-call-expression": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.24.7.tgz", + "integrity": "sha512-jKiTsW2xmWwxT1ixIdfXUZp+P5yURx2suzLZr5Hi64rURpDYdMW0pv+Uf17EYk2Rd428Lx4tLsnjGJzYKDM/6A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-plugin-utils": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.24.7.tgz", + "integrity": "sha512-Rq76wjt7yz9AAc1KnlRKNAi/dMSVWgDRx43FHoJEbcYU6xOWaE2dVPwcdTukJrjxS65GITyfbvEYHvkirZ6uEg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-remap-async-to-generator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.24.7.tgz", + "integrity": "sha512-9pKLcTlZ92hNZMQfGCHImUpDOlAgkkpqalWEeftW5FBya75k8Li2ilerxkM/uBEj01iBZXcCIB/bwvDYgWyibA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-wrap-function": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-replace-supers": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.24.7.tgz", + "integrity": "sha512-qTAxxBM81VEyoAY0TtLrx1oAEJc09ZK67Q9ljQToqCnA+55eNwCORaxlKyu+rNfX86o8OXRUSNUnrtsAZXM9sg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-member-expression-to-functions": "^7.24.7", + "@babel/helper-optimise-call-expression": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/helper-simple-access": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-simple-access/-/helper-simple-access-7.24.7.tgz", + "integrity": "sha512-zBAIvbCMh5Ts+b86r/CjU+4XGYIs+R1j951gxI3KmmxBMhCg4oQMsv6ZXQ64XOm/cvzfU1FmoCyt6+owc5QMYg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-skip-transparent-expression-wrappers": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.24.7.tgz", + "integrity": "sha512-IO+DLT3LQUElMbpzlatRASEyQtfhSE0+m465v++3jyyXeBTBUjtVZg28/gHeV5mrTJqvEKhKroBGAvhW+qPHiQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-split-export-declaration": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.24.7.tgz", + "integrity": "sha512-oy5V7pD+UvfkEATUKvIjvIAH/xCzfsFVw7ygW2SI6NClZzquT+mwdTfgfdbUiceh6iQO0CHtCPsyze/MZ2YbAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.24.8", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.24.8.tgz", + "integrity": "sha512-pO9KhhRcuUyGnJWwyEgnRJTSIZHiT+vMD0kPeD+so0l7mxkMT19g3pjY9GTnHySck/hDzq+dtW/4VgnMkippsQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz", + "integrity": "sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-option": { + "version": "7.24.8", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.24.8.tgz", + "integrity": "sha512-xb8t9tD1MHLungh/AIoWYN+gVHaB9kwlu8gffXGSt3FFEIT7RjS+xWbc2vUD1UTZdIpKj/ab3rdqJ7ufngyi2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-wrap-function": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.24.7.tgz", + "integrity": "sha512-N9JIYk3TD+1vq/wn77YnJOqMtfWhNewNE+DJV4puD2X7Ew9J4JvrzrFDfTfyv5EgEXVy9/Wt8QiOErzEmv5Ifw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-function-name": "^7.24.7", + "@babel/template": "^7.24.7", + "@babel/traverse": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helpers": { + "version": "7.25.0", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.25.0.tgz", + "integrity": "sha512-MjgLZ42aCm0oGjJj8CtSM3DB8NOOf8h2l7DCTePJs29u+v7yO/RBX9nShlKMgFnRks/Q4tBAe7Hxnov9VkGwLw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/template": "^7.25.0", + "@babel/types": "^7.25.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.7.tgz", + "integrity": "sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-validator-identifier": "^7.24.7", + "chalk": "^2.4.2", + "js-tokens": "^4.0.0", + "picocolors": "^1.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/highlight/node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/@babel/highlight/node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@babel/highlight/node_modules/has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/highlight/node_modules/picocolors": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.1.tgz", + "integrity": "sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew==", + "dev": true, + "license": "ISC" + }, + "node_modules/@babel/highlight/node_modules/supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/@babel/node": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/node/-/node-7.24.7.tgz", + "integrity": "sha512-BCYNLxUQjGTgy8bAq12jy+Lt8soGWa/5u3s7U3aTVXxviIp0YVS+/Wm0b4eaitLVvetYrEoAiRF0QOk4WKsHAQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/register": "^7.24.6", + "commander": "^6.2.0", + "core-js": "^3.30.2", + "node-environment-flags": "^1.0.5", + "regenerator-runtime": "^0.14.0", + "v8flags": "^3.1.1" + }, + "bin": { + "babel-node": "bin/babel-node.js" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/parser": { + "version": "7.25.3", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.25.3.tgz", + "integrity": "sha512-iLTJKDbJ4hMvFPgQwwsVoxtHyWpKKPBrxkANrSYewDPaPpT5py5yeVkgPIJ7XYXhndxJpaA3PyALSXQ7u8e/Dw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.25.2" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-firefox-class-in-computed-class-key": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.24.7.tgz", + "integrity": "sha512-TiT1ss81W80eQsN+722OaeQMY/G4yTb4G9JrqeiDADs3N8lbPMGldWi9x8tyqCW5NLx1Jh2AvkE6r6QvEltMMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.24.7.tgz", + "integrity": "sha512-unaQgZ/iRu/By6tsjMZzpeBZjChYfLYry6HrEXPoz3KmfF0sVBQ1l8zKMQ4xRGLWVsjuvB8nQfjNP/DcfEOCsg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.24.7.tgz", + "integrity": "sha512-+izXIbke1T33mY4MSNnrqhPXDz01WYhEf3yF5NbnUtkiNnm+XBZJl3kNfoK6NKmYlz/D07+l2GWVK/QfDkNCuQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7", + "@babel/plugin-transform-optional-chaining": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.13.0" + } + }, + "node_modules/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.24.7.tgz", + "integrity": "sha512-utA4HuR6F4Vvcr+o4DnjL8fCOlgRFGbeeBEGNg3ZTrLFw6VWG5XmUrvcQ0FjIYMU2ST4XcR2Wsp7t9qOAPnxMg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-proposal-class-properties": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-class-properties/-/plugin-proposal-class-properties-7.18.6.tgz", + "integrity": "sha512-cumfXOF0+nzZrrN8Rf0t7M+tF6sZc7vhQwYQck9q1/5w2OExlD+b4v4RpMJFaV1Z7WcDRgO6FqvxqxGlwo+RHQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.18.6", + "@babel/helper-plugin-utils": "^7.18.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-proposal-decorators": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-decorators/-/plugin-proposal-decorators-7.24.7.tgz", + "integrity": "sha512-RL9GR0pUG5Kc8BUWLNDm2T5OpYwSX15r98I0IkgmRQTXuELq/OynH8xtMTMvTJFjXbMWFVTKtYkTaYQsuAwQlQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-decorators": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-proposal-dynamic-import": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-dynamic-import/-/plugin-proposal-dynamic-import-7.18.6.tgz", + "integrity": "sha512-1auuwmK+Rz13SJj36R+jqFPMJWyKEDd7lLSdOj4oJK0UTgGueSAtkrCvz9ewmgyU/P941Rv2fQwZJN8s6QruXw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.18.6", + "@babel/plugin-syntax-dynamic-import": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-proposal-nullish-coalescing-operator": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-nullish-coalescing-operator/-/plugin-proposal-nullish-coalescing-operator-7.18.6.tgz", + "integrity": "sha512-wQxQzxYeJqHcfppzBDnm1yAY0jSRkUXR2z8RePZYrKwMKgMlE8+Z6LUno+bd6LvbGh8Gltvy74+9pIYkr+XkKA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.18.6", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-proposal-numeric-separator": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-numeric-separator/-/plugin-proposal-numeric-separator-7.18.6.tgz", + "integrity": "sha512-ozlZFogPqoLm8WBr5Z8UckIoE4YQ5KESVcNudyXOR8uqIkliTEgJ3RoketfG6pmzLdeZF0H/wjE9/cCEitBl7Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.18.6", + "@babel/plugin-syntax-numeric-separator": "^7.10.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-proposal-optional-chaining": { + "version": "7.21.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-optional-chaining/-/plugin-proposal-optional-chaining-7.21.0.tgz", + "integrity": "sha512-p4zeefM72gpmEe2fkUr/OnOXpWEf8nAgk7ZYVqqfFiyIG7oFfVZcCrU64hWn5xp4tQ9LkV4bTIa5rD0KANpKNA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.20.2", + "@babel/helper-skip-transparent-expression-wrappers": "^7.20.0", + "@babel/plugin-syntax-optional-chaining": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-proposal-private-methods": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-methods/-/plugin-proposal-private-methods-7.18.6.tgz", + "integrity": "sha512-nutsvktDItsNn4rpGItSNV2sz1XwS+nfU0Rg8aCx3W3NOKVzdMjJRu0O5OkgDp3ZGICSTbgRpxZoWsxoKRvbeA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.18.6", + "@babel/helper-plugin-utils": "^7.18.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-proposal-private-property-in-object": { + "version": "7.21.0-placeholder-for-preset-env.2", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz", + "integrity": "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-async-generators": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz", + "integrity": "sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-bigint": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-bigint/-/plugin-syntax-bigint-7.8.3.tgz", + "integrity": "sha512-wnTnFlG+YxQm3vDxpGE57Pj0srRU4sHE/mDkt1qv2YJJSeUAec2ma4WLUnUPeKjyrfntVwe/N6dCXpU+zL3Npg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-properties": { + "version": "7.12.13", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz", + "integrity": "sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.12.13" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-class-static-block": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-class-static-block/-/plugin-syntax-class-static-block-7.14.5.tgz", + "integrity": "sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-decorators": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-decorators/-/plugin-syntax-decorators-7.24.7.tgz", + "integrity": "sha512-Ui4uLJJrRV1lb38zg1yYTmRKmiZLiftDEvZN2iq3kd9kUFU+PttmzTbAFC2ucRk/XJmtek6G23gPsuZbhrT8fQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-dynamic-import": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.8.3.tgz", + "integrity": "sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-export-namespace-from": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-export-namespace-from/-/plugin-syntax-export-namespace-from-7.8.3.tgz", + "integrity": "sha512-MXf5laXo6c1IbEbegDmzGPwGNTsHZmEy6QGznu5Sh2UCWvueywb2ee+CCE4zQiZstxU9BMoQO9i6zUFSY0Kj0Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.3" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-assertions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.24.7.tgz", + "integrity": "sha512-Ec3NRUMoi8gskrkBe3fNmEQfxDvY8bgfQpz6jlk/41kX9eUjvpyqWU7PBP/pLAvMaSQjbMNKJmvX57jP+M6bPg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-attributes": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.24.7.tgz", + "integrity": "sha512-hbX+lKKeUMGihnK8nvKqmXBInriT3GVjzXKFriV3YC6APGxMbP8RZNFwy91+hocLXq90Mta+HshoB31802bb8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-import-meta": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz", + "integrity": "sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-json-strings": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.8.3.tgz", + "integrity": "sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-jsx": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.24.7.tgz", + "integrity": "sha512-6ddciUPe/mpMnOKv/U+RSd2vvVy+Yw/JfBB0ZHYjEZt9NLHmCUylNYlsbqCCS1Bffjlb0fCwC9Vqz+sBz6PsiQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-logical-assignment-operators": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz", + "integrity": "sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-nullish-coalescing-operator": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-nullish-coalescing-operator/-/plugin-syntax-nullish-coalescing-operator-7.8.3.tgz", + "integrity": "sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-numeric-separator": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz", + "integrity": "sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.10.4" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-object-rest-spread": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.8.3.tgz", + "integrity": "sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-catch-binding": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.8.3.tgz", + "integrity": "sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-optional-chaining": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-chaining/-/plugin-syntax-optional-chaining-7.8.3.tgz", + "integrity": "sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-private-property-in-object": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-private-property-in-object/-/plugin-syntax-private-property-in-object-7.14.5.tgz", + "integrity": "sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-top-level-await": { + "version": "7.14.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz", + "integrity": "sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-typescript": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.24.7.tgz", + "integrity": "sha512-c/+fVeJBB0FeKsFvwytYiUD+LBvhHjGSI0g446PRGdSVGZLRNArBUno2PETbAly3tpiNAQR5XaZ+JslxkotsbA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-unicode-sets-regex": { + "version": "7.18.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", + "integrity": "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.18.6", + "@babel/helper-plugin-utils": "^7.18.6" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-arrow-functions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.24.7.tgz", + "integrity": "sha512-Dt9LQs6iEY++gXUwY03DNFat5C2NbO48jj+j/bSAz6b3HgPs39qcPiYt77fDObIcFwj3/C2ICX9YMwGflUoSHQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-generator-functions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.24.7.tgz", + "integrity": "sha512-o+iF77e3u7ZS4AoAuJvapz9Fm001PuD2V3Lp6OSE4FYQke+cSewYtnek+THqGRWyQloRCyvWL1OkyfNEl9vr/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-remap-async-to-generator": "^7.24.7", + "@babel/plugin-syntax-async-generators": "^7.8.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-async-to-generator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.24.7.tgz", + "integrity": "sha512-SQY01PcJfmQ+4Ash7NE+rpbLFbmqA2GPIgqzxfFTL4t1FKRq4zTms/7htKpoCUI9OcFYgzqfmCdH53s6/jn5fA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-remap-async-to-generator": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoped-functions": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.24.7.tgz", + "integrity": "sha512-yO7RAz6EsVQDaBH18IDJcMB1HnrUn2FJ/Jslc/WtPPWcjhpUJXU/rjbwmluzp7v/ZzWcEhTMXELnnsz8djWDwQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-block-scoping": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.24.7.tgz", + "integrity": "sha512-Nd5CvgMbWc+oWzBsuaMcbwjJWAcp5qzrbg69SZdHSP7AMY0AbWFqFO0WTFCA1jxhMCwodRwvRec8k0QUbZk7RQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-properties": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.24.7.tgz", + "integrity": "sha512-vKbfawVYayKcSeSR5YYzzyXvsDFWU2mD8U5TFeXtbCPLFUqe7GyCgvO6XDHzje862ODrOwy6WCPmKeWHbCFJ4w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-class-static-block": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.24.7.tgz", + "integrity": "sha512-HMXK3WbBPpZQufbMG4B46A90PkuuhN9vBCb5T8+VAHqvAqvcLi+2cKoukcpmUYkszLhScU3l1iudhrks3DggRQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-class-static-block": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.12.0" + } + }, + "node_modules/@babel/plugin-transform-classes": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.24.7.tgz", + "integrity": "sha512-CFbbBigp8ln4FU6Bpy6g7sE8B/WmCmzvivzUC6xDAdWVsjYTXijpuuGJmYkAaoWAzcItGKT3IOAbxRItZ5HTjw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-compilation-targets": "^7.24.7", + "@babel/helper-environment-visitor": "^7.24.7", + "@babel/helper-function-name": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-replace-supers": "^7.24.7", + "@babel/helper-split-export-declaration": "^7.24.7", + "globals": "^11.1.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-computed-properties": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.24.7.tgz", + "integrity": "sha512-25cS7v+707Gu6Ds2oY6tCkUwsJ9YIDbggd9+cu9jzzDgiNq7hR/8dkzxWfKWnTic26vsI3EsCXNd4iEB6e8esQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/template": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-destructuring": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.24.7.tgz", + "integrity": "sha512-19eJO/8kdCQ9zISOf+SEUJM/bAUIsvY3YDnXZTupUCQ8LgrWnsG/gFB9dvXqdXnRXMAM8fvt7b0CBKQHNGy1mw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-dotall-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.24.7.tgz", + "integrity": "sha512-ZOA3W+1RRTSWvyqcMJDLqbchh7U4NRGqwRfFSVbOLS/ePIP4vHB5e8T8eXcuqyN1QkgKyj5wuW0lcS85v4CrSw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-duplicate-keys": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.24.7.tgz", + "integrity": "sha512-JdYfXyCRihAe46jUIliuL2/s0x0wObgwwiGxw/UbgJBr20gQBThrokO4nYKgWkD7uBaqM7+9x5TU7NkExZJyzw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-dynamic-import": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.24.7.tgz", + "integrity": "sha512-sc3X26PhZQDb3JhORmakcbvkeInvxz+A8oda99lj7J60QRuPZvNAk9wQlTBS1ZynelDrDmTU4pw1tyc5d5ZMUg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-dynamic-import": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-exponentiation-operator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.24.7.tgz", + "integrity": "sha512-Rqe/vSc9OYgDajNIK35u7ot+KeCoetqQYFXM4Epf7M7ez3lWlOjrDjrwMei6caCVhfdw+mIKD4cgdGNy5JQotQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-builder-binary-assignment-operator-visitor": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-export-namespace-from": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.24.7.tgz", + "integrity": "sha512-v0K9uNYsPL3oXZ/7F9NNIbAj2jv1whUEtyA6aujhekLs56R++JDQuzRcP2/z4WX5Vg/c5lE9uWZA0/iUoFhLTA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-export-namespace-from": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-for-of": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.24.7.tgz", + "integrity": "sha512-wo9ogrDG1ITTTBsy46oGiN1dS9A7MROBTcYsfS8DtsImMkHk9JXJ3EWQM6X2SUw4x80uGPlwj0o00Uoc6nEE3g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-function-name": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.24.7.tgz", + "integrity": "sha512-U9FcnA821YoILngSmYkW6FjyQe2TyZD5pHt4EVIhmcTkrJw/3KqcrRSxuOo5tFZJi7TE19iDyI1u+weTI7bn2w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-compilation-targets": "^7.24.7", + "@babel/helper-function-name": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-json-strings": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.24.7.tgz", + "integrity": "sha512-2yFnBGDvRuxAaE/f0vfBKvtnvvqU8tGpMHqMNpTN2oWMKIR3NqFkjaAgGwawhqK/pIN2T3XdjGPdaG0vDhOBGw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-json-strings": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-literals": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.24.7.tgz", + "integrity": "sha512-vcwCbb4HDH+hWi8Pqenwnjy+UiklO4Kt1vfspcQYFhJdpthSnW8XvWGyDZWKNVrVbVViI/S7K9PDJZiUmP2fYQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-logical-assignment-operators": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.24.7.tgz", + "integrity": "sha512-4D2tpwlQ1odXmTEIFWy9ELJcZHqrStlzK/dAOWYyxX3zT0iXQB6banjgeOJQXzEc4S0E0a5A+hahxPaEFYftsw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-logical-assignment-operators": "^7.10.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-member-expression-literals": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.24.7.tgz", + "integrity": "sha512-T/hRC1uqrzXMKLQ6UCwMT85S3EvqaBXDGf0FaMf4446Qx9vKwlghvee0+uuZcDUCZU5RuNi4781UQ7R308zzBw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-amd": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.24.7.tgz", + "integrity": "sha512-9+pB1qxV3vs/8Hdmz/CulFB8w2tuu6EB94JZFsjdqxQokwGa9Unap7Bo2gGBGIvPmDIVvQrom7r5m/TCDMURhg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-commonjs": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.24.7.tgz", + "integrity": "sha512-iFI8GDxtevHJ/Z22J5xQpVqFLlMNstcLXh994xifFwxxGslr2ZXXLWgtBeLctOD63UFDArdvN6Tg8RFw+aEmjQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-simple-access": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-systemjs": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.24.7.tgz", + "integrity": "sha512-GYQE0tW7YoaN13qFh3O1NCY4MPkUiAH3fiF7UcV/I3ajmDKEdG3l+UOcbAm4zUE3gnvUU+Eni7XrVKo9eO9auw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-hoist-variables": "^7.24.7", + "@babel/helper-module-transforms": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-validator-identifier": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-modules-umd": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.24.7.tgz", + "integrity": "sha512-3aytQvqJ/h9z4g8AsKPLvD4Zqi2qT+L3j7XoFFu1XBlZWEl2/1kWnhmAbxpLgPrHSY0M6UA02jyTiwUVtiKR6A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-transforms": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.24.7.tgz", + "integrity": "sha512-/jr7h/EWeJtk1U/uz2jlsCioHkZk1JJZVcc8oQsJ1dUlaJD83f4/6Zeh2aHt9BIFokHIsSeDfhUmju0+1GPd6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/plugin-transform-new-target": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.24.7.tgz", + "integrity": "sha512-RNKwfRIXg4Ls/8mMTza5oPF5RkOW8Wy/WgMAp1/F1yZ8mMbtwXW+HDoJiOsagWrAhI5f57Vncrmr9XeT4CVapA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.24.7.tgz", + "integrity": "sha512-Ts7xQVk1OEocqzm8rHMXHlxvsfZ0cEF2yomUqpKENHWMF4zKk175Y4q8H5knJes6PgYad50uuRmt3UJuhBw8pQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-numeric-separator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.24.7.tgz", + "integrity": "sha512-e6q1TiVUzvH9KRvicuxdBTUj4AdKSRwzIyFFnfnezpCfP2/7Qmbb8qbU2j7GODbl4JMkblitCQjKYUaX/qkkwA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-numeric-separator": "^7.10.4" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-rest-spread": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.24.7.tgz", + "integrity": "sha512-4QrHAr0aXQCEFni2q4DqKLD31n2DL+RxcwnNjDFkSG0eNQ/xCavnRkfCUjsyqGC2OviNJvZOF/mQqZBw7i2C5Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-compilation-targets": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-object-rest-spread": "^7.8.3", + "@babel/plugin-transform-parameters": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-object-super": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.24.7.tgz", + "integrity": "sha512-A/vVLwN6lBrMFmMDmPPz0jnE6ZGx7Jq7d6sT/Ev4H65RER6pZ+kczlf1DthF5N0qaPHBsI7UXiE8Zy66nmAovg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-replace-supers": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-catch-binding": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.24.7.tgz", + "integrity": "sha512-uLEndKqP5BfBbC/5jTwPxLh9kqPWWgzN/f8w6UwAIirAEqiIVJWWY312X72Eub09g5KF9+Zn7+hT7sDxmhRuKA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-optional-catch-binding": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-optional-chaining": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.24.7.tgz", + "integrity": "sha512-tK+0N9yd4j+x/4hxF3F0e0fu/VdcxU18y5SevtyM/PCFlQvXbR0Zmlo2eBrKtVipGNFzpq56o8WsIIKcJFUCRQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7", + "@babel/plugin-syntax-optional-chaining": "^7.8.3" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-parameters": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.24.7.tgz", + "integrity": "sha512-yGWW5Rr+sQOhK0Ot8hjDJuxU3XLRQGflvT4lhlSY0DFvdb3TwKaY26CJzHtYllU0vT9j58hc37ndFPsqT1SrzA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-methods": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.24.7.tgz", + "integrity": "sha512-COTCOkG2hn4JKGEKBADkA8WNb35TGkkRbI5iT845dB+NyqgO8Hn+ajPbSnIQznneJTa3d30scb6iz/DhH8GsJQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-private-property-in-object": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.24.7.tgz", + "integrity": "sha512-9z76mxwnwFxMyxZWEgdgECQglF2Q7cFLm0kMf8pGwt+GSJsY0cONKj/UuO4bOH0w/uAel3ekS4ra5CEAyJRmDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-private-property-in-object": "^7.14.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-property-literals": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.24.7.tgz", + "integrity": "sha512-EMi4MLQSHfd2nrCqQEWxFdha2gBCqU4ZcCng4WBGZ5CJL4bBRW0ptdqqDdeirGZcpALazVVNJqRmsO8/+oNCBA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-constant-elements": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-constant-elements/-/plugin-transform-react-constant-elements-7.24.7.tgz", + "integrity": "sha512-7LidzZfUXyfZ8/buRW6qIIHBY8wAZ1OrY9c/wTr8YhZ6vMPo+Uc/CVFLYY1spZrEQlD4w5u8wjqk5NQ3OVqQKA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-display-name": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-display-name/-/plugin-transform-react-display-name-7.24.7.tgz", + "integrity": "sha512-H/Snz9PFxKsS1JLI4dJLtnJgCJRoo0AUm3chP6NYr+9En1JMKloheEiLIhlp5MDVznWo+H3AAC1Mc8lmUEpsgg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx/-/plugin-transform-react-jsx-7.24.7.tgz", + "integrity": "sha512-+Dj06GDZEFRYvclU6k4bme55GKBEWUmByM/eoKuqg4zTNQHiApWRhQph5fxQB2wAEFvRzL1tOEj1RJ19wJrhoA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-module-imports": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-jsx": "^7.24.7", + "@babel/types": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-jsx-development": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-development/-/plugin-transform-react-jsx-development-7.24.7.tgz", + "integrity": "sha512-QG9EnzoGn+Qar7rxuW+ZOsbWOt56FvvI93xInqsZDC5fsekx1AlIO4KIJ5M+D0p0SqSH156EpmZyXq630B8OlQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/plugin-transform-react-jsx": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-react-pure-annotations": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-pure-annotations/-/plugin-transform-react-pure-annotations-7.24.7.tgz", + "integrity": "sha512-PLgBVk3fzbmEjBJ/u8kFzOqS9tUeDjiaWud/rRym/yjCo/M9cASPlnrd2ZmmZpQT40fOOrvR8jh+n8jikrOhNA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-regenerator": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.24.7.tgz", + "integrity": "sha512-lq3fvXPdimDrlg6LWBoqj+r/DEWgONuwjuOuQCSYgRroXDH/IdM1C0IZf59fL5cHLpjEH/O6opIRBbqv7ELnuA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "regenerator-transform": "^0.15.2" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-reserved-words": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.24.7.tgz", + "integrity": "sha512-0DUq0pHcPKbjFZCfTss/pGkYMfy3vFWydkUBd9r0GHpIyfs2eCDENvqadMycRS9wZCXR41wucAfJHJmwA0UmoQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-runtime": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-runtime/-/plugin-transform-runtime-7.24.7.tgz", + "integrity": "sha512-YqXjrk4C+a1kZjewqt+Mmu2UuV1s07y8kqcUf4qYLnoqemhR4gRQikhdAhSVJioMjVTu6Mo6pAbaypEA3jY6fw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "babel-plugin-polyfill-corejs2": "^0.4.10", + "babel-plugin-polyfill-corejs3": "^0.10.1", + "babel-plugin-polyfill-regenerator": "^0.6.1", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-shorthand-properties": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.24.7.tgz", + "integrity": "sha512-KsDsevZMDsigzbA09+vacnLpmPH4aWjcZjXdyFKGzpplxhbeB4wYtury3vglQkg6KM/xEPKt73eCjPPf1PgXBA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-spread": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.24.7.tgz", + "integrity": "sha512-x96oO0I09dgMDxJaANcRyD4ellXFLLiWhuwDxKZX5g2rWP1bTPkBSwCYv96VDXVT1bD9aPj8tppr5ITIh8hBng==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-skip-transparent-expression-wrappers": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-sticky-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.24.7.tgz", + "integrity": "sha512-kHPSIJc9v24zEml5geKg9Mjx5ULpfncj0wRpYtxbvKyTtHCYDkVE3aHQ03FrpEo4gEe2vrJJS1Y9CJTaThA52g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-template-literals": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.24.7.tgz", + "integrity": "sha512-AfDTQmClklHCOLxtGoP7HkeMw56k1/bTQjwsfhL6pppo/M4TOBSq+jjBUBLmV/4oeFg4GWMavIl44ZeCtmmZTw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-typeof-symbol": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.24.7.tgz", + "integrity": "sha512-VtR8hDy7YLB7+Pet9IarXjg/zgCMSF+1mNS/EQEiEaUPoFXCVsHG64SIxcaaI2zJgRiv+YmgaQESUfWAdbjzgg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-typescript": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.24.7.tgz", + "integrity": "sha512-iLD3UNkgx2n/HrjBesVbYX6j0yqn/sJktvbtKKgcaLIQ4bTTQ8obAypc1VpyHPD2y4Phh9zHOaAt8e/L14wCpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.24.7", + "@babel/helper-create-class-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/plugin-syntax-typescript": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-escapes": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.24.7.tgz", + "integrity": "sha512-U3ap1gm5+4edc2Q/P+9VrBNhGkfnf+8ZqppY71Bo/pzZmXhhLdqgaUl6cuB07O1+AQJtCLfaOmswiNbSQ9ivhw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-property-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.24.7.tgz", + "integrity": "sha512-uH2O4OV5M9FZYQrwc7NdVmMxQJOCCzFeYudlZSzUAHRFeOujQefa92E74TQDVskNHCzOXoigEuoyzHDhaEaK5w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.24.7.tgz", + "integrity": "sha512-hlQ96MBZSAXUq7ltkjtu3FJCCSMx/j629ns3hA3pXnBXjanNP0LHi+JpPeA81zaWgVK1VGH95Xuy7u0RyQ8kMg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-unicode-sets-regex": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.24.7.tgz", + "integrity": "sha512-2G8aAvF4wy1w/AGZkemprdGMRg5o6zPNhbHVImRz3lss55TYCBd6xStN19rt8XJHq20sqV0JbyWjOWwQRwV/wg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-create-regexp-features-plugin": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/@babel/preset-env": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.24.7.tgz", + "integrity": "sha512-1YZNsc+y6cTvWlDHidMBsQZrZfEFjRIo/BZCT906PMdzOyXtSLTgqGdrpcuTDCXyd11Am5uQULtDIcCfnTc8fQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.24.7", + "@babel/helper-compilation-targets": "^7.24.7", + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-validator-option": "^7.24.7", + "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.24.7", + "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.24.7", + "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.24.7", + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.24.7", + "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", + "@babel/plugin-syntax-async-generators": "^7.8.4", + "@babel/plugin-syntax-class-properties": "^7.12.13", + "@babel/plugin-syntax-class-static-block": "^7.14.5", + "@babel/plugin-syntax-dynamic-import": "^7.8.3", + "@babel/plugin-syntax-export-namespace-from": "^7.8.3", + "@babel/plugin-syntax-import-assertions": "^7.24.7", + "@babel/plugin-syntax-import-attributes": "^7.24.7", + "@babel/plugin-syntax-import-meta": "^7.10.4", + "@babel/plugin-syntax-json-strings": "^7.8.3", + "@babel/plugin-syntax-logical-assignment-operators": "^7.10.4", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3", + "@babel/plugin-syntax-numeric-separator": "^7.10.4", + "@babel/plugin-syntax-object-rest-spread": "^7.8.3", + "@babel/plugin-syntax-optional-catch-binding": "^7.8.3", + "@babel/plugin-syntax-optional-chaining": "^7.8.3", + "@babel/plugin-syntax-private-property-in-object": "^7.14.5", + "@babel/plugin-syntax-top-level-await": "^7.14.5", + "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", + "@babel/plugin-transform-arrow-functions": "^7.24.7", + "@babel/plugin-transform-async-generator-functions": "^7.24.7", + "@babel/plugin-transform-async-to-generator": "^7.24.7", + "@babel/plugin-transform-block-scoped-functions": "^7.24.7", + "@babel/plugin-transform-block-scoping": "^7.24.7", + "@babel/plugin-transform-class-properties": "^7.24.7", + "@babel/plugin-transform-class-static-block": "^7.24.7", + "@babel/plugin-transform-classes": "^7.24.7", + "@babel/plugin-transform-computed-properties": "^7.24.7", + "@babel/plugin-transform-destructuring": "^7.24.7", + "@babel/plugin-transform-dotall-regex": "^7.24.7", + "@babel/plugin-transform-duplicate-keys": "^7.24.7", + "@babel/plugin-transform-dynamic-import": "^7.24.7", + "@babel/plugin-transform-exponentiation-operator": "^7.24.7", + "@babel/plugin-transform-export-namespace-from": "^7.24.7", + "@babel/plugin-transform-for-of": "^7.24.7", + "@babel/plugin-transform-function-name": "^7.24.7", + "@babel/plugin-transform-json-strings": "^7.24.7", + "@babel/plugin-transform-literals": "^7.24.7", + "@babel/plugin-transform-logical-assignment-operators": "^7.24.7", + "@babel/plugin-transform-member-expression-literals": "^7.24.7", + "@babel/plugin-transform-modules-amd": "^7.24.7", + "@babel/plugin-transform-modules-commonjs": "^7.24.7", + "@babel/plugin-transform-modules-systemjs": "^7.24.7", + "@babel/plugin-transform-modules-umd": "^7.24.7", + "@babel/plugin-transform-named-capturing-groups-regex": "^7.24.7", + "@babel/plugin-transform-new-target": "^7.24.7", + "@babel/plugin-transform-nullish-coalescing-operator": "^7.24.7", + "@babel/plugin-transform-numeric-separator": "^7.24.7", + "@babel/plugin-transform-object-rest-spread": "^7.24.7", + "@babel/plugin-transform-object-super": "^7.24.7", + "@babel/plugin-transform-optional-catch-binding": "^7.24.7", + "@babel/plugin-transform-optional-chaining": "^7.24.7", + "@babel/plugin-transform-parameters": "^7.24.7", + "@babel/plugin-transform-private-methods": "^7.24.7", + "@babel/plugin-transform-private-property-in-object": "^7.24.7", + "@babel/plugin-transform-property-literals": "^7.24.7", + "@babel/plugin-transform-regenerator": "^7.24.7", + "@babel/plugin-transform-reserved-words": "^7.24.7", + "@babel/plugin-transform-shorthand-properties": "^7.24.7", + "@babel/plugin-transform-spread": "^7.24.7", + "@babel/plugin-transform-sticky-regex": "^7.24.7", + "@babel/plugin-transform-template-literals": "^7.24.7", + "@babel/plugin-transform-typeof-symbol": "^7.24.7", + "@babel/plugin-transform-unicode-escapes": "^7.24.7", + "@babel/plugin-transform-unicode-property-regex": "^7.24.7", + "@babel/plugin-transform-unicode-regex": "^7.24.7", + "@babel/plugin-transform-unicode-sets-regex": "^7.24.7", + "@babel/preset-modules": "0.1.6-no-external-plugins", + "babel-plugin-polyfill-corejs2": "^0.4.10", + "babel-plugin-polyfill-corejs3": "^0.10.4", + "babel-plugin-polyfill-regenerator": "^0.6.1", + "core-js-compat": "^3.31.0", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/preset-modules": { + "version": "0.1.6-no-external-plugins", + "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz", + "integrity": "sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.0.0", + "@babel/types": "^7.4.4", + "esutils": "^2.0.2" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/@babel/preset-react": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/preset-react/-/preset-react-7.24.7.tgz", + "integrity": "sha512-AAH4lEkpmzFWrGVlHaxJB7RLH21uPQ9+He+eFLWHmF9IuFQVugz8eAsamaW0DXRrTfco5zj1wWtpdcXJUOfsag==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-validator-option": "^7.24.7", + "@babel/plugin-transform-react-display-name": "^7.24.7", + "@babel/plugin-transform-react-jsx": "^7.24.7", + "@babel/plugin-transform-react-jsx-development": "^7.24.7", + "@babel/plugin-transform-react-pure-annotations": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/preset-typescript": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/preset-typescript/-/preset-typescript-7.24.7.tgz", + "integrity": "sha512-SyXRe3OdWwIwalxDg5UtJnJQO+YPcTfwiIY2B0Xlddh9o7jpWLvv8X1RthIeDOxQ+O1ML5BLPCONToObyVQVuQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.24.7", + "@babel/helper-validator-option": "^7.24.7", + "@babel/plugin-syntax-jsx": "^7.24.7", + "@babel/plugin-transform-modules-commonjs": "^7.24.7", + "@babel/plugin-transform-typescript": "^7.24.7" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/register": { + "version": "7.24.6", + "resolved": "https://registry.npmjs.org/@babel/register/-/register-7.24.6.tgz", + "integrity": "sha512-WSuFCc2wCqMeXkz/i3yfAAsxwWflEgbVkZzivgAmXl/MxrXeoYFZOOPllbC8R8WTF7u61wSRQtDVZ1879cdu6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "clone-deep": "^4.0.1", + "find-cache-dir": "^2.0.0", + "make-dir": "^2.1.0", + "pirates": "^4.0.6", + "source-map-support": "^0.5.16" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/regjsgen": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@babel/regjsgen/-/regjsgen-0.8.0.tgz", + "integrity": "sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@babel/runtime": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.24.7.tgz", + "integrity": "sha512-UwgBRMjJP+xv857DCngvqXI3Iq6J4v0wXmwc6sapg+zyhbwmQX67LUEFrkK5tbyJ30jGuG3ZvWpBiB9LCy1kWw==", + "dev": true, + "license": "MIT", + "dependencies": { + "regenerator-runtime": "^0.14.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/template": { + "version": "7.25.0", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.25.0.tgz", + "integrity": "sha512-aOOgh1/5XzKvg1jvVz7AVrx2piJ2XBi227DHmbY6y+bM9H2FlN+IfecYu4Xl0cNiiVejlsCri89LUsbj8vJD9Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.24.7", + "@babel/parser": "^7.25.0", + "@babel/types": "^7.25.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/traverse": { + "version": "7.25.3", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.25.3.tgz", + "integrity": "sha512-HefgyP1x754oGCsKmV5reSmtV7IXj/kpaE1XYY+D9G5PvKKoFfSbiS4M77MdjuwlZKDIKFCffq9rPU+H/s3ZdQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.24.7", + "@babel/generator": "^7.25.0", + "@babel/parser": "^7.25.3", + "@babel/template": "^7.25.0", + "@babel/types": "^7.25.2", + "debug": "^4.3.1", + "globals": "^11.1.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/types": { + "version": "7.25.2", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.25.2.tgz", + "integrity": "sha512-YTnYtra7W9e6/oAZEHj0bJehPRUlLH9/fbpT5LfB0NhQXyALCRkRs3zH9v07IYhkgpqX6Z78FnuccZr/l4Fs4Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.24.8", + "@babel/helper-validator-identifier": "^7.24.7", + "to-fast-properties": "^2.0.0" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@bcoe/v8-coverage": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", + "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@changesets/apply-release-plan": { + "version": "7.0.13", + "resolved": "https://registry.npmjs.org/@changesets/apply-release-plan/-/apply-release-plan-7.0.13.tgz", + "integrity": "sha512-BIW7bofD2yAWoE8H4V40FikC+1nNFEKBisMECccS16W1rt6qqhNTBDmIw5HaqmMgtLNz9e7oiALiEUuKrQ4oHg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/config": "^3.1.1", + "@changesets/get-version-range-type": "^0.4.0", + "@changesets/git": "^3.0.4", + "@changesets/should-skip-package": "^0.1.2", + "@changesets/types": "^6.1.0", + "@manypkg/get-packages": "^1.1.3", + "detect-indent": "^6.0.0", + "fs-extra": "^7.0.1", + "lodash.startcase": "^4.4.0", + "outdent": "^0.5.0", + "prettier": "^2.7.1", + "resolve-from": "^5.0.0", + "semver": "^7.5.3" + } + }, + "node_modules/@changesets/apply-release-plan/node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@changesets/assemble-release-plan": { + "version": "6.0.9", + "resolved": "https://registry.npmjs.org/@changesets/assemble-release-plan/-/assemble-release-plan-6.0.9.tgz", + "integrity": "sha512-tPgeeqCHIwNo8sypKlS3gOPmsS3wP0zHt67JDuL20P4QcXiw/O4Hl7oXiuLnP9yg+rXLQ2sScdV1Kkzde61iSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/errors": "^0.2.0", + "@changesets/get-dependents-graph": "^2.1.3", + "@changesets/should-skip-package": "^0.1.2", + "@changesets/types": "^6.1.0", + "@manypkg/get-packages": "^1.1.3", + "semver": "^7.5.3" + } + }, + "node_modules/@changesets/assemble-release-plan/node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@changesets/changelog-git": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/@changesets/changelog-git/-/changelog-git-0.2.1.tgz", + "integrity": "sha512-x/xEleCFLH28c3bQeQIyeZf8lFXyDFVn1SgcBiR2Tw/r4IAWlk1fzxCEZ6NxQAjF2Nwtczoen3OA2qR+UawQ8Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/types": "^6.1.0" + } + }, + "node_modules/@changesets/changelog-github": { + "version": "0.5.1", + "resolved": "https://registry.npmjs.org/@changesets/changelog-github/-/changelog-github-0.5.1.tgz", + "integrity": "sha512-BVuHtF+hrhUScSoHnJwTELB4/INQxVFc+P/Qdt20BLiBFIHFJDDUaGsZw+8fQeJTRP5hJZrzpt3oZWh0G19rAQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/get-github-info": "^0.6.0", + "@changesets/types": "^6.1.0", + "dotenv": "^8.1.0" + } + }, + "node_modules/@changesets/cli": { + "version": "2.29.7", + "resolved": "https://registry.npmjs.org/@changesets/cli/-/cli-2.29.7.tgz", + "integrity": "sha512-R7RqWoaksyyKXbKXBTbT4REdy22yH81mcFK6sWtqSanxUCbUi9Uf+6aqxZtDQouIqPdem2W56CdxXgsxdq7FLQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/apply-release-plan": "^7.0.13", + "@changesets/assemble-release-plan": "^6.0.9", + "@changesets/changelog-git": "^0.2.1", + "@changesets/config": "^3.1.1", + "@changesets/errors": "^0.2.0", + "@changesets/get-dependents-graph": "^2.1.3", + "@changesets/get-release-plan": "^4.0.13", + "@changesets/git": "^3.0.4", + "@changesets/logger": "^0.1.1", + "@changesets/pre": "^2.0.2", + "@changesets/read": "^0.6.5", + "@changesets/should-skip-package": "^0.1.2", + "@changesets/types": "^6.1.0", + "@changesets/write": "^0.4.0", + "@inquirer/external-editor": "^1.0.0", + "@manypkg/get-packages": "^1.1.3", + "ansi-colors": "^4.1.3", + "ci-info": "^3.7.0", + "enquirer": "^2.4.1", + "fs-extra": "^7.0.1", + "mri": "^1.2.0", + "p-limit": "^2.2.0", + "package-manager-detector": "^0.2.0", + "picocolors": "^1.1.0", + "resolve-from": "^5.0.0", + "semver": "^7.5.3", + "spawndamnit": "^3.0.1", + "term-size": "^2.1.0" + }, + "bin": { + "changeset": "bin.js" + } + }, + "node_modules/@changesets/cli/node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@changesets/config": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/@changesets/config/-/config-3.1.1.tgz", + "integrity": "sha512-bd+3Ap2TKXxljCggI0mKPfzCQKeV/TU4yO2h2C6vAihIo8tzseAn2e7klSuiyYYXvgu53zMN1OeYMIQkaQoWnA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/errors": "^0.2.0", + "@changesets/get-dependents-graph": "^2.1.3", + "@changesets/logger": "^0.1.1", + "@changesets/types": "^6.1.0", + "@manypkg/get-packages": "^1.1.3", + "fs-extra": "^7.0.1", + "micromatch": "^4.0.8" + } + }, + "node_modules/@changesets/config/node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "dev": true, + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/@changesets/errors": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/@changesets/errors/-/errors-0.2.0.tgz", + "integrity": "sha512-6BLOQUscTpZeGljvyQXlWOItQyU71kCdGz7Pi8H8zdw6BI0g3m43iL4xKUVPWtG+qrrL9DTjpdn8eYuCQSRpow==", + "dev": true, + "license": "MIT", + "dependencies": { + "extendable-error": "^0.1.5" + } + }, + "node_modules/@changesets/get-dependents-graph": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/@changesets/get-dependents-graph/-/get-dependents-graph-2.1.3.tgz", + "integrity": "sha512-gphr+v0mv2I3Oxt19VdWRRUxq3sseyUpX9DaHpTUmLj92Y10AGy+XOtV+kbM6L/fDcpx7/ISDFK6T8A/P3lOdQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/types": "^6.1.0", + "@manypkg/get-packages": "^1.1.3", + "picocolors": "^1.1.0", + "semver": "^7.5.3" + } + }, + "node_modules/@changesets/get-dependents-graph/node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@changesets/get-github-info": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/@changesets/get-github-info/-/get-github-info-0.6.0.tgz", + "integrity": "sha512-v/TSnFVXI8vzX9/w3DU2Ol+UlTZcu3m0kXTjTT4KlAdwSvwutcByYwyYn9hwerPWfPkT2JfpoX0KgvCEi8Q/SA==", + "dev": true, + "license": "MIT", + "dependencies": { + "dataloader": "^1.4.0", + "node-fetch": "^2.5.0" + } + }, + "node_modules/@changesets/get-release-plan": { + "version": "4.0.13", + "resolved": "https://registry.npmjs.org/@changesets/get-release-plan/-/get-release-plan-4.0.13.tgz", + "integrity": "sha512-DWG1pus72FcNeXkM12tx+xtExyH/c9I1z+2aXlObH3i9YA7+WZEVaiHzHl03thpvAgWTRaH64MpfHxozfF7Dvg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/assemble-release-plan": "^6.0.9", + "@changesets/config": "^3.1.1", + "@changesets/pre": "^2.0.2", + "@changesets/read": "^0.6.5", + "@changesets/types": "^6.1.0", + "@manypkg/get-packages": "^1.1.3" + } + }, + "node_modules/@changesets/get-version-range-type": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/@changesets/get-version-range-type/-/get-version-range-type-0.4.0.tgz", + "integrity": "sha512-hwawtob9DryoGTpixy1D3ZXbGgJu1Rhr+ySH2PvTLHvkZuQ7sRT4oQwMh0hbqZH1weAooedEjRsbrWcGLCeyVQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@changesets/git": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@changesets/git/-/git-3.0.4.tgz", + "integrity": "sha512-BXANzRFkX+XcC1q/d27NKvlJ1yf7PSAgi8JG6dt8EfbHFHi4neau7mufcSca5zRhwOL8j9s6EqsxmT+s+/E6Sw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/errors": "^0.2.0", + "@manypkg/get-packages": "^1.1.3", + "is-subdir": "^1.1.1", + "micromatch": "^4.0.8", + "spawndamnit": "^3.0.1" + } + }, + "node_modules/@changesets/git/node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "dev": true, + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/@changesets/logger": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/@changesets/logger/-/logger-0.1.1.tgz", + "integrity": "sha512-OQtR36ZlnuTxKqoW4Sv6x5YIhOmClRd5pWsjZsddYxpWs517R0HkyiefQPIytCVh4ZcC5x9XaG8KTdd5iRQUfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "picocolors": "^1.1.0" + } + }, + "node_modules/@changesets/parse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@changesets/parse/-/parse-0.4.1.tgz", + "integrity": "sha512-iwksMs5Bf/wUItfcg+OXrEpravm5rEd9Bf4oyIPL4kVTmJQ7PNDSd6MDYkpSJR1pn7tz/k8Zf2DhTCqX08Ou+Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/types": "^6.1.0", + "js-yaml": "^3.13.1" + } + }, + "node_modules/@changesets/pre": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/@changesets/pre/-/pre-2.0.2.tgz", + "integrity": "sha512-HaL/gEyFVvkf9KFg6484wR9s0qjAXlZ8qWPDkTyKF6+zqjBe/I2mygg3MbpZ++hdi0ToqNUF8cjj7fBy0dg8Ug==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/errors": "^0.2.0", + "@changesets/types": "^6.1.0", + "@manypkg/get-packages": "^1.1.3", + "fs-extra": "^7.0.1" + } + }, + "node_modules/@changesets/read": { + "version": "0.6.5", + "resolved": "https://registry.npmjs.org/@changesets/read/-/read-0.6.5.tgz", + "integrity": "sha512-UPzNGhsSjHD3Veb0xO/MwvasGe8eMyNrR/sT9gR8Q3DhOQZirgKhhXv/8hVsI0QpPjR004Z9iFxoJU6in3uGMg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/git": "^3.0.4", + "@changesets/logger": "^0.1.1", + "@changesets/parse": "^0.4.1", + "@changesets/types": "^6.1.0", + "fs-extra": "^7.0.1", + "p-filter": "^2.1.0", + "picocolors": "^1.1.0" + } + }, + "node_modules/@changesets/should-skip-package": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/@changesets/should-skip-package/-/should-skip-package-0.1.2.tgz", + "integrity": "sha512-qAK/WrqWLNCP22UDdBTMPH5f41elVDlsNyat180A33dWxuUDyNpg6fPi/FyTZwRriVjg0L8gnjJn2F9XAoF0qw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/types": "^6.1.0", + "@manypkg/get-packages": "^1.1.3" + } + }, + "node_modules/@changesets/types": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/@changesets/types/-/types-6.1.0.tgz", + "integrity": "sha512-rKQcJ+o1nKNgeoYRHKOS07tAMNd3YSN0uHaJOZYjBAgxfV7TUE7JE+z4BzZdQwb5hKaYbayKN5KrYV7ODb2rAA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@changesets/write": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/@changesets/write/-/write-0.4.0.tgz", + "integrity": "sha512-CdTLvIOPiCNuH71pyDu3rA+Q0n65cmAbXnwWH84rKGiFumFzkmHNT8KHTMEchcxN+Kl8I54xGUhJ7l3E7X396Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@changesets/types": "^6.1.0", + "fs-extra": "^7.0.1", + "human-id": "^4.1.1", + "prettier": "^2.7.1" + } + }, + "node_modules/@eslint-community/eslint-utils": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.4.0.tgz", + "integrity": "sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-visitor-keys": "^3.3.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" + } + }, + "node_modules/@eslint-community/regexpp": { + "version": "4.10.1", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.10.1.tgz", + "integrity": "sha512-Zm2NGpWELsQAD1xsJzGQpYfvICSsFkEpU0jxBjfdC6uNEWXcHnfs9hScFWtXVDVl+rBQJGrl4g1vcKIejpH9dA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.0.0 || ^14.0.0 || >=16.0.0" + } + }, + "node_modules/@eslint/eslintrc": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.4.tgz", + "integrity": "sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ajv": "^6.12.4", + "debug": "^4.3.2", + "espree": "^9.6.0", + "globals": "^13.19.0", + "ignore": "^5.2.0", + "import-fresh": "^3.2.1", + "js-yaml": "^4.1.0", + "minimatch": "^3.1.2", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/@eslint/eslintrc/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true, + "license": "Python-2.0" + }, + "node_modules/@eslint/eslintrc/node_modules/globals": { + "version": "13.24.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", + "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@eslint/eslintrc/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@eslint/js": { + "version": "8.57.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.0.tgz", + "integrity": "sha512-Ys+3g2TaW7gADOJzPt83SJtCDhMjndcDMFVQ/Tj9iA1BfJzFKD9mAUXT3OenpuPHbI6P/myECxRJrofUsDx/5g==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/@faker-js/faker": { + "version": "8.4.1", + "resolved": "https://registry.npmjs.org/@faker-js/faker/-/faker-8.4.1.tgz", + "integrity": "sha512-XQ3cU+Q8Uqmrbf2e0cIC/QN43sTBSC8KF12u29Mb47tWrt2hAgBXSgpZMj4Ao8Uk0iJcU99QsOCaIL8934obCg==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/fakerjs" + } + ], + "license": "MIT", + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0", + "npm": ">=6.14.13" + } + }, + "node_modules/@humanwhocodes/config-array": { + "version": "0.11.14", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.14.tgz", + "integrity": "sha512-3T8LkOmg45BV5FICb15QQMsyUSWrQ8AygVfC7ZG32zOalnqrilm018ZVCw0eapXux8FtA33q8PSRSstjee3jSg==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@humanwhocodes/object-schema": "^2.0.2", + "debug": "^4.3.1", + "minimatch": "^3.0.5" + }, + "engines": { + "node": ">=10.10.0" + } + }, + "node_modules/@humanwhocodes/module-importer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", + "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=12.22" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/nzakas" + } + }, + "node_modules/@humanwhocodes/object-schema": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-2.0.3.tgz", + "integrity": "sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/@inquirer/external-editor": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@inquirer/external-editor/-/external-editor-1.0.2.tgz", + "integrity": "sha512-yy9cOoBnx58TlsPrIxauKIFQTiyH+0MK4e97y4sV9ERbI+zDxw7i2hxHLCIEGIE/8PPvDxGhgzIOTSOWcs6/MQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "chardet": "^2.1.0", + "iconv-lite": "^0.7.0" + }, + "engines": { + "node": ">=18" + }, + "peerDependencies": { + "@types/node": ">=18" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + } + } + }, + "node_modules/@istanbuljs/load-nyc-config": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", + "integrity": "sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ==", + "dev": true, + "license": "ISC", + "dependencies": { + "camelcase": "^5.3.1", + "find-up": "^4.1.0", + "get-package-type": "^0.1.0", + "js-yaml": "^3.13.1", + "resolve-from": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/@istanbuljs/schema": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", + "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/@jest/console": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-27.5.1.tgz", + "integrity": "sha512-kZ/tNpS3NXn0mlXXXPNuDZnb4c0oZ20r4K5eemM2k30ZC3G0T02nXUvyhf5YdbXWHPEJLc9qGLxEZ216MdL+Zg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "jest-message-util": "^27.5.1", + "jest-util": "^27.5.1", + "slash": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/core": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/core/-/core-27.5.1.tgz", + "integrity": "sha512-AK6/UTrvQD0Cd24NSqmIA6rKsu0tKIxfiCducZvqxYdmMisOYAsdItspT+fQDQYARPf8XgjAFZi0ogW2agH5nQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^27.5.1", + "@jest/reporters": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "ansi-escapes": "^4.2.1", + "chalk": "^4.0.0", + "emittery": "^0.8.1", + "exit": "^0.1.2", + "graceful-fs": "^4.2.9", + "jest-changed-files": "^27.5.1", + "jest-config": "^27.5.1", + "jest-haste-map": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-resolve-dependencies": "^27.5.1", + "jest-runner": "^27.5.1", + "jest-runtime": "^27.5.1", + "jest-snapshot": "^27.5.1", + "jest-util": "^27.5.1", + "jest-validate": "^27.5.1", + "jest-watcher": "^27.5.1", + "micromatch": "^4.0.4", + "rimraf": "^3.0.0", + "slash": "^3.0.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/@jest/core/node_modules/jest-watcher": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-27.5.1.tgz", + "integrity": "sha512-z676SuD6Z8o8qbmEGhoEUFOM1+jfEiL3DXHK/xgEiG2EyNYfFG60jluWcupY6dATjfEsKQuibReS1djInQnoVw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/test-result": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "ansi-escapes": "^4.2.1", + "chalk": "^4.0.0", + "jest-util": "^27.5.1", + "string-length": "^4.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/environment": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-27.5.1.tgz", + "integrity": "sha512-/WQjhPJe3/ghaol/4Bq480JKXV/Rfw8nQdN7f41fM8VDHLcxKXou6QyXAh3EFr9/bVG3x74z1NWDkP87EiY8gA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/fake-timers": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "jest-mock": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/fake-timers": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-27.5.1.tgz", + "integrity": "sha512-/aPowoolwa07k7/oM3aASneNeBGCmGQsc3ugN4u6s4C/+s5M64MFo/+djTdiwcbQlRfFElGuDXWzaWj6QgKObQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@sinonjs/fake-timers": "^8.0.1", + "@types/node": "*", + "jest-message-util": "^27.5.1", + "jest-mock": "^27.5.1", + "jest-util": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/globals": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/globals/-/globals-27.5.1.tgz", + "integrity": "sha512-ZEJNB41OBQQgGzgyInAv0UUfDDj3upmHydjieSxFvTRuZElrx7tXg/uVQ5hYVEwiXs3+aMsAeEc9X7xiSKCm4Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/types": "^27.5.1", + "expect": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/reporters": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-27.5.1.tgz", + "integrity": "sha512-cPXh9hWIlVJMQkVk84aIvXuBB4uQQmFqZiacloFuGiP3ah1sbCxCosidXFDfqG8+6fO1oR2dTJTlsOy4VFmUfw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@bcoe/v8-coverage": "^0.2.3", + "@jest/console": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "collect-v8-coverage": "^1.0.0", + "exit": "^0.1.2", + "glob": "^7.1.2", + "graceful-fs": "^4.2.9", + "istanbul-lib-coverage": "^3.0.0", + "istanbul-lib-instrument": "^5.1.0", + "istanbul-lib-report": "^3.0.0", + "istanbul-lib-source-maps": "^4.0.0", + "istanbul-reports": "^3.1.3", + "jest-haste-map": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-util": "^27.5.1", + "jest-worker": "^27.5.1", + "slash": "^3.0.0", + "source-map": "^0.6.0", + "string-length": "^4.0.1", + "terminal-link": "^2.0.0", + "v8-to-istanbul": "^8.1.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/@jest/schemas": { + "version": "28.1.3", + "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-28.1.3.tgz", + "integrity": "sha512-/l/VWsdt/aBXgjshLWOFyFt3IVdYypu5y2Wn2rOO1un6nkqIn8SLXzgIMYXFyYsRWDyF5EthmKJMIdJvk08grg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@sinclair/typebox": "^0.24.1" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + } + }, + "node_modules/@jest/source-map": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-27.5.1.tgz", + "integrity": "sha512-y9NIHUYF3PJRlHk98NdC/N1gl88BL08aQQgu4k4ZopQkCw9t9cV8mtl3TV8b/YCB8XaVTFrmUTAJvjsntDireg==", + "dev": true, + "license": "MIT", + "dependencies": { + "callsites": "^3.0.0", + "graceful-fs": "^4.2.9", + "source-map": "^0.6.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/test-result": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-27.5.1.tgz", + "integrity": "sha512-EW35l2RYFUcUQxFJz5Cv5MTOxlJIQs4I7gxzi2zVU7PJhOwfYq1MdC5nhSmYjX1gmMmLPvB3sIaC+BkcHRBfag==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/istanbul-lib-coverage": "^2.0.0", + "collect-v8-coverage": "^1.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/test-sequencer": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-27.5.1.tgz", + "integrity": "sha512-LCheJF7WB2+9JuCS7VB/EmGIdQuhtqjRNI9A43idHv3E4KltCTsPsLxvdaubFHSYwY/fNjMWjl6vNRhDiN7vpQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/test-result": "^27.5.1", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^27.5.1", + "jest-runtime": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/transform": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-27.5.1.tgz", + "integrity": "sha512-ipON6WtYgl/1329g5AIJVbUuEh0wZVbdpGwC99Jw4LwuoBNS95MVphU6zOeD9pDkon+LLbFL7lOQRapbB8SCHw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.1.0", + "@jest/types": "^27.5.1", + "babel-plugin-istanbul": "^6.1.1", + "chalk": "^4.0.0", + "convert-source-map": "^1.4.0", + "fast-json-stable-stringify": "^2.0.0", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-util": "^27.5.1", + "micromatch": "^4.0.4", + "pirates": "^4.0.4", + "slash": "^3.0.0", + "source-map": "^0.6.1", + "write-file-atomic": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jest/types": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-27.5.1.tgz", + "integrity": "sha512-Cx46iJ9QpwQTjIdq5VJu2QTMMs3QlEjI0x1QbBP5W1+nMzyc2XmimiRR/CbX9TO0cPTeUlxWMOu8mslYsJ8DEw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-coverage": "^2.0.0", + "@types/istanbul-reports": "^3.0.0", + "@types/node": "*", + "@types/yargs": "^16.0.0", + "chalk": "^4.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.5.tgz", + "integrity": "sha512-IzL8ZoEDIBRWEzlCcRhOaCupYyN5gdIK+Q6fbFdPDg6HqX6jpkItn7DFIpW9LQzXG6Df9sA7+OKnq0qlz/GaQg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/set-array": "^1.2.1", + "@jridgewell/sourcemap-codec": "^1.4.10", + "@jridgewell/trace-mapping": "^0.3.24" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/set-array": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", + "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.4.15", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz", + "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.25", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", + "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@manypkg/find-root": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@manypkg/find-root/-/find-root-1.1.0.tgz", + "integrity": "sha512-mki5uBvhHzO8kYYix/WRy2WX8S3B5wdVSc9D6KcU5lQNglP2yt58/VfLuAK49glRXChosY8ap2oJ1qgma3GUVA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.5.5", + "@types/node": "^12.7.1", + "find-up": "^4.1.0", + "fs-extra": "^8.1.0" + } + }, + "node_modules/@manypkg/find-root/node_modules/@types/node": { + "version": "12.20.55", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.55.tgz", + "integrity": "sha512-J8xLz7q2OFulZ2cyGTLE1TbbZcjpno7FaN6zdJNrgAdrJ+DZzh/uFR6YrTb4C+nXakvud8Q4+rbhoIWlYQbUFQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@manypkg/find-root/node_modules/fs-extra": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", + "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, + "node_modules/@manypkg/get-packages": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/@manypkg/get-packages/-/get-packages-1.1.3.tgz", + "integrity": "sha512-fo+QhuU3qE/2TQMQmbVMqaQ6EWbMhi4ABWP+O4AM1NqPBuy0OrApV5LO6BrrgnhtAHS2NH6RrVk9OL181tTi8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.5.5", + "@changesets/types": "^4.0.1", + "@manypkg/find-root": "^1.1.0", + "fs-extra": "^8.1.0", + "globby": "^11.0.0", + "read-yaml-file": "^1.1.0" + } + }, + "node_modules/@manypkg/get-packages/node_modules/@changesets/types": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@changesets/types/-/types-4.1.0.tgz", + "integrity": "sha512-LDQvVDv5Kb50ny2s25Fhm3d9QSZimsoUGBsUioj6MC3qbMUCuC8GPIvk/M6IvXx3lYhAs0lwWUQLb+VIEUCECw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@manypkg/get-packages/node_modules/fs-extra": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", + "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, + "node_modules/@nicolo-ribaudo/eslint-scope-5-internals": { + "version": "5.1.1-v1", + "resolved": "https://registry.npmjs.org/@nicolo-ribaudo/eslint-scope-5-internals/-/eslint-scope-5-internals-5.1.1-v1.tgz", + "integrity": "sha512-54/JRvkLIzzDWshCWfuhadfrfZVPiElY8Fcgmg1HroEly/EDSszzhBAsarCux+D/kOslTRquNzuyGSmUSTTHGg==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-scope": "5.1.1" + } + }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@preact/signals": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/@preact/signals/-/signals-2.3.1.tgz", + "integrity": "sha512-nyuRIGmcwM/HjvFHhN2xUWfyla9D4llHt+prWoxjQfD6b5prO7CFPlG/xjJkP31Oic4KQXfH9SIhJFP9cy4lmg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@preact/signals-core": "^1.12.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + }, + "peerDependencies": { + "preact": ">= 10.25.0 || >=11.0.0-0" + } + }, + "node_modules/@preact/signals-core": { + "version": "1.12.1", + "resolved": "https://registry.npmjs.org/@preact/signals-core/-/signals-core-1.12.1.tgz", + "integrity": "sha512-BwbTXpj+9QutoZLQvbttRg5x3l5468qaV2kufh+51yha1c53ep5dY4kTuZR35+3pAZxpfQerGJiQqg34ZNZ6uA==", + "dev": true, + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/@quilted/preact-testing": { + "version": "0.1.8", + "resolved": "https://registry.npmjs.org/@quilted/preact-testing/-/preact-testing-0.1.8.tgz", + "integrity": "sha512-DqLMj2+Ht6ePzmCrkUBQhiOqqE/cpV/ctiYhOz9oircSqUFx3wFEVEAVaAxhi+3a1JOfJ8zj8n/kBNIiZ/CkNg==", + "dev": true, + "license": "MIT", + "dependencies": { + "jest-matcher-utils": "^27.0.0" + }, + "peerDependencies": { + "preact": "^10.26.0" + }, + "peerDependenciesMeta": { + "preact": { + "optional": true + } + } + }, + "node_modules/@quilted/react-testing": { + "version": "0.6.12", + "resolved": "https://registry.npmjs.org/@quilted/react-testing/-/react-testing-0.6.12.tgz", + "integrity": "sha512-UkiVWEUKvN0DspZ+tjQLHUV9qq5vZJSOTM2DbMkWg6MKgF/8vQmpKyZqQ2DcOg9DNIl6XOqXJMvWhb9fqheE/w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@quilted/preact-testing": "^0.1.8", + "jest-matcher-utils": "^27.0.0" + }, + "peerDependencies": { + "preact": "^10.26.0", + "react": "^19.0.0", + "react-dom": "^19.0.0", + "react-test-renderer": "^19.0.0" + }, + "peerDependenciesMeta": { + "preact": { + "optional": true + }, + "react": { + "optional": true + }, + "react-dom": { + "optional": true + }, + "react-test-renderer": { + "optional": true + } + } + }, + "node_modules/@remote-ui/async-subscription": { + "version": "2.1.16", + "resolved": "https://registry.npmjs.org/@remote-ui/async-subscription/-/async-subscription-2.1.16.tgz", + "integrity": "sha512-1DPxo+febMhJvHT44Oe1EMFubOAA+EpfToJvQG/6x7brVx1UKF7k47n3tQR5NDM+gNlDgxT1dEnALOeqYA80mQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@remote-ui/rpc": "^1.4.5" + } + }, + "node_modules/@remote-ui/rpc": { + "version": "1.4.5", + "resolved": "https://registry.npmjs.org/@remote-ui/rpc/-/rpc-1.4.5.tgz", + "integrity": "sha512-Cr+06niG/vmE4A9YsmaKngRuuVSWKMY42NMwtZfy+gctRWGu6Wj9BWuMJg5CEp+JTkRBPToqT5rqnrg1G/Wvow==", + "dev": true, + "license": "MIT" + }, + "node_modules/@rollup/plugin-babel": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/@rollup/plugin-babel/-/plugin-babel-5.3.1.tgz", + "integrity": "sha512-WFfdLWU/xVWKeRQnKmIAQULUI7Il0gZnBIH/ZFO069wYIfPu+8zrfp/KMW0atmELoRDq8FbiP3VCss9MhCut7Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-module-imports": "^7.10.4", + "@rollup/pluginutils": "^3.1.0" + }, + "engines": { + "node": ">= 10.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0", + "@types/babel__core": "^7.1.9", + "rollup": "^1.20.0||^2.0.0" + }, + "peerDependenciesMeta": { + "@types/babel__core": { + "optional": true + } + } + }, + "node_modules/@rollup/plugin-commonjs": { + "version": "19.0.2", + "resolved": "https://registry.npmjs.org/@rollup/plugin-commonjs/-/plugin-commonjs-19.0.2.tgz", + "integrity": "sha512-gBjarfqlC7qs0AutpRW/hrFNm+cd2/QKxhwyFa+srbg1oX7rDsEU3l+W7LAUhsAp9mPJMAkXDhLbQaVwEaE8bA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@rollup/pluginutils": "^3.1.0", + "commondir": "^1.0.1", + "estree-walker": "^2.0.1", + "glob": "^7.1.6", + "is-reference": "^1.2.1", + "magic-string": "^0.25.7", + "resolve": "^1.17.0" + }, + "engines": { + "node": ">= 8.0.0" + }, + "peerDependencies": { + "rollup": "^2.38.3" + } + }, + "node_modules/@rollup/plugin-commonjs/node_modules/magic-string": { + "version": "0.25.9", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", + "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "sourcemap-codec": "^1.4.8" + } + }, + "node_modules/@rollup/plugin-node-resolve": { + "version": "13.3.0", + "resolved": "https://registry.npmjs.org/@rollup/plugin-node-resolve/-/plugin-node-resolve-13.3.0.tgz", + "integrity": "sha512-Lus8rbUo1eEcnS4yTFKLZrVumLPY+YayBdWXgFSHYhTT2iJbMhoaaBL3xl5NCdeRytErGr8tZ0L71BMRmnlwSw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@rollup/pluginutils": "^3.1.0", + "@types/resolve": "1.17.1", + "deepmerge": "^4.2.2", + "is-builtin-module": "^3.1.0", + "is-module": "^1.0.0", + "resolve": "^1.19.0" + }, + "engines": { + "node": ">= 10.0.0" + }, + "peerDependencies": { + "rollup": "^2.42.0" + } + }, + "node_modules/@rollup/plugin-replace": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/@rollup/plugin-replace/-/plugin-replace-6.0.1.tgz", + "integrity": "sha512-2sPh9b73dj5IxuMmDAsQWVFT7mR+yoHweBaXG2W/R8vQ+IWZlnaI7BR7J6EguVQUp1hd8Z7XuozpDjEKQAAC2Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@rollup/pluginutils": "^5.0.1", + "magic-string": "^0.30.3" + }, + "engines": { + "node": ">=14.0.0" + }, + "peerDependencies": { + "rollup": "^1.20.0||^2.0.0||^3.0.0||^4.0.0" + }, + "peerDependenciesMeta": { + "rollup": { + "optional": true + } + } + }, + "node_modules/@rollup/plugin-replace/node_modules/@rollup/pluginutils": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.1.2.tgz", + "integrity": "sha512-/FIdS3PyZ39bjZlwqFnWqCOVnW7o963LtKMwQOD0NhQqw22gSr2YY1afu3FxRip4ZCZNsD5jq6Aaz6QV3D/Njw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "^1.0.0", + "estree-walker": "^2.0.2", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=14.0.0" + }, + "peerDependencies": { + "rollup": "^1.20.0||^2.0.0||^3.0.0||^4.0.0" + }, + "peerDependenciesMeta": { + "rollup": { + "optional": true + } + } + }, + "node_modules/@rollup/plugin-replace/node_modules/@types/estree": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", + "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@rollup/pluginutils": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-3.1.0.tgz", + "integrity": "sha512-GksZ6pr6TpIjHm8h9lSQ8pi8BE9VeubNT0OMJ3B5uZJ8pz73NPiqOtCog/x2/QzM1ENChPKxMDhiQuRHsqc+lg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "0.0.39", + "estree-walker": "^1.0.1", + "picomatch": "^2.2.2" + }, + "engines": { + "node": ">= 8.0.0" + }, + "peerDependencies": { + "rollup": "^1.20.0||^2.0.0" + } + }, + "node_modules/@rollup/pluginutils/node_modules/estree-walker": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-1.0.1.tgz", + "integrity": "sha512-1fMXF3YP4pZZVozF8j/ZLfvnR8NSIljt56UhbZ5PeeDmmGHpgpdwQt7ITlGvYaQukCvuBRMLEiKiYC+oeIg4cg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@shopify/babel-preset": { + "version": "24.1.5", + "resolved": "https://registry.npmjs.org/@shopify/babel-preset/-/babel-preset-24.1.5.tgz", + "integrity": "sha512-IJJoSXU2/WJDzXsj5V5QagcCLnxJ8bRTegRkX7yhvesVhZ4mFUKlustrUH7T64O9l8qQ/MEF996lkqfgJuDCkQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.16.0", + "@babel/plugin-proposal-class-properties": "^7.16.0", + "@babel/plugin-proposal-decorators": "^7.16.4", + "@babel/plugin-proposal-dynamic-import": "^7.16.0", + "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.0", + "@babel/plugin-proposal-numeric-separator": "^7.16.0", + "@babel/plugin-proposal-optional-chaining": "^7.16.0", + "@babel/plugin-proposal-private-methods": "^7.16.0", + "@babel/plugin-transform-modules-commonjs": "^7.16.0", + "@babel/plugin-transform-react-constant-elements": "^7.16.0", + "@babel/plugin-transform-runtime": "^7.16.4", + "@babel/preset-env": "^7.16.4", + "@babel/preset-react": "^7.16.0", + "@babel/preset-typescript": "^7.16.0", + "@babel/runtime": "^7.16.3", + "babel-plugin-react-test-id": "^1.0.2", + "babel-plugin-transform-inline-environment-variables": "^0.4.3" + } + }, + "node_modules/@shopify/browserslist-config": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@shopify/browserslist-config/-/browserslist-config-3.0.0.tgz", + "integrity": "sha512-NzZTZ8EEG6xmM1ApSsQFDqW6C5CmByNhXyLxwWjVX08GzHxkhMc10MSY7WGvTCzd1lQuZEp8Ko/jOCBTQQsEGg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@shopify/eslint-plugin": { + "version": "42.1.0", + "resolved": "https://registry.npmjs.org/@shopify/eslint-plugin/-/eslint-plugin-42.1.0.tgz", + "integrity": "sha512-b45SXfXoE9+BvQjHrhInWlOMhsXrqIzts+setaXecR5WW6NcEKeeSfHvTvLVk231NHnrE5h+MuHp1Ci1pR5nfA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/eslint-parser": "^7.16.3", + "@babel/eslint-plugin": "^7.14.5", + "@typescript-eslint/eslint-plugin": "^5.4.0", + "@typescript-eslint/parser": "^5.4.0", + "change-case": "^4.1.2", + "common-tags": "^1.8.2", + "doctrine": "^2.1.0", + "eslint-config-prettier": "^8.3.0", + "eslint-module-utils": "^2.7.1", + "eslint-plugin-eslint-comments": "^3.2.0", + "eslint-plugin-import": "^2.26.0", + "eslint-plugin-jest": "^25.3.0", + "eslint-plugin-jest-formatting": "^3.1.0", + "eslint-plugin-jsx-a11y": "^6.5.0", + "eslint-plugin-node": "^11.1.0", + "eslint-plugin-prettier": "^4.1.0", + "eslint-plugin-promise": "^6.0.0", + "eslint-plugin-react": "^7.30.0", + "eslint-plugin-react-hooks": "^4.3.0", + "eslint-plugin-sort-class-members": "^1.14.0", + "jsx-ast-utils": "^3.2.1", + "pkg-dir": "^5.0.0", + "pluralize": "^8.0.0" + }, + "peerDependencies": { + "eslint": "^8.3.0" + } + }, + "node_modules/@shopify/generate-docs": { + "version": "1.0.0", + "resolved": "https://npm.shopify.io/node/@shopify/generate-docs/-/generate-docs-1.0.0.tgz", + "integrity": "sha512-DOkWeqGjVg3xxS6slNuyYpegvRLMn1o9VPwZm1fIzsRsJRAHy12TZM3Bq3yMimx5IU3J34y+iD/jPb/S/gFU5g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/react": "^18.0.21", + "globby": "^11.1.0", + "typescript": "^4.8.3 || ^5.0.0" + }, + "bin": { + "compare-docs": "bin/compare-docs.js", + "generate-docs": "bin/generate-docs.js", + "scaffold-docs": "bin/scaffold-docs.js", + "set-up-config": "bin/set-up-config.js", + "set-up-docs": "bin/set-up-docs.js" + } + }, + "node_modules/@shopify/generate-docs/node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/@shopify/loom": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@shopify/loom/-/loom-1.0.2.tgz", + "integrity": "sha512-kbvl3upG51QVvPVe1NLtnpZZeUZWRfVGtE0ZUOqcTjvnS4Blugw/0GoLxDmhhrQFY5fY3cQokJsDpslopWz/Jw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/preset-env": "^7.14.5", + "@babel/preset-typescript": "^7.14.5", + "@babel/register": "^7.14.5", + "@types/fs-extra": "^9.0.0", + "@types/glob": "^7.1.1", + "change-case": "^4.1.0", + "fs-extra": "^9.0.0", + "glob": "^7.1.6" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/@shopify/loom-cli": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@shopify/loom-cli/-/loom-cli-1.1.0.tgz", + "integrity": "sha512-TsilrMqCRX1gztwfUmuxqDUf/z4Ofa5tk8JD3x4E3cRNp+J4zmQamIqsZqib7cdqIecxIEPnuJ+nDSssSeQFeg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/loom": "^1.0.2", + "@types/signal-exit": "^3.0.0", + "ansi-escapes": "^4.3.1", + "chalk": "^4.0.0", + "execa": "^4.0.0", + "signal-exit": "^3.0.3", + "supports-hyperlinks": "^2.1.0", + "yargs": "^17.2.1" + }, + "bin": { + "loom": "bin/loom" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/@shopify/loom-cli/node_modules/execa": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-4.1.0.tgz", + "integrity": "sha512-j5W0//W7f8UxAn8hXVnwG8tLwdiUy4FJLcSupCg6maBYZDpyBvTApK7KyuI4bKj8KOh1r2YH+6ucuYtJv1bTZA==", + "dev": true, + "license": "MIT", + "dependencies": { + "cross-spawn": "^7.0.0", + "get-stream": "^5.0.0", + "human-signals": "^1.1.1", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.0", + "onetime": "^5.1.0", + "signal-exit": "^3.0.2", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/@shopify/loom-cli/node_modules/get-stream": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", + "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", + "dev": true, + "license": "MIT", + "dependencies": { + "pump": "^3.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@shopify/loom-cli/node_modules/human-signals": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-1.1.1.tgz", + "integrity": "sha512-SEQu7vl8KjNL2eoGBLF3+wAjpsNfA9XMlXAYj/3EdaNfAlxKthD1xjEQfGOUhllCGGJVNY34bRr6lPINhNjyZw==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=8.12.0" + } + }, + "node_modules/@shopify/loom-plugin-babel": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@shopify/loom-plugin-babel/-/loom-plugin-babel-1.0.2.tgz", + "integrity": "sha512-/1elnwjztldaQ60QNGm0Hg099cWO5VjQ/yVY+l49UEWxsb1NWWpn6DxNB4+PbiER3w5pY9NUyiEIPmvXpZHVtA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/loom": "^1.0.2", + "@types/babel__core": "^7.1.7", + "core-js": "^3.14.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.14.6" + }, + "peerDependenciesMeta": { + "@babel/core": { + "optional": true + } + } + }, + "node_modules/@shopify/loom-plugin-build-library": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@shopify/loom-plugin-build-library/-/loom-plugin-build-library-1.0.3.tgz", + "integrity": "sha512-dUHSc6a2o/gTr7UQR3CZfXXIF4+q3C1/NsU7WDDWFAPANHKigkEdh6DTNSmG9QiA20Hfi8vnBC6wfOPissZL9A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@rollup/plugin-babel": "^5.3.0", + "@rollup/plugin-commonjs": "^19.0.0", + "@rollup/plugin-node-resolve": "^13.0.0", + "@shopify/babel-preset": "^24.1.4", + "@shopify/loom": "^1.0.2", + "@shopify/loom-plugin-babel": "^1.0.2", + "@shopify/loom-plugin-jest": "^1.0.2", + "@shopify/loom-plugin-rollup": "^1.0.2", + "@shopify/loom-plugin-typescript": "^1.1.1", + "babel-jest": "^27.2.4", + "common-ancestor-path": "^1.0.1", + "rollup-plugin-node-externals": "^2.2.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + }, + "peerDependenciesMeta": { + "@babel/core": { + "optional": true + } + } + }, + "node_modules/@shopify/loom-plugin-eslint": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@shopify/loom-plugin-eslint/-/loom-plugin-eslint-2.0.1.tgz", + "integrity": "sha512-Jw7RQy+y9UTI749KwTovXw5JJUPTFGNQTDkR4tV87/EMAyX/ofY6Hik9v7DgRVhIEiDHqHDvxa89EuFEJJ67Ww==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/loom": "^1.0.2" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "eslint": ">=7.0.0" + } + }, + "node_modules/@shopify/loom-plugin-jest": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@shopify/loom-plugin-jest/-/loom-plugin-jest-1.0.2.tgz", + "integrity": "sha512-NcKTeItd/JpSdSTJeUTvDuciRqw/fSz3sy4h8iiSXo3cJovXnVLJLdA4qzGhvXHtQNaHYLJDb7oAUnPy5jgGHw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/loom": "^1.0.2", + "@types/jest": "^27.0.2", + "jest": "^27.2.4", + "jest-watch-typeahead": "^1.0.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/@shopify/loom-plugin-prettier": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@shopify/loom-plugin-prettier/-/loom-plugin-prettier-2.0.1.tgz", + "integrity": "sha512-MP9PG7/WN0n0AaSBNhmCT9A54x2j3CQ9DodAdNBRbPl0swJg9GcHEuFu7DLtMN1v9udI9phAuF96b8hg+IpYng==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/loom": "^1.0.2" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "prettier": ">=2.0.0" + } + }, + "node_modules/@shopify/loom-plugin-rollup": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@shopify/loom-plugin-rollup/-/loom-plugin-rollup-1.0.2.tgz", + "integrity": "sha512-zZW5LwhXmHdrgwJOmklcCuE+T/34YL7hw784eCBgru2yBKYjvO+rvheUKkxfULF4PItxixGoa8weVPIay43O6g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/loom": "^1.0.2", + "rollup": "^2.60.1" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/@shopify/loom-plugin-typescript": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@shopify/loom-plugin-typescript/-/loom-plugin-typescript-1.1.1.tgz", + "integrity": "sha512-DSZ41Eq/RIHl3zhHILBowGn83T9Jyx7seH/iCT/ZLaPfBgHmjSLea8iADLuF8SUsRIibjmdhiz0hplgoARJhsg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shopify/loom": "^1.0.2", + "typescript": "^4.3.5" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, + "node_modules/@shopify/loom/node_modules/fs-extra": { + "version": "9.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", + "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "at-least-node": "^1.0.0", + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@shopify/loom/node_modules/jsonfile": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", + "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/@shopify/loom/node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/@shopify/typescript-configs": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@shopify/typescript-configs/-/typescript-configs-5.1.0.tgz", + "integrity": "sha512-RywGBTR+nQyJLxcrUcihPkHPIG3pIQI6i0YwMrM5rs9nWJ0+9A5HKEcboyGPLH+8V08EXGfFQ6H820O9ajyk4A==", + "dev": true, + "license": "MIT" + }, + "node_modules/@shopify/ui-extensions": { + "resolved": "packages/ui-extensions", + "link": true + }, + "node_modules/@sinclair/typebox": { + "version": "0.24.51", + "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.24.51.tgz", + "integrity": "sha512-1P1OROm/rdubP5aFDSZQILU0vrLCJ4fvHt6EoqHEM+2D/G5MK3bIaymUKLit8Js9gbns5UyJnkP/TZROLw4tUA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@sinonjs/commons": { + "version": "1.8.6", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.6.tgz", + "integrity": "sha512-Ky+XkAkqPZSm3NLBeUng77EBQl3cmeJhITaGHdYH8kjVB+aun3S4XBRti2zt17mtt0mIUDiNxYeoJm6drVvBJQ==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "type-detect": "4.0.8" + } + }, + "node_modules/@sinonjs/fake-timers": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-8.1.0.tgz", + "integrity": "sha512-OAPJUAtgeINhh/TAlUID4QTs53Njm7xzddaVlEs/SXwgtiD1tW22zAB/W1wdqfrpmikgaWQ9Fw6Ws+hsiRm5Vg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@sinonjs/commons": "^1.7.0" + } + }, + "node_modules/@tootallnate/once": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-1.1.2.tgz", + "integrity": "sha512-RbzJvlNzmRq5c3O09UipeuXno4tA1FE6ikOjxZK0tuxVv3412l64l5t1W5pj4+rJq9vpkm/kwiR07aZXnsKPxw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/@ts-morph/common": { + "version": "0.26.1", + "resolved": "https://registry.npmjs.org/@ts-morph/common/-/common-0.26.1.tgz", + "integrity": "sha512-Sn28TGl/4cFpcM+jwsH1wLncYq3FtN/BIpem+HOygfBWPT5pAeS5dB4VFVzV8FbnOKHpDLZmvAl4AjPEev5idA==", + "license": "MIT", + "dependencies": { + "fast-glob": "^3.3.2", + "minimatch": "^9.0.4", + "path-browserify": "^1.0.1" + } + }, + "node_modules/@ts-morph/common/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/@ts-morph/common/node_modules/fast-glob": { + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.8" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/@ts-morph/common/node_modules/micromatch": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/@ts-morph/common/node_modules/minimatch": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/@types/babel__core": { + "version": "7.20.5", + "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", + "integrity": "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.20.7", + "@babel/types": "^7.20.7", + "@types/babel__generator": "*", + "@types/babel__template": "*", + "@types/babel__traverse": "*" + } + }, + "node_modules/@types/babel__generator": { + "version": "7.6.8", + "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.6.8.tgz", + "integrity": "sha512-ASsj+tpEDsEiFr1arWrlN6V3mdfjRMZt6LtK/Vp/kreFLnr5QH5+DhvD5nINYZXzwJvXeGq+05iUXcAzVrqWtw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__template": { + "version": "7.4.4", + "resolved": "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.4.tgz", + "integrity": "sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.1.0", + "@babel/types": "^7.0.0" + } + }, + "node_modules/@types/babel__traverse": { + "version": "7.20.6", + "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.20.6.tgz", + "integrity": "sha512-r1bzfrm0tomOI8g1SzvCaQHo6Lcv6zu0EA+W2kHrt8dyrHQxGzBBL4kdkzIS+jBMV+EYcMAEAqXqYaLJq5rOZg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.20.7" + } + }, + "node_modules/@types/estree": { + "version": "0.0.39", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.39.tgz", + "integrity": "sha512-EYNwp3bU+98cpU4lAWYYL7Zz+2gryWH1qbdDTidVd6hkiR6weksdbMadyXKXNPEkQFhXM+hVO9ZygomHXp+AIw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/fs-extra": { + "version": "9.0.13", + "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-9.0.13.tgz", + "integrity": "sha512-nEnwB++1u5lVDM2UI4c1+5R+FYaKfaAzS4OococimjVm3nQw3TuzH5UNsocrcTBbhnerblyHj4A49qXbIiZdpA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/glob": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/@types/glob/-/glob-7.2.0.tgz", + "integrity": "sha512-ZUxbzKl0IfJILTS6t7ip5fQQM/J3TJYubDm3nMbgubNNYS62eXeUpoLUC8/7fJNiFYHTrGPQn7hspDUzIHX3UA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/minimatch": "*", + "@types/node": "*" + } + }, + "node_modules/@types/graceful-fs": { + "version": "4.1.9", + "resolved": "https://registry.npmjs.org/@types/graceful-fs/-/graceful-fs-4.1.9.tgz", + "integrity": "sha512-olP3sd1qOEe5dXTSaFvQG+02VdRXcdytWLAZsAq1PecU8uqQAhkrnbli7DagjtXKW/Bl7YJbUsa8MPcuc8LHEQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/istanbul-lib-coverage": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", + "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/istanbul-lib-report": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", + "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-coverage": "*" + } + }, + "node_modules/@types/istanbul-reports": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", + "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/istanbul-lib-report": "*" + } + }, + "node_modules/@types/jest": { + "version": "27.5.2", + "resolved": "https://registry.npmjs.org/@types/jest/-/jest-27.5.2.tgz", + "integrity": "sha512-mpT8LJJ4CMeeahobofYWIjFo0xonRS/HfxnVEPMPFSQdGUt1uHCnoPT7Zhb+sjDU2wz0oKV0OLUR0WzrHNgfeA==", + "dev": true, + "license": "MIT", + "dependencies": { + "jest-matcher-utils": "^27.0.0", + "pretty-format": "^27.0.0" + } + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/json5": { + "version": "0.0.29", + "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", + "integrity": "sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/minimatch": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-5.1.2.tgz", + "integrity": "sha512-K0VQKziLUWkVKiRVrx4a40iPaxTUefQmjtkQofBkYRcoaaL/8rhwDWww9qWbrgicNOgnpIsMxyNIUM4+n6dUIA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/node": { + "version": "25.3.5", + "resolved": "https://registry.npmjs.org/@types/node/-/node-25.3.5.tgz", + "integrity": "sha512-oX8xrhvpiyRCQkG1MFchB09f+cXftgIXb3a7UUa4Y3wpmZPw5tyZGTLWhlESOLq1Rq6oDlc8npVU2/9xiCuXMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~7.18.0" + } + }, + "node_modules/@types/prettier": { + "version": "2.7.3", + "resolved": "https://registry.npmjs.org/@types/prettier/-/prettier-2.7.3.tgz", + "integrity": "sha512-+68kP9yzs4LMp7VNh8gdzMSPZFL44MLGqiHWvttYJe+6qnuVr4Ek9wSBQoveqY/r+LwjCcU29kNVkidwim+kYA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/prop-types": { + "version": "15.7.12", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.12.tgz", + "integrity": "sha512-5zvhXYtRNRluoE/jAp4GVsSduVUzNWKkOZrCDBWYtE7biZywwdC2AcEzg+cSMLFRfVgeAFqpfNabiPjxFddV1Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/react": { + "version": "18.3.3", + "resolved": "https://registry.npmjs.org/@types/react/-/react-18.3.3.tgz", + "integrity": "sha512-hti/R0pS0q1/xx+TsI73XIqk26eBsISZ2R0wUijXIngRK9R/e7Xw/cXVxQK7R5JjW+SV4zGcn5hXjudkN/pLIw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/prop-types": "*", + "csstype": "^3.0.2" + } + }, + "node_modules/@types/resolve": { + "version": "1.17.1", + "resolved": "https://registry.npmjs.org/@types/resolve/-/resolve-1.17.1.tgz", + "integrity": "sha512-yy7HuzQhj0dhGpD8RLXSZWEkLsV9ibvxvi6EiJ3bkqLAO1RGo0WbkWQiwpRlSFymTJRz0d3k5LM3kkx8ArDbLw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } + }, + "node_modules/@types/semver": { + "version": "7.5.8", + "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.5.8.tgz", + "integrity": "sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/signal-exit": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/signal-exit/-/signal-exit-3.0.4.tgz", + "integrity": "sha512-e7EUPfU9afHyWc5CXtlqbvVHEshrb05uPlDCenWIbMgtWoFrTuTDVYNLKk6o4X2/4oHTfNqrJX/vaJ3uBhtXTg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/stack-utils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.3.tgz", + "integrity": "sha512-9aEbYZ3TbYMznPdcdr3SmIrLXwC/AKZXQeCf9Pgao5CKb8CyHuEX5jzWPTkvregvhRJHcpRO6BFoGW9ycaOkYw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/yargs": { + "version": "16.0.9", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-16.0.9.tgz", + "integrity": "sha512-tHhzvkFXZQeTECenFoRljLBYPZJ7jAVxqqtEI0qTLOmuultnFp4I9yKE17vTuhf7BkhCu7I4XuemPgikDVuYqA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/yargs-parser": "*" + } + }, + "node_modules/@types/yargs-parser": { + "version": "21.0.3", + "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", + "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@typescript-eslint/eslint-plugin": { + "version": "5.62.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.62.0.tgz", + "integrity": "sha512-TiZzBSJja/LbhNPvk6yc0JrX9XqhQ0hdh6M2svYfsHGejaKFIAGd9MQ+ERIMzLGlN/kZoYIgdxFV0PuljTKXag==", + "dev": true, + "license": "MIT", + "dependencies": { + "@eslint-community/regexpp": "^4.4.0", + "@typescript-eslint/scope-manager": "5.62.0", + "@typescript-eslint/type-utils": "5.62.0", + "@typescript-eslint/utils": "5.62.0", + "debug": "^4.3.4", + "graphemer": "^1.4.0", + "ignore": "^5.2.0", + "natural-compare-lite": "^1.4.0", + "semver": "^7.3.7", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "@typescript-eslint/parser": "^5.0.0", + "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typescript-eslint/experimental-utils": { + "version": "5.62.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-5.62.0.tgz", + "integrity": "sha512-RTXpeB3eMkpoclG3ZHft6vG/Z30azNHuqY6wKPBHlVMZFuEvrtlEDe8gMqDb+SO+9hjC/pLekeSCryf9vMZlCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/utils": "5.62.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/@typescript-eslint/parser": { + "version": "5.62.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.62.0.tgz", + "integrity": "sha512-VlJEV0fOQ7BExOsHYAGrgbEiZoi8D+Bl2+f6V2RrXerRSylnp+ZBHmPvaIa8cz0Ajx7WO7Z5RqfgYg7ED1nRhA==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "@typescript-eslint/scope-manager": "5.62.0", + "@typescript-eslint/types": "5.62.0", + "@typescript-eslint/typescript-estree": "5.62.0", + "debug": "^4.3.4" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/scope-manager": { + "version": "5.62.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.62.0.tgz", + "integrity": "sha512-VXuvVvZeQCQb5Zgf4HAxc04q5j+WrNAtNh9OwCsCgpKqESMTu3tF/jhZ3xG6T4NZwWl65Bg8KuS2uEvhSfLl0w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/types": "5.62.0", + "@typescript-eslint/visitor-keys": "5.62.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/type-utils": { + "version": "5.62.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.62.0.tgz", + "integrity": "sha512-xsSQreu+VnfbqQpW5vnCJdq1Z3Q0U31qiWmRhr98ONQmcp/yhiPJFPq8MXiJVLiksmOKSjIldZzkebzHuCGzew==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/typescript-estree": "5.62.0", + "@typescript-eslint/utils": "5.62.0", + "debug": "^4.3.4", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "*" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/types": { + "version": "5.62.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.62.0.tgz", + "integrity": "sha512-87NVngcbVXUahrRTqIK27gD2t5Cu1yuCXxbLcFtCzZGlfyVWWh8mLHkoxzjsB6DDNnvdL+fW8MiwPEJyGJQDgQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/typescript-estree": { + "version": "5.62.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.62.0.tgz", + "integrity": "sha512-CmcQ6uY7b9y694lKdRB8FEel7JbU/40iSAPomu++SjLMntB+2Leay2LO6i8VnJk58MtE9/nQSFIH6jpyRWyYzA==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "@typescript-eslint/types": "5.62.0", + "@typescript-eslint/visitor-keys": "5.62.0", + "debug": "^4.3.4", + "globby": "^11.1.0", + "is-glob": "^4.0.3", + "semver": "^7.3.7", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typescript-eslint/utils": { + "version": "5.62.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.62.0.tgz", + "integrity": "sha512-n8oxjeb5aIbPFEtmQxQYOLI0i9n5ySBEY/ZEHHZqKQSFnxio1rv6dthascc9dLuwrL0RC5mPCxB7vnAVGAYWAQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@eslint-community/eslint-utils": "^4.2.0", + "@types/json-schema": "^7.0.9", + "@types/semver": "^7.3.12", + "@typescript-eslint/scope-manager": "5.62.0", + "@typescript-eslint/types": "5.62.0", + "@typescript-eslint/typescript-estree": "5.62.0", + "eslint-scope": "^5.1.1", + "semver": "^7.3.7" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/@typescript-eslint/utils/node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typescript-eslint/visitor-keys": { + "version": "5.62.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.62.0.tgz", + "integrity": "sha512-07ny+LHRzQXepkGg6w0mFY41fVUNBrL2Roj/++7V1txKugfjm/Ci/qSND03r2RhlJhJYMcTn9AhhSSqQp0Ysyw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/types": "5.62.0", + "eslint-visitor-keys": "^3.3.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@ungap/structured-clone": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.2.0.tgz", + "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/abab": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.6.tgz", + "integrity": "sha512-j2afSsaIENvHZN2B8GOpF566vZ5WVk5opAiMTvWgaQT8DkbOqsTfvNAvHoRGU2zzP8cPoqys+xHTRDWW8L+/BA==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/acorn": { + "version": "8.11.3", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", + "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-globals": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/acorn-globals/-/acorn-globals-6.0.0.tgz", + "integrity": "sha512-ZQl7LOWaF5ePqqcX4hLuv/bLXYQNfNWw2c0/yX/TsPRKamzHcTGQnlCjHT3TsmkOUVEPS3crCxiPfdzE/Trlhg==", + "dev": true, + "license": "MIT", + "dependencies": { + "acorn": "^7.1.1", + "acorn-walk": "^7.1.1" + } + }, + "node_modules/acorn-globals/node_modules/acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, + "node_modules/acorn-walk": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-7.2.0.tgz", + "integrity": "sha512-OPdCF6GsMIP+Az+aWfAAOEt2/+iVDKE7oy6lJ098aoe59oAmK76qV6Gw60SbZ8jHuG2wH058GF4pLFbYamYrVA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/agent-base": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", + "integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "4" + }, + "engines": { + "node": ">= 6.0.0" + } + }, + "node_modules/ajv": { + "version": "6.12.6", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", + "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "fast-json-stable-stringify": "^2.0.0", + "json-schema-traverse": "^0.4.1", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ansi-colors": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", + "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/ansi-escapes": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", + "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "type-fest": "^0.21.3" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-escapes/node_modules/type-fest": { + "version": "0.21.3", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", + "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "dev": true, + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/anymatch": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", + "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "dev": true, + "license": "ISC", + "dependencies": { + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dev": true, + "license": "MIT", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/aria-query": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.0.tgz", + "integrity": "sha512-b0P0sZPKtyu8HkeRAfCq0IfURZK+SuwMjY1UXGBU27wpAiTwQAIlq56IbIO+ytk/JjS1fMR14ee5WBBfKi5J6A==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "dequal": "^2.0.3" + } + }, + "node_modules/array-buffer-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz", + "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.5", + "is-array-buffer": "^3.0.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array-includes": { + "version": "3.1.8", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", + "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", + "is-string": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/array.prototype.findlast": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.findlast/-/array.prototype.findlast-1.2.5.tgz", + "integrity": "sha512-CVvd6FHg1Z3POpBLxO6E6zr+rSKEQ9L6rZHAaY7lLfhKsWYUBBOuMs0e9o24oopj6H+geRCX0YJ+TJLBK2eHyQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-shim-unscopables": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.findlastindex": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.5.tgz", + "integrity": "sha512-zfETvRFA8o7EiNn++N5f/kaCw221hrpGsDmcpndVupkPzEc1Wuf3VgC0qby1BbHs7f5DVYjgtEU2LLh5bqeGfQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-shim-unscopables": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flat": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.2.tgz", + "integrity": "sha512-djYB+Zx2vLewY8RWlNCUdHjDXs2XOgm602S9E7P/UpHgfeHL00cRiIF+IN/G/aUJ7kGPb6yO/ErDI5V2s8iycA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.flatmap": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.2.tgz", + "integrity": "sha512-Ewyx0c9PmpcsByhSW4r+9zDU7sGjFc86qf/kKtuSCRdhfbk0SNLLkaT5qvcHnRGgc5NP/ly/y+qkXkqONX54CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.reduce": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/array.prototype.reduce/-/array.prototype.reduce-1.0.7.tgz", + "integrity": "sha512-mzmiUCVwtiD4lgxYP8g7IYy8El8p2CSMePvIbTS7gchKir/L1fgJrk0yDKmAX6mnRQFKNADYIk8nNlTris5H1Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-array-method-boxes-properly": "^1.0.0", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "is-string": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/array.prototype.toreversed": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/array.prototype.toreversed/-/array.prototype.toreversed-1.1.2.tgz", + "integrity": "sha512-wwDCoT4Ck4Cz7sLtgUmzR5UV3YF5mFHUlbChCzZBQZ+0m2cl/DH3tKgvphv1nKgFsJ48oCSg6p91q2Vm0I/ZMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "es-shim-unscopables": "^1.0.0" + } + }, + "node_modules/array.prototype.tosorted": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/array.prototype.tosorted/-/array.prototype.tosorted-1.1.4.tgz", + "integrity": "sha512-p6Fx8B7b7ZhL/gmUsAy0D15WhvDccw3mnGNbZpi3pmeJdxtWsj2jEaI4Y6oo3XiHfzuSgPwKc04MYt6KgvC/wA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.3", + "es-errors": "^1.3.0", + "es-shim-unscopables": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/arraybuffer.prototype.slice": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz", + "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "es-abstract": "^1.22.3", + "es-errors": "^1.2.1", + "get-intrinsic": "^1.2.3", + "is-array-buffer": "^3.0.4", + "is-shared-array-buffer": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/ast-types-flow": { + "version": "0.0.8", + "resolved": "https://registry.npmjs.org/ast-types-flow/-/ast-types-flow-0.0.8.tgz", + "integrity": "sha512-OH/2E5Fg20h2aPrbe+QL8JZQFko0YZaF+j4mnQ7BGhfavO7OpSLa8a0y9sBwomHdSbkhTS8TQNayBfnW5DwbvQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/asynckit": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", + "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/at-least-node": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", + "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/available-typed-arrays": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/axe-core": { + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.7.0.tgz", + "integrity": "sha512-M0JtH+hlOL5pLQwHOLNYZaXuhqmvS8oExsqB1SBYgA4Dk7u/xx+YdGHXaK5pyUfed5mYXdlYiphWq3G8cRi5JQ==", + "dev": true, + "license": "MPL-2.0", + "engines": { + "node": ">=4" + } + }, + "node_modules/axobject-query": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-3.2.1.tgz", + "integrity": "sha512-jsyHu61e6N4Vbz/v18DHwWYKK0bSWLqn47eeDSKPB7m8tqMHF9YJ+mhIk2lVteyZrY8tnSj/jHOv4YiTCuCJgg==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "dequal": "^2.0.3" + } + }, + "node_modules/babel-jest": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-27.5.1.tgz", + "integrity": "sha512-cdQ5dXjGRd0IBRATiQ4mZGlGlRE8kJpjPOixdNRdT+m3UcNqmYWN6rK6nvtXYfY3D76cb8s/O1Ss8ea24PIwcg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/babel__core": "^7.1.14", + "babel-plugin-istanbul": "^6.1.1", + "babel-preset-jest": "^27.5.1", + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "slash": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.8.0" + } + }, + "node_modules/babel-plugin-istanbul": { + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-6.1.1.tgz", + "integrity": "sha512-Y1IQok9821cC9onCx5otgFfRm7Lm+I+wwxOx738M/WLPZ9Q42m4IG5W0FNX8WLL2gYMZo3JkuXIH2DOpWM+qwA==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@babel/helper-plugin-utils": "^7.0.0", + "@istanbuljs/load-nyc-config": "^1.0.0", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-instrument": "^5.0.4", + "test-exclude": "^6.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/babel-plugin-jest-hoist": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-27.5.1.tgz", + "integrity": "sha512-50wCwD5EMNW4aRpOwtqzyZHIewTYNxLA4nhB+09d8BIssfNfzBRhkBIHiaPv1Si226TQSvp8gxAJm2iY2qs2hQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/template": "^7.3.3", + "@babel/types": "^7.3.3", + "@types/babel__core": "^7.0.0", + "@types/babel__traverse": "^7.0.6" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/babel-plugin-polyfill-corejs2": { + "version": "0.4.11", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.11.tgz", + "integrity": "sha512-sMEJ27L0gRHShOh5G54uAAPaiCOygY/5ratXuiyb2G46FmlSpc9eFCzYVyDiPxfNbwzA7mYahmjQc5q+CZQ09Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/compat-data": "^7.22.6", + "@babel/helper-define-polyfill-provider": "^0.6.2", + "semver": "^6.3.1" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/babel-plugin-polyfill-corejs3": { + "version": "0.10.4", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.10.4.tgz", + "integrity": "sha512-25J6I8NGfa5YkCDogHRID3fVCadIR8/pGl1/spvCkzb6lVn6SR3ojpx9nOn9iEBcUsjY24AmdKm5khcfKdylcg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.1", + "core-js-compat": "^3.36.1" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/babel-plugin-polyfill-regenerator": { + "version": "0.6.2", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.2.tgz", + "integrity": "sha512-2R25rQZWP63nGwaAswvDazbPXfrM3HwVoBXK6HcqeKrSrL/JqcC/rDcf95l4r7LXLyxDXc8uQDa064GubtCABg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-define-polyfill-provider": "^0.6.2" + }, + "peerDependencies": { + "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" + } + }, + "node_modules/babel-plugin-react-test-id": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/babel-plugin-react-test-id/-/babel-plugin-react-test-id-1.0.2.tgz", + "integrity": "sha512-d1bBxX3UNOIaX6NUEsR6Ekfy1fvmCegY9lQodgg6DevjhaNBDnaUeDUHl6JbIh5tuw0EF7FGgt+61yiFLMWwMg==", + "dev": true, + "license": "MIT" + }, + "node_modules/babel-plugin-transform-inline-environment-variables": { + "version": "0.4.4", + "resolved": "https://registry.npmjs.org/babel-plugin-transform-inline-environment-variables/-/babel-plugin-transform-inline-environment-variables-0.4.4.tgz", + "integrity": "sha512-bJILBtn5a11SmtR2j/3mBOjX4K3weC6cq+NNZ7hG22wCAqpc3qtj/iN7dSe9HDiS46lgp1nHsQgeYrea/RUe+g==", + "dev": true, + "license": "MIT" + }, + "node_modules/babel-preset-current-node-syntax": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.0.1.tgz", + "integrity": "sha512-M7LQ0bxarkxQoN+vz5aJPsLBn77n8QgTFmo8WK0/44auK2xlCXrYcUxHFxgU7qW5Yzw/CjmLRK2uJzaCd7LvqQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/plugin-syntax-async-generators": "^7.8.4", + "@babel/plugin-syntax-bigint": "^7.8.3", + "@babel/plugin-syntax-class-properties": "^7.8.3", + "@babel/plugin-syntax-import-meta": "^7.8.3", + "@babel/plugin-syntax-json-strings": "^7.8.3", + "@babel/plugin-syntax-logical-assignment-operators": "^7.8.3", + "@babel/plugin-syntax-nullish-coalescing-operator": "^7.8.3", + "@babel/plugin-syntax-numeric-separator": "^7.8.3", + "@babel/plugin-syntax-object-rest-spread": "^7.8.3", + "@babel/plugin-syntax-optional-catch-binding": "^7.8.3", + "@babel/plugin-syntax-optional-chaining": "^7.8.3", + "@babel/plugin-syntax-top-level-await": "^7.8.3" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/babel-preset-jest": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-27.5.1.tgz", + "integrity": "sha512-Nptf2FzlPCWYuJg41HBqXVT8ym6bXOevuCTbhxlUpjwtysGaIWFvDEjp4y+G7fl13FgOdjs7P/DmErqH7da0Ag==", + "dev": true, + "license": "MIT", + "dependencies": { + "babel-plugin-jest-hoist": "^27.5.1", + "babel-preset-current-node-syntax": "^1.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0" + } + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" + }, + "node_modules/better-path-resolve": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/better-path-resolve/-/better-path-resolve-1.0.0.tgz", + "integrity": "sha512-pbnl5XzGBdrFU/wT4jqmJVPn2B6UHPBOhzMQkY/SPUPB6QtUXtmBHBIwCbXJol93mOpGMnQyP/+BB19q04xj7g==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-windows": "^1.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/binary-extensions": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", + "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/braces": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", + "dependencies": { + "fill-range": "^7.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/browser-process-hrtime": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/browser-process-hrtime/-/browser-process-hrtime-1.0.0.tgz", + "integrity": "sha512-9o5UecI3GhkpM6DrXr69PblIuWxPKk9Y0jHBRhdocZ2y7YECBFCsHm79Pr3OyR2AvjhDkabFJaDJMYRazHgsow==", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/browserslist": { + "version": "4.23.3", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.3.tgz", + "integrity": "sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "caniuse-lite": "^1.0.30001646", + "electron-to-chromium": "^1.5.4", + "node-releases": "^2.0.18", + "update-browserslist-db": "^1.1.0" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/bser": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/bser/-/bser-2.1.1.tgz", + "integrity": "sha512-gQxTNE/GAfIIrmHLUE3oJyp5FO6HRBfhjnw4/wMmA63ZGDJnWBmgY/lyQBpnDUkGmAhbSe39tx2d/iTOAfglwQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "node-int64": "^0.4.0" + } + }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/builtin-modules": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz", + "integrity": "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/call-bind": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", + "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/camel-case": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz", + "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==", + "dev": true, + "license": "MIT", + "dependencies": { + "pascal-case": "^3.1.2", + "tslib": "^2.0.3" + } + }, + "node_modules/camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001646", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001646.tgz", + "integrity": "sha512-dRg00gudiBDDTmUhClSdv3hqRfpbOnU28IpI1T6PBTLWa+kOj0681C8uML3PifYfREuBrVjDGhL3adYpBT6spw==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "CC-BY-4.0" + }, + "node_modules/capital-case": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz", + "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==", + "dev": true, + "license": "MIT", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3", + "upper-case-first": "^2.0.2" + } + }, + "node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/change-case": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/change-case/-/change-case-4.1.2.tgz", + "integrity": "sha512-bSxY2ws9OtviILG1EiY5K7NNxkqg/JnRnFxLtKQ96JaviiIxi7djMrSd0ECT9AC+lttClmYwKw53BWpOMblo7A==", + "dev": true, + "license": "MIT", + "dependencies": { + "camel-case": "^4.1.2", + "capital-case": "^1.0.4", + "constant-case": "^3.0.4", + "dot-case": "^3.0.4", + "header-case": "^2.0.4", + "no-case": "^3.0.4", + "param-case": "^3.0.4", + "pascal-case": "^3.1.2", + "path-case": "^3.0.4", + "sentence-case": "^3.0.4", + "snake-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/char-regex": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", + "integrity": "sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/chardet": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/chardet/-/chardet-2.1.0.tgz", + "integrity": "sha512-bNFETTG/pM5ryzQ9Ad0lJOTa6HWD/YsScAR3EnCPZRPlQh77JocYktSHOUHelyhm8IARL+o4c4F1bP5KVOjiRA==", + "dev": true, + "license": "MIT" + }, + "node_modules/chokidar": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", + "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "anymatch": "~3.1.2", + "braces": "~3.0.2", + "glob-parent": "~5.1.2", + "is-binary-path": "~2.1.0", + "is-glob": "~4.0.1", + "normalize-path": "~3.0.0", + "readdirp": "~3.6.0" + }, + "engines": { + "node": ">= 8.10.0" + }, + "funding": { + "url": "https://paulmillr.com/funding/" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + } + }, + "node_modules/ci-info": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.9.0.tgz", + "integrity": "sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/sibiraj-s" + } + ], + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/cjs-module-lexer": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.3.1.tgz", + "integrity": "sha512-a3KdPAANPbNE4ZUv9h6LckSl9zLsYOP4MBmhIPkRaeyybt+r4UghLvq+xw/YwUcC1gqylCkL4rdVs3Lwupjm4Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/cliui": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", + "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.1", + "wrap-ansi": "^7.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/clone-deep": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/clone-deep/-/clone-deep-4.0.1.tgz", + "integrity": "sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-plain-object": "^2.0.4", + "kind-of": "^6.0.2", + "shallow-clone": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/co": { + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/co/-/co-4.6.0.tgz", + "integrity": "sha512-QVb0dM5HvG+uaxitm8wONl7jltx8dqhfU33DcqtOZcLSVIKSDDLDi7+0LbAKiyI8hD9u42m2YxXSkMGWThaecQ==", + "dev": true, + "license": "MIT", + "engines": { + "iojs": ">= 1.0.0", + "node": ">= 0.12.0" + } + }, + "node_modules/code-block-writer": { + "version": "13.0.3", + "resolved": "https://registry.npmjs.org/code-block-writer/-/code-block-writer-13.0.3.tgz", + "integrity": "sha512-Oofo0pq3IKnsFtuHqSF7TqBfr71aeyZDVJ0HpmqB7FBM2qEigL0iPONSCZSO9pE9dZTAxANe5XHG9Uy0YMv8cg==", + "license": "MIT" + }, + "node_modules/collect-v8-coverage": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/collect-v8-coverage/-/collect-v8-coverage-1.0.2.tgz", + "integrity": "sha512-lHl4d5/ONEbLlJvaJNtsF/Lz+WvB07u2ycqTYbdrq7UypDXailES4valYb2eWiJFxZlVmpGekfqoxQhzyFdT4Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, + "node_modules/combined-stream": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", + "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", + "dev": true, + "license": "MIT", + "dependencies": { + "delayed-stream": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/commander": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-6.2.1.tgz", + "integrity": "sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/common-ancestor-path": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/common-ancestor-path/-/common-ancestor-path-1.0.1.tgz", + "integrity": "sha512-L3sHRo1pXXEqX8VU28kfgUY+YGsk09hPqZiZmLacNib6XNTCM8ubYeT7ryXQw8asB1sKgcU5lkB7ONug08aB8w==", + "dev": true, + "license": "ISC" + }, + "node_modules/common-tags": { + "version": "1.8.2", + "resolved": "https://registry.npmjs.org/common-tags/-/common-tags-1.8.2.tgz", + "integrity": "sha512-gk/Z852D2Wtb//0I+kRFNKKE9dIIVirjoqPoA1wJU+XePVXZfGeBpk45+A1rKO4Q43prqWBNY/MiIeRLbPWUaA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/commondir": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/commondir/-/commondir-1.0.1.tgz", + "integrity": "sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg==", + "dev": true, + "license": "MIT" + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "dev": true, + "license": "MIT" + }, + "node_modules/constant-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz", + "integrity": "sha512-I2hSBi7Vvs7BEuJDr5dDHfzb/Ruj3FyvFyh7KLilAjNQw3Be+xgqUBA2W6scVEcL0hL1dwPRtIqEPVUCKkSsyQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3", + "upper-case": "^2.0.2" + } + }, + "node_modules/convert-source-map": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.9.0.tgz", + "integrity": "sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==", + "dev": true, + "license": "MIT" + }, + "node_modules/core-js": { + "version": "3.37.1", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.37.1.tgz", + "integrity": "sha512-Xn6qmxrQZyB0FFY8E3bgRXei3lWDJHhvI+u0q9TKIYM49G8pAr0FgnnrFRAmsbptZL1yxRADVXn+x5AGsbBfyw==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/core-js-compat": { + "version": "3.37.1", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.37.1.tgz", + "integrity": "sha512-9TNiImhKvQqSUkOvk/mMRZzOANTiEVC7WaBNhHcKM7x+/5E1l5NvsysR19zuDQScE8k+kfQXWRN3AtS/eOSHpg==", + "dev": true, + "license": "MIT", + "dependencies": { + "browserslist": "^4.23.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, + "node_modules/cross-spawn": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", + "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/cssom": { + "version": "0.4.4", + "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.4.4.tgz", + "integrity": "sha512-p3pvU7r1MyyqbTk+WbNJIgJjG2VmTIaB10rI93LzVPrmDJKkzKYMtxxyAvQXR/NS6otuzveI7+7BBq3SjBS2mw==", + "dev": true, + "license": "MIT" + }, + "node_modules/cssstyle": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-2.3.0.tgz", + "integrity": "sha512-AZL67abkUzIuvcHqk7c09cezpGNcxUxU4Ioi/05xHk4DQeTkWmGYftIE6ctU6AEt+Gn4n1lDStOtj7FKycP71A==", + "dev": true, + "license": "MIT", + "dependencies": { + "cssom": "~0.3.6" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cssstyle/node_modules/cssom": { + "version": "0.3.8", + "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.3.8.tgz", + "integrity": "sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg==", + "dev": true, + "license": "MIT" + }, + "node_modules/csstype": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", + "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==", + "dev": true, + "license": "MIT" + }, + "node_modules/damerau-levenshtein": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/damerau-levenshtein/-/damerau-levenshtein-1.0.8.tgz", + "integrity": "sha512-sdQSFB7+llfUcQHUQO3+B8ERRj0Oa4w9POWMI/puGtuf7gFywGmkaLCElnudfTiKZV+NvHqL0ifzdrI8Ro7ESA==", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/data-urls": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/data-urls/-/data-urls-2.0.0.tgz", + "integrity": "sha512-X5eWTSXO/BJmpdIKCRuKUgSCgAN0OwliVK3yPKbwIWU1Tdw5BRajxlzMidvh+gwko9AfQ9zIj52pzF91Q3YAvQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "abab": "^2.0.3", + "whatwg-mimetype": "^2.3.0", + "whatwg-url": "^8.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/data-view-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz", + "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz", + "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-offset": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz", + "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/dataloader": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/dataloader/-/dataloader-1.4.0.tgz", + "integrity": "sha512-68s5jYdlvasItOJnCuI2Q9s4q98g0pCyL3HrcKJu8KNugUl8ahgmZYg38ysLTgQjjXX3H8CJLkAvWrclWfcalw==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/debug": { + "version": "4.3.5", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.5.tgz", + "integrity": "sha512-pt0bNEmneDIvdL1Xsd9oDQ/wrQRkXDT4AUWlNZNPKvW5x/jyO9VFXkJUP07vQ2upmw5PlaITaPKc31jK13V+jg==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "2.1.2" + }, + "engines": { + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/decimal.js": { + "version": "10.4.3", + "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-10.4.3.tgz", + "integrity": "sha512-VBBaLc1MgL5XpzgIP7ny5Z6Nx3UrRkIViUkPUdtl9aya5amy3De1gsUUSB1g3+3sExYNjCAsAznmukyxCb1GRA==", + "dev": true, + "license": "MIT" + }, + "node_modules/dedent": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/dedent/-/dedent-0.7.0.tgz", + "integrity": "sha512-Q6fKUPqnAHAyhiUgFU7BUzLiv0kd8saH9al7tnu5Q/okj6dnupxyTgFIBjVzJATdfIAm9NAsvXNzjaKa+bxVyA==", + "dev": true, + "license": "MIT" + }, + "node_modules/deep-is": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", + "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/deepmerge": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", + "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/define-properties": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", + "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.0.1", + "has-property-descriptors": "^1.0.0", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/delayed-stream": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", + "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/detect-indent": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/detect-indent/-/detect-indent-6.1.0.tgz", + "integrity": "sha512-reYkTUJAZb9gUuZ2RvVCNhVHdg62RHnJ7WJl8ftMi4diZ6NWlciOzQN88pUhSELEwflJht4oQDv0F0BMlwaYtA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/detect-newline": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz", + "integrity": "sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/diff-sequences": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-27.5.1.tgz", + "integrity": "sha512-k1gCAXAsNgLwEL+Y8Wvl+M6oEFj5bgazfZULpS5CneoPPXRaCCW7dm+q21Ky2VEE5X+VeRDBVg1Pcvvsr4TtNQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-type": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/doctrine": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", + "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/domexception": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/domexception/-/domexception-2.0.1.tgz", + "integrity": "sha512-yxJ2mFy/sibVQlu5qHjOkf9J3K6zgmCxgJ94u2EdvDOV09H+32LtRswEcUsmUWN72pVLOEnTSRaIVVzVQgS0dg==", + "dev": true, + "license": "MIT", + "dependencies": { + "webidl-conversions": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/domexception/node_modules/webidl-conversions": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-5.0.0.tgz", + "integrity": "sha512-VlZwKPCkYKxQgeSbH5EyngOmRp7Ww7I9rQLERETtf5ofd9pGeswWiOtogpEO850jziPRarreGxn5QIiTqpb2wA==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=8" + } + }, + "node_modules/dot-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz", + "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==", + "dev": true, + "license": "MIT", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/dotenv": { + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.6.0.tgz", + "integrity": "sha512-IrPdXQsk2BbzvCBGBOTmmSH5SodmqZNt4ERAZDmW4CT+tL8VtvinqywuANaFu4bOMWki16nqf0e4oC0QIaDr/g==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=10" + } + }, + "node_modules/electron-to-chromium": { + "version": "1.5.4", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.4.tgz", + "integrity": "sha512-orzA81VqLyIGUEA77YkVA1D+N+nNfl2isJVjjmOyrlxuooZ19ynb+dOlaDTqd/idKRS9lDCSBmtzM+kyCsMnkA==", + "dev": true, + "license": "ISC" + }, + "node_modules/emittery": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/emittery/-/emittery-0.8.1.tgz", + "integrity": "sha512-uDfvUjVrfGJJhymx/kz6prltenw1u7WrCg1oa94zYY8xxVpLLUu045LAT0dhDZdXG58/EpPL/5kA180fQ/qudg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/emittery?sponsor=1" + } + }, + "node_modules/emoji-regex": { + "version": "9.2.2", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", + "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "dev": true, + "license": "MIT" + }, + "node_modules/end-of-stream": { + "version": "1.4.4", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", + "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "once": "^1.4.0" + } + }, + "node_modules/enquirer": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.4.1.tgz", + "integrity": "sha512-rRqJg/6gd538VHvR3PSrdRBb/1Vy2YfzHqzvbhGIQpDRKIa4FgV/54b5Q1xYSxOOwKvjXweS26E0Q+nAMwp2pQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-colors": "^4.1.1", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-arrayish": "^0.2.1" + } + }, + "node_modules/es-abstract": { + "version": "1.23.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", + "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "arraybuffer.prototype.slice": "^1.0.3", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "data-view-buffer": "^1.0.1", + "data-view-byte-length": "^1.0.1", + "data-view-byte-offset": "^1.0.0", + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-set-tostringtag": "^2.0.3", + "es-to-primitive": "^1.2.1", + "function.prototype.name": "^1.1.6", + "get-intrinsic": "^1.2.4", + "get-symbol-description": "^1.0.2", + "globalthis": "^1.0.3", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", + "has-symbols": "^1.0.3", + "hasown": "^2.0.2", + "internal-slot": "^1.0.7", + "is-array-buffer": "^3.0.4", + "is-callable": "^1.2.7", + "is-data-view": "^1.0.1", + "is-negative-zero": "^2.0.3", + "is-regex": "^1.1.4", + "is-shared-array-buffer": "^1.0.3", + "is-string": "^1.0.7", + "is-typed-array": "^1.1.13", + "is-weakref": "^1.0.2", + "object-inspect": "^1.13.1", + "object-keys": "^1.1.1", + "object.assign": "^4.1.5", + "regexp.prototype.flags": "^1.5.2", + "safe-array-concat": "^1.1.2", + "safe-regex-test": "^1.0.3", + "string.prototype.trim": "^1.2.9", + "string.prototype.trimend": "^1.0.8", + "string.prototype.trimstart": "^1.0.8", + "typed-array-buffer": "^1.0.2", + "typed-array-byte-length": "^1.0.1", + "typed-array-byte-offset": "^1.0.2", + "typed-array-length": "^1.0.6", + "unbox-primitive": "^1.0.2", + "which-typed-array": "^1.1.15" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-array-method-boxes-properly": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-array-method-boxes-properly/-/es-array-method-boxes-properly-1.0.0.tgz", + "integrity": "sha512-wd6JXUmyHmt8T5a2xreUwKcGPq6f1f+WwIJkijUqiGcJz1qqnZgP6XIK+QyIWU5lT7imeNxUll48bziG+TSYcA==", + "dev": true, + "license": "MIT" + }, + "node_modules/es-define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", + "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-iterator-helpers": { + "version": "1.0.19", + "resolved": "https://registry.npmjs.org/es-iterator-helpers/-/es-iterator-helpers-1.0.19.tgz", + "integrity": "sha512-zoMwbCcH5hwUkKJkT8kDIBZSz9I6mVG//+lDCinLCGov4+r7NIy0ld8o03M0cJxl2spVf6ESYVS6/gpIfq1FFw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.3", + "es-errors": "^1.3.0", + "es-set-tostringtag": "^2.0.3", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "globalthis": "^1.0.3", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", + "has-symbols": "^1.0.3", + "internal-slot": "^1.0.7", + "iterator.prototype": "^1.1.2", + "safe-array-concat": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-object-atoms": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz", + "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-set-tostringtag": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz", + "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.2.4", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-shim-unscopables": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.0.2.tgz", + "integrity": "sha512-J3yBRXCzDu4ULnQwxyToo/OjdMx6akgVC7K6few0a7F/0wLtmKKN7I73AH5T2836UuXRqN7Qg+IIUw/+YJksRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "hasown": "^2.0.0" + } + }, + "node_modules/es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/escalade": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.2.tgz", + "integrity": "sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.0" + } + }, + "node_modules/escodegen": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-2.1.0.tgz", + "integrity": "sha512-2NlIDTwUWJN0mRPQOdtQBzbUHvdGY2P1VXSyU83Q3xKxM7WHX2Ql8dKq782Q9TgQUNOLEzEYu9bzLNj1q88I5w==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "esprima": "^4.0.1", + "estraverse": "^5.2.0", + "esutils": "^2.0.2" + }, + "bin": { + "escodegen": "bin/escodegen.js", + "esgenerate": "bin/esgenerate.js" + }, + "engines": { + "node": ">=6.0" + }, + "optionalDependencies": { + "source-map": "~0.6.1" + } + }, + "node_modules/eslint": { + "version": "8.57.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.57.0.tgz", + "integrity": "sha512-dZ6+mexnaTIbSBZWgou51U6OmzIhYM2VcNdtiTtI7qPNZm35Akpr0f6vtw3w1Kmn5PYo+tZVfh13WrhpS6oLqQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@eslint-community/eslint-utils": "^4.2.0", + "@eslint-community/regexpp": "^4.6.1", + "@eslint/eslintrc": "^2.1.4", + "@eslint/js": "8.57.0", + "@humanwhocodes/config-array": "^0.11.14", + "@humanwhocodes/module-importer": "^1.0.1", + "@nodelib/fs.walk": "^1.2.8", + "@ungap/structured-clone": "^1.2.0", + "ajv": "^6.12.4", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.3.2", + "doctrine": "^3.0.0", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^7.2.2", + "eslint-visitor-keys": "^3.4.3", + "espree": "^9.6.1", + "esquery": "^1.4.2", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "find-up": "^5.0.0", + "glob-parent": "^6.0.2", + "globals": "^13.19.0", + "graphemer": "^1.4.0", + "ignore": "^5.2.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "is-path-inside": "^3.0.3", + "js-yaml": "^4.1.0", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.1.2", + "natural-compare": "^1.4.0", + "optionator": "^0.9.3", + "strip-ansi": "^6.0.1", + "text-table": "^0.2.0" + }, + "bin": { + "eslint": "bin/eslint.js" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-config-prettier": { + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-8.10.0.tgz", + "integrity": "sha512-SM8AMJdeQqRYT9O9zguiruQZaN7+z+E4eAP9oiLNGKMtomwaB1E9dcgUD6ZAn/eQAb52USbvezbiljfZUhbJcg==", + "dev": true, + "license": "MIT", + "bin": { + "eslint-config-prettier": "bin/cli.js" + }, + "peerDependencies": { + "eslint": ">=7.0.0" + } + }, + "node_modules/eslint-import-resolver-node": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.9.tgz", + "integrity": "sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "^3.2.7", + "is-core-module": "^2.13.0", + "resolve": "^1.22.4" + } + }, + "node_modules/eslint-import-resolver-node/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-module-utils": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.8.1.tgz", + "integrity": "sha512-rXDXR3h7cs7dy9RNpUlQf80nX31XWJEyGq1tRMo+6GsO5VmTe4UTwtmonAD4ZkAsrfMVDA2wlGJ3790Ys+D49Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "^3.2.7" + }, + "engines": { + "node": ">=4" + }, + "peerDependenciesMeta": { + "eslint": { + "optional": true + } + } + }, + "node_modules/eslint-module-utils/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-plugin-es": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-es/-/eslint-plugin-es-3.0.1.tgz", + "integrity": "sha512-GUmAsJaN4Fc7Gbtl8uOBlayo2DqhwWvEzykMHSCZHU3XdJ+NSzzZcVhXh3VxX5icqQ+oQdIEawXX8xkR3mIFmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-utils": "^2.0.0", + "regexpp": "^3.0.0" + }, + "engines": { + "node": ">=8.10.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=4.19.1" + } + }, + "node_modules/eslint-plugin-eslint-comments": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-eslint-comments/-/eslint-plugin-eslint-comments-3.2.0.tgz", + "integrity": "sha512-0jkOl0hfojIHHmEHgmNdqv4fmh7300NdpA9FFpF7zaoLvB/QeXOGNLIo86oAveJFrfB1p05kC8hpEMHM8DwWVQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "escape-string-regexp": "^1.0.5", + "ignore": "^5.0.5" + }, + "engines": { + "node": ">=6.5.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=4.19.1" + } + }, + "node_modules/eslint-plugin-import": { + "version": "2.29.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.29.1.tgz", + "integrity": "sha512-BbPC0cuExzhiMo4Ff1BTVwHpjjv28C5R+btTOGaCRC7UEz801up0JadwkeSk5Ued6TG34uaczuVuH6qyy5YUxw==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-includes": "^3.1.7", + "array.prototype.findlastindex": "^1.2.3", + "array.prototype.flat": "^1.3.2", + "array.prototype.flatmap": "^1.3.2", + "debug": "^3.2.7", + "doctrine": "^2.1.0", + "eslint-import-resolver-node": "^0.3.9", + "eslint-module-utils": "^2.8.0", + "hasown": "^2.0.0", + "is-core-module": "^2.13.1", + "is-glob": "^4.0.3", + "minimatch": "^3.1.2", + "object.fromentries": "^2.0.7", + "object.groupby": "^1.0.1", + "object.values": "^1.1.7", + "semver": "^6.3.1", + "tsconfig-paths": "^3.15.0" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8" + } + }, + "node_modules/eslint-plugin-import/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/eslint-plugin-jest": { + "version": "25.7.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-25.7.0.tgz", + "integrity": "sha512-PWLUEXeeF7C9QGKqvdSbzLOiLTx+bno7/HC9eefePfEb257QFHg7ye3dh80AZVkaa/RQsBB1Q/ORQvg2X7F0NQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@typescript-eslint/experimental-utils": "^5.0.0" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || >=16.0.0" + }, + "peerDependencies": { + "@typescript-eslint/eslint-plugin": "^4.0.0 || ^5.0.0", + "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0" + }, + "peerDependenciesMeta": { + "@typescript-eslint/eslint-plugin": { + "optional": true + }, + "jest": { + "optional": true + } + } + }, + "node_modules/eslint-plugin-jest-formatting": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jest-formatting/-/eslint-plugin-jest-formatting-3.1.0.tgz", + "integrity": "sha512-XyysraZ1JSgGbLSDxjj5HzKKh0glgWf+7CkqxbTqb7zEhW7X2WHo5SBQ8cGhnszKN+2Lj3/oevBlHNbHezoc/A==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "eslint": ">=0.8.0" + } + }, + "node_modules/eslint-plugin-jsx-a11y": { + "version": "6.8.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsx-a11y/-/eslint-plugin-jsx-a11y-6.8.0.tgz", + "integrity": "sha512-Hdh937BS3KdwwbBaKd5+PLCOmYY6U4f2h9Z2ktwtNKvIdIEu137rjYbcb9ApSbVJfWxANNuiKTD/9tOKjK9qOA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.23.2", + "aria-query": "^5.3.0", + "array-includes": "^3.1.7", + "array.prototype.flatmap": "^1.3.2", + "ast-types-flow": "^0.0.8", + "axe-core": "=4.7.0", + "axobject-query": "^3.2.1", + "damerau-levenshtein": "^1.0.8", + "emoji-regex": "^9.2.2", + "es-iterator-helpers": "^1.0.15", + "hasown": "^2.0.0", + "jsx-ast-utils": "^3.3.5", + "language-tags": "^1.0.9", + "minimatch": "^3.1.2", + "object.entries": "^1.1.7", + "object.fromentries": "^2.0.7" + }, + "engines": { + "node": ">=4.0" + }, + "peerDependencies": { + "eslint": "^3 || ^4 || ^5 || ^6 || ^7 || ^8" + } + }, + "node_modules/eslint-plugin-node": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-node/-/eslint-plugin-node-11.1.0.tgz", + "integrity": "sha512-oUwtPJ1W0SKD0Tr+wqu92c5xuCeQqB3hSCHasn/ZgjFdA9iDGNkNf2Zi9ztY7X+hNuMib23LNGRm6+uN+KLE3g==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-plugin-es": "^3.0.0", + "eslint-utils": "^2.0.0", + "ignore": "^5.1.1", + "minimatch": "^3.0.4", + "resolve": "^1.10.1", + "semver": "^6.1.0" + }, + "engines": { + "node": ">=8.10.0" + }, + "peerDependencies": { + "eslint": ">=5.16.0" + } + }, + "node_modules/eslint-plugin-prettier": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-4.2.1.tgz", + "integrity": "sha512-f/0rXLXUt0oFYs8ra4w49wYZBG5GKZpAYsJSm6rnYL5uVDjd+zowwMwVZHnAjf4edNrKpCDYfXDgmRE/Ak7QyQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "prettier-linter-helpers": "^1.0.0" + }, + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "eslint": ">=7.28.0", + "prettier": ">=2.0.0" + }, + "peerDependenciesMeta": { + "eslint-config-prettier": { + "optional": true + } + } + }, + "node_modules/eslint-plugin-promise": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-6.2.0.tgz", + "integrity": "sha512-QmAqwizauvnKOlifxyDj2ObfULpHQawlg/zQdgEixur9vl0CvZGv/LCJV2rtj3210QCoeGBzVMfMXqGAOr/4fA==", + "dev": true, + "license": "ISC", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + }, + "peerDependencies": { + "eslint": "^7.0.0 || ^8.0.0 || ^9.0.0" + } + }, + "node_modules/eslint-plugin-react": { + "version": "7.34.2", + "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.34.2.tgz", + "integrity": "sha512-2HCmrU+/JNigDN6tg55cRDKCQWicYAPB38JGSFDQt95jDm8rrvSUo7YPkOIm5l6ts1j1zCvysNcasvfTMQzUOw==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-includes": "^3.1.8", + "array.prototype.findlast": "^1.2.5", + "array.prototype.flatmap": "^1.3.2", + "array.prototype.toreversed": "^1.1.2", + "array.prototype.tosorted": "^1.1.3", + "doctrine": "^2.1.0", + "es-iterator-helpers": "^1.0.19", + "estraverse": "^5.3.0", + "jsx-ast-utils": "^2.4.1 || ^3.0.0", + "minimatch": "^3.1.2", + "object.entries": "^1.1.8", + "object.fromentries": "^2.0.8", + "object.hasown": "^1.1.4", + "object.values": "^1.2.0", + "prop-types": "^15.8.1", + "resolve": "^2.0.0-next.5", + "semver": "^6.3.1", + "string.prototype.matchall": "^4.0.11" + }, + "engines": { + "node": ">=4" + }, + "peerDependencies": { + "eslint": "^3 || ^4 || ^5 || ^6 || ^7 || ^8" + } + }, + "node_modules/eslint-plugin-react-hooks": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-4.6.2.tgz", + "integrity": "sha512-QzliNJq4GinDBcD8gPB5v0wh6g8q3SUi6EFF0x8N/BL9PoVs0atuGc47ozMRyOWAKdwaZ5OnbOEa3WR+dSGKuQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "peerDependencies": { + "eslint": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0" + } + }, + "node_modules/eslint-plugin-react/node_modules/resolve": { + "version": "2.0.0-next.5", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.5.tgz", + "integrity": "sha512-U7WjGVG9sH8tvjW5SmGbQuui75FiyjAX72HX15DwBBwF9dNiQZRQAg9nnPhYy+TUnE0+VcrttuvNI8oSxZcocA==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-core-module": "^2.13.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/eslint-plugin-sort-class-members": { + "version": "1.20.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-sort-class-members/-/eslint-plugin-sort-class-members-1.20.0.tgz", + "integrity": "sha512-xNaik4GQ/pRwd1soIVI28HEXZbrWoLR5krau2+E8YcHj7N09UviPg5mYhf/rELG29bIFJdXDOFJazN90+luMOw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4.0.0" + }, + "peerDependencies": { + "eslint": ">=0.8.0" + } + }, + "node_modules/eslint-rule-composer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/eslint-rule-composer/-/eslint-rule-composer-0.3.0.tgz", + "integrity": "sha512-bt+Sh8CtDmn2OajxvNO+BX7Wn4CIWMpTRm3MaiKPCQcnnlm0CS2mhui6QaoeQugs+3Kj2ESKEEGJUdVafwhiCg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/eslint-scope/node_modules/estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "license": "MIT", + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint-utils/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint-visitor-keys": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", + "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint/node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true, + "license": "Python-2.0" + }, + "node_modules/eslint/node_modules/doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "esutils": "^2.0.2" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/eslint/node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint/node_modules/eslint-scope": { + "version": "7.2.2", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.2.2.tgz", + "integrity": "sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^5.2.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint/node_modules/find-up": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", + "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^6.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint/node_modules/glob-parent": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", + "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", + "dev": true, + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.3" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/eslint/node_modules/globals": { + "version": "13.24.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", + "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint/node_modules/js-yaml": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", + "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/eslint/node_modules/locate-path": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", + "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^5.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint/node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint/node_modules/p-locate": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", + "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/espree": { + "version": "9.6.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-9.6.1.tgz", + "integrity": "sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "acorn": "^8.9.0", + "acorn-jsx": "^5.3.2", + "eslint-visitor-keys": "^3.4.1" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "dev": true, + "license": "BSD-2-Clause", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/esquery": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.5.0.tgz", + "integrity": "sha512-YQLXUplAwJgCydQ78IMJywZCceoqk1oH01OERdSAJc/7U2AylwjhSCLDEtqwg811idIS/9fIU5GjG73IgjKMVg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "estraverse": "^5.1.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estree-walker": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", + "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", + "dev": true, + "license": "MIT" + }, + "node_modules/esutils": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", + "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/execa": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "dev": true, + "license": "MIT", + "dependencies": { + "cross-spawn": "^7.0.3", + "get-stream": "^6.0.0", + "human-signals": "^2.1.0", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.1", + "onetime": "^5.1.2", + "signal-exit": "^3.0.3", + "strip-final-newline": "^2.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sindresorhus/execa?sponsor=1" + } + }, + "node_modules/exit": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/exit/-/exit-0.1.2.tgz", + "integrity": "sha512-Zk/eNKV2zbjpKzrsQ+n1G6poVbErQxJ0LBOJXaKZ1EViLzH+hrLu9cdXI4zw9dBQJslwBEpbQ2P1oS7nDxs6jQ==", + "dev": true, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/expect": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/expect/-/expect-27.5.1.tgz", + "integrity": "sha512-E1q5hSUG2AmYQwQJ041nvgpkODHQvB+RKlB4IYdru6uJsyFTRyZAP463M+1lINorwbqAmUggi6+WwkD8lCS/Dw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "jest-get-type": "^27.5.1", + "jest-matcher-utils": "^27.5.1", + "jest-message-util": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/extendable-error": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/extendable-error/-/extendable-error-0.1.7.tgz", + "integrity": "sha512-UOiS2in6/Q0FK0R0q6UY9vYpQ21mr/Qn1KOnte7vsACuNJf514WvCCUHSRCPcgjPT2bAhNIJdlE6bVap1GKmeg==", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-diff": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.3.0.tgz", + "integrity": "sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw==", + "dev": true, + "license": "Apache-2.0" + }, + "node_modules/fast-glob": { + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", + "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", + "dev": true, + "license": "MIT", + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + }, + "engines": { + "node": ">=8.6.0" + } + }, + "node_modules/fast-json-stable-stringify": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-levenshtein": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", + "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", + "dev": true, + "license": "MIT" + }, + "node_modules/fastq": { + "version": "1.17.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", + "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==", + "license": "ISC", + "dependencies": { + "reusify": "^1.0.4" + } + }, + "node_modules/fb-watchman": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.2.tgz", + "integrity": "sha512-p5161BqbuCaSnB8jIbzQHOlpgsPmK5rJVDfDKO91Axs5NC1uu3HRQm6wt9cd9/+GtQQIO53JdGXXoyDpTAsgYA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "bser": "2.1.1" + } + }, + "node_modules/file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "license": "MIT", + "dependencies": { + "flat-cache": "^3.0.4" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", + "dependencies": { + "to-regex-range": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/find-cache-dir": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/find-cache-dir/-/find-cache-dir-2.1.0.tgz", + "integrity": "sha512-Tq6PixE0w/VMFfCgbONnkiQIVol/JJL7nRMi20fqzA4NRs9AfeqMGeRdPi3wIhYkxjeBaWh2rxwapn5Tu3IqOQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "commondir": "^1.0.1", + "make-dir": "^2.0.0", + "pkg-dir": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/find-cache-dir/node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/find-cache-dir/node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/find-cache-dir/node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/find-cache-dir/node_modules/path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/find-cache-dir/node_modules/pkg-dir": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-3.0.0.tgz", + "integrity": "sha512-/E57AYkoeQ25qkxMj5PBOVgF8Kiu/h7cYS30Z5+R7WaiCCBfLq58ZI/dSeaEKb9WVJV5n/03QwrN3IeWIFllvw==", + "dev": true, + "license": "MIT", + "dependencies": { + "find-up": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/flat-cache": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.2.0.tgz", + "integrity": "sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw==", + "dev": true, + "license": "MIT", + "dependencies": { + "flatted": "^3.2.9", + "keyv": "^4.5.3", + "rimraf": "^3.0.2" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/flatted": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.1.tgz", + "integrity": "sha512-X8cqMLLie7KsNUDSdzeN8FYK9rEt4Dt67OsG/DNGnYTSDBG4uFAJFBnUeiV+zCVAvwFy56IjM9sH51jVaEhNxw==", + "dev": true, + "license": "ISC" + }, + "node_modules/for-each": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", + "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-callable": "^1.1.3" + } + }, + "node_modules/form-data": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz", + "integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==", + "dev": true, + "license": "MIT", + "dependencies": { + "asynckit": "^0.4.0", + "combined-stream": "^1.0.8", + "mime-types": "^2.1.12" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "dev": true, + "license": "ISC" + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/function.prototype.name": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.6.tgz", + "integrity": "sha512-Z5kx79swU5P27WEayXM1tBi5Ze/lbIyiNgU3qyXUOf9b2rgXYyF9Dy9Cx+IQv/Lc8WCG6L82zwUPpSS9hGehIg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "define-properties": "^1.2.0", + "es-abstract": "^1.22.1", + "functions-have-names": "^1.2.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/functions-have-names": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", + "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true, + "license": "ISC", + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, + "node_modules/get-intrinsic": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", + "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "has-proto": "^1.0.1", + "has-symbols": "^1.0.3", + "hasown": "^2.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-package-type": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz", + "integrity": "sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/get-stream": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", + "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/get-symbol-description": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz", + "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.5", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/glob": { + "version": "7.2.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", + "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.1.1", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob-parent": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", + "dependencies": { + "is-glob": "^4.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/globals": { + "version": "11.12.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz", + "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/globalthis": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz", + "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-properties": "^1.2.1", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/globby": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", + "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.2.9", + "ignore": "^5.2.0", + "merge2": "^1.4.1", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/gopd": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", + "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", + "dev": true, + "license": "MIT", + "dependencies": { + "get-intrinsic": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/graphemer": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", + "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", + "dev": true, + "license": "MIT" + }, + "node_modules/has-bigints": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.2.tgz", + "integrity": "sha512-tSvCKtBr9lkF0Ex0aQiP9N+OpV4zi2r/Nee5VkRDbaqv35RLYMzbwQfFSZZH0kR+Rd6302UJZ2p/bJCEoR3VoQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-proto": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", + "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", + "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-tostringtag": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/header-case": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/header-case/-/header-case-2.0.4.tgz", + "integrity": "sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "capital-case": "^1.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/homedir-polyfill": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/homedir-polyfill/-/homedir-polyfill-1.0.3.tgz", + "integrity": "sha512-eSmmWE5bZTK2Nou4g0AI3zZ9rswp7GRKoKXS1BLUkvPviOqs4YTN1djQIqrXy9k5gEtdLPy86JjRwsNM9tnDcA==", + "dev": true, + "license": "MIT", + "dependencies": { + "parse-passwd": "^1.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/html-encoding-sniffer": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-2.0.1.tgz", + "integrity": "sha512-D5JbOMBIR/TVZkubHT+OyT2705QvogUW4IBn6nHd756OwieSF9aDYFj4dv6HHEVGYbHaLETa3WggZYWWMyy3ZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-encoding": "^1.0.5" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/html-escaper": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", + "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", + "dev": true, + "license": "MIT" + }, + "node_modules/http-proxy-agent": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-4.0.1.tgz", + "integrity": "sha512-k0zdNgqWTGA6aeIRVpvfVob4fL52dTfaehylg0Y4UvSySvOq/Y+BOyPrgpUrA7HylqvU8vIZGsRuXmspskV0Tg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@tootallnate/once": "1", + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/https-proxy-agent": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz", + "integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==", + "dev": true, + "license": "MIT", + "dependencies": { + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/human-id": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/human-id/-/human-id-4.1.1.tgz", + "integrity": "sha512-3gKm/gCSUipeLsRYZbbdA1BD83lBoWUkZ7G9VFrhWPAU76KwYo5KR8V28bpoPm/ygy0x5/GCbpRQdY7VLYCoIg==", + "dev": true, + "license": "MIT", + "bin": { + "human-id": "dist/cli.js" + } + }, + "node_modules/human-signals": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", + "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=10.17.0" + } + }, + "node_modules/iconv-lite": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.0.tgz", + "integrity": "sha512-cf6L2Ds3h57VVmkZe+Pn+5APsT7FpqJtEhhieDCvrE2MK5Qk9MyffgQyuxQTm6BChfeZNtcOLHp9IcWRVcIcBQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/ignore": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", + "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4" + } + }, + "node_modules/ignore-by-default": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/ignore-by-default/-/ignore-by-default-1.0.1.tgz", + "integrity": "sha512-Ius2VYcGNk7T90CppJqcIkS5ooHUZyIQK+ClZfMfMNFEF9VSE73Fq+906u/CWu92x4gzZMWOwfFYckPObzdEbA==", + "dev": true, + "license": "ISC" + }, + "node_modules/import-fresh": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", + "integrity": "sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==", + "dev": true, + "license": "MIT", + "dependencies": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/import-fresh/node_modules/resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/import-local": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.1.0.tgz", + "integrity": "sha512-ASB07uLtnDs1o6EHjKpX34BKYDSqnFerfTOJL2HvMqF70LnxpjkzDB8J44oT9pu4AMPkQwf8jl6szgvNd2tRIg==", + "dev": true, + "license": "MIT", + "dependencies": { + "pkg-dir": "^4.2.0", + "resolve-cwd": "^3.0.0" + }, + "bin": { + "import-local-fixture": "fixtures/cli.js" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/import-local/node_modules/pkg-dir": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz", + "integrity": "sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "find-up": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/imurmurhash": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", + "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.19" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "dev": true, + "license": "ISC", + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/internal-slot": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", + "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==", + "dev": true, + "license": "MIT", + "dependencies": { + "es-errors": "^1.3.0", + "hasown": "^2.0.0", + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-array-buffer": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", + "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", + "dev": true, + "license": "MIT" + }, + "node_modules/is-async-function": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-async-function/-/is-async-function-2.0.0.tgz", + "integrity": "sha512-Y1JXKrfykRJGdlDwdKlLpLyMIiWqWvuSd17TvZk68PLAOGOoF4Xyav1z0Xhoi+gCYjZVeC5SI+hYFOfvXmGRCA==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-bigint": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz", + "integrity": "sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-bigints": "^1.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-binary-path": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", + "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", + "dev": true, + "license": "MIT", + "dependencies": { + "binary-extensions": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/is-boolean-object": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz", + "integrity": "sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-builtin-module": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/is-builtin-module/-/is-builtin-module-3.2.1.tgz", + "integrity": "sha512-BSLE3HnV2syZ0FK0iMA/yUGplUeMmNz4AW5fnTunbCIqZi4vG3WjJT9FHMy5D69xmAYBHXQhJdALdpwVxV501A==", + "dev": true, + "license": "MIT", + "dependencies": { + "builtin-modules": "^3.3.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-callable": { + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", + "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-core-module": { + "version": "2.13.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.1.tgz", + "integrity": "sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==", + "dev": true, + "license": "MIT", + "dependencies": { + "hasown": "^2.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-data-view": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz", + "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-date-object": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz", + "integrity": "sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-extglob": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", + "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-finalizationregistry": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-finalizationregistry/-/is-finalizationregistry-1.0.2.tgz", + "integrity": "sha512-0by5vtUJs8iFQb5TYUHHPudOR+qXYIMKtiUzvLIZITZUjknFmziyBJuLhVRc+Ds0dREFlskDNJKYIdIzu/9pfw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-generator-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/is-generator-fn/-/is-generator-fn-2.1.0.tgz", + "integrity": "sha512-cTIB4yPYL/Grw0EaSzASzg6bBy9gqCofvWN8okThAYIxKJZC+udlRAmGbM0XLeniEJSs8uEgHPGuHSe1XsOLSQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/is-generator-function": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/is-generator-function/-/is-generator-function-1.0.10.tgz", + "integrity": "sha512-jsEjy9l3yiXEQ+PsXdmBwEPcOxaXWLspKdplFUVI9vq1iZgIekeC0L167qeu86czQaxed3q/Uzuw0swL0irL8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-glob": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", + "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", + "dependencies": { + "is-extglob": "^2.1.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-map": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", + "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-module": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-module/-/is-module-1.0.0.tgz", + "integrity": "sha512-51ypPSPCoTEIN9dy5Oy+h4pShgJmPCygKfyRCISBI+JoWT/2oJvK8QPxmwv7b/p239jXrm9M1mlQbyKJ5A152g==", + "dev": true, + "license": "MIT" + }, + "node_modules/is-negative-zero": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", + "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/is-number-object": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.7.tgz", + "integrity": "sha512-k1U0IRzLMo7ZlYIfzRu23Oh6MiIFasgpb9X76eqfFZAqwH44UI4KTBvBYIZ1dSL9ZzChTB9ShHfLkR4pdW5krQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-path-inside": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", + "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/is-plain-object": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-2.0.4.tgz", + "integrity": "sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==", + "dev": true, + "license": "MIT", + "dependencies": { + "isobject": "^3.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/is-potential-custom-element-name": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-potential-custom-element-name/-/is-potential-custom-element-name-1.0.1.tgz", + "integrity": "sha512-bCYeRA2rVibKZd+s2625gGnGF/t7DSqDs4dP7CrLA1m7jKWz6pps0LpYLJN8Q64HtmPKJ1hrN3nzPNKFEKOUiQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/is-reference": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/is-reference/-/is-reference-1.2.1.tgz", + "integrity": "sha512-U82MsXXiFIrjCK4otLT+o2NA2Cd2g5MLoOVXUZjIOhLurrRxpEXzI8O0KZHr3IjLvlAH1kTPYSuqer5T9ZVBKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "*" + } + }, + "node_modules/is-regex": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz", + "integrity": "sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-set": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", + "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-shared-array-buffer": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz", + "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-string": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz", + "integrity": "sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-subdir": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/is-subdir/-/is-subdir-1.2.0.tgz", + "integrity": "sha512-2AT6j+gXe/1ueqbW6fLZJiIw3F8iXGJtt0yDrZaBhAZEG1raiTxKWU+IPqMCzQAXOUCKdA4UDMgacKH25XG2Cw==", + "dev": true, + "license": "MIT", + "dependencies": { + "better-path-resolve": "1.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/is-symbol": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz", + "integrity": "sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-symbols": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-typed-array": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", + "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", + "dev": true, + "license": "MIT", + "dependencies": { + "which-typed-array": "^1.1.14" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-typedarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", + "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", + "dev": true, + "license": "MIT" + }, + "node_modules/is-weakmap": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", + "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakref": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", + "integrity": "sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-weakset": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.3.tgz", + "integrity": "sha512-LvIm3/KWzS9oRFHugab7d+M/GcBXuXX5xZkzPmN+NxihdQlZUQ4dWuSV1xR/sq6upL1TJEDrfBgRepHFdBtSNQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-windows": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/is-windows/-/is-windows-1.0.2.tgz", + "integrity": "sha512-eXK1UInq2bPmjyX6e3VHIzMLobc4J94i4AWn+Hpq3OU5KkrRC96OAcR3PRJ/pGu6m8TRnBHP9dkXQVsT/COVIA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/isarray": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "dev": true, + "license": "MIT" + }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "dev": true, + "license": "ISC" + }, + "node_modules/isobject": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/isobject/-/isobject-3.0.1.tgz", + "integrity": "sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/istanbul-lib-coverage": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz", + "integrity": "sha512-O8dpsF+r0WV/8MNRKfnmrtCWhuKjxrq2w+jpzBL5UZKTi2LeVWnWOmWRxFlesJONmc+wLAGvKQZEOanko0LFTg==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-instrument": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.2.1.tgz", + "integrity": "sha512-pzqtp31nLv/XFOzXGuvhCb8qhjmTVo5vjVk19XE4CRlSWz0KoeJ3bw9XsA7nOp9YBf4qHjwBxkDzKcME/J29Yg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "@babel/core": "^7.12.3", + "@babel/parser": "^7.14.7", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-coverage": "^3.2.0", + "semver": "^6.3.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/istanbul-lib-report": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz", + "integrity": "sha512-GCfE1mtsHGOELCU8e/Z7YWzpmybrx/+dSTfLrvY8qRmaY6zXTKWn6WQIjaAFw069icm6GVMNkgu0NzI4iPZUNw==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "istanbul-lib-coverage": "^3.0.0", + "make-dir": "^4.0.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-lib-report/node_modules/make-dir": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", + "integrity": "sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==", + "dev": true, + "license": "MIT", + "dependencies": { + "semver": "^7.5.3" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/istanbul-lib-report/node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-lib-source-maps": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.1.tgz", + "integrity": "sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "debug": "^4.1.1", + "istanbul-lib-coverage": "^3.0.0", + "source-map": "^0.6.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/istanbul-reports": { + "version": "3.1.7", + "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.7.tgz", + "integrity": "sha512-BewmUXImeuRk2YY0PVbxgKAysvhRPUQE0h5QRM++nVWyubKGV0l8qQ5op8+B2DOmwSe63Jivj0BjkPQVf8fP5g==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "html-escaper": "^2.0.0", + "istanbul-lib-report": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/iterator.prototype": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/iterator.prototype/-/iterator.prototype-1.1.2.tgz", + "integrity": "sha512-DR33HMMr8EzwuRL8Y9D3u2BMj8+RqSE850jfGu59kS7tbmPLzGkZmVSfyCFSDxuZiEY6Rzt3T2NA/qU+NwVj1w==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-properties": "^1.2.1", + "get-intrinsic": "^1.2.1", + "has-symbols": "^1.0.3", + "reflect.getprototypeof": "^1.0.4", + "set-function-name": "^2.0.1" + } + }, + "node_modules/jest": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest/-/jest-27.5.1.tgz", + "integrity": "sha512-Yn0mADZB89zTtjkPJEXwrac3LHudkQMR+Paqa8uxJHCBr9agxztUifWCyiYrjhMPBoUVBjyny0I7XH6ozDr7QQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/core": "^27.5.1", + "import-local": "^3.0.2", + "jest-cli": "^27.5.1" + }, + "bin": { + "jest": "bin/jest.js" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/jest-changed-files": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-27.5.1.tgz", + "integrity": "sha512-buBLMiByfWGCoMsLLzGUUSpAmIAGnbR2KJoMN10ziLhOLvP4e0SlypHnAel8iqQXTrcbmfEY9sSqae5sgUsTvw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "execa": "^5.0.0", + "throat": "^6.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-circus": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-circus/-/jest-circus-27.5.1.tgz", + "integrity": "sha512-D95R7x5UtlMA5iBYsOHFFbMD/GVA4R/Kdq15f7xYWUfWHBto9NYRsOvnSauTgdF+ogCpJ4tyKOXhUifxS65gdw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "co": "^4.6.0", + "dedent": "^0.7.0", + "expect": "^27.5.1", + "is-generator-fn": "^2.0.0", + "jest-each": "^27.5.1", + "jest-matcher-utils": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-runtime": "^27.5.1", + "jest-snapshot": "^27.5.1", + "jest-util": "^27.5.1", + "pretty-format": "^27.5.1", + "slash": "^3.0.0", + "stack-utils": "^2.0.3", + "throat": "^6.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-cli": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-27.5.1.tgz", + "integrity": "sha512-Hc6HOOwYq4/74/c62dEE3r5elx8wjYqxY0r0G/nFrLDPMFRu6RA/u8qINOIkvhxG7mMQ5EJsOGfRpI8L6eFUVw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/core": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/types": "^27.5.1", + "chalk": "^4.0.0", + "exit": "^0.1.2", + "graceful-fs": "^4.2.9", + "import-local": "^3.0.2", + "jest-config": "^27.5.1", + "jest-util": "^27.5.1", + "jest-validate": "^27.5.1", + "prompts": "^2.0.1", + "yargs": "^16.2.0" + }, + "bin": { + "jest": "bin/jest.js" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "node-notifier": "^8.0.1 || ^9.0.0 || ^10.0.0" + }, + "peerDependenciesMeta": { + "node-notifier": { + "optional": true + } + } + }, + "node_modules/jest-cli/node_modules/cliui": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", + "integrity": "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" + } + }, + "node_modules/jest-cli/node_modules/yargs": { + "version": "16.2.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", + "integrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==", + "dev": true, + "license": "MIT", + "dependencies": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/jest-cli/node_modules/yargs-parser": { + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/jest-config": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-27.5.1.tgz", + "integrity": "sha512-5sAsjm6tGdsVbW9ahcChPAFCk4IlkQUknH5AvKjuLTSlcO/wCZKyFdn7Rg0EkC+OGgWODEy2hDpWB1PgzH0JNA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.8.0", + "@jest/test-sequencer": "^27.5.1", + "@jest/types": "^27.5.1", + "babel-jest": "^27.5.1", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "deepmerge": "^4.2.2", + "glob": "^7.1.1", + "graceful-fs": "^4.2.9", + "jest-circus": "^27.5.1", + "jest-environment-jsdom": "^27.5.1", + "jest-environment-node": "^27.5.1", + "jest-get-type": "^27.5.1", + "jest-jasmine2": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-runner": "^27.5.1", + "jest-util": "^27.5.1", + "jest-validate": "^27.5.1", + "micromatch": "^4.0.4", + "parse-json": "^5.2.0", + "pretty-format": "^27.5.1", + "slash": "^3.0.0", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "peerDependencies": { + "ts-node": ">=9.0.0" + }, + "peerDependenciesMeta": { + "ts-node": { + "optional": true + } + } + }, + "node_modules/jest-diff": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-27.5.1.tgz", + "integrity": "sha512-m0NvkX55LDt9T4mctTEgnZk3fmEg3NRYutvMPWM/0iPnkFj2wIeF45O1718cMSOFO1vINkqmxqD8vE37uTEbqw==", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^4.0.0", + "diff-sequences": "^27.5.1", + "jest-get-type": "^27.5.1", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-docblock": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-27.5.1.tgz", + "integrity": "sha512-rl7hlABeTsRYxKiUfpHrQrG4e2obOiTQWfMEH3PxPjOtdsfLQO4ReWSZaQ7DETm4xu07rl4q/h4zcKXyU0/OzQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "detect-newline": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-each": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-27.5.1.tgz", + "integrity": "sha512-1Ff6p+FbhT/bXQnEouYy00bkNSY7OUpfIcmdl8vZ31A1UUaurOLPA8a8BbJOF2RDUElwJhmeaV7LnagI+5UwNQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "chalk": "^4.0.0", + "jest-get-type": "^27.5.1", + "jest-util": "^27.5.1", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-environment-jsdom": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-environment-jsdom/-/jest-environment-jsdom-27.5.1.tgz", + "integrity": "sha512-TFBvkTC1Hnnnrka/fUb56atfDtJ9VMZ94JkjTbggl1PEpwrYtUBKMezB3inLmWqQsXYLcMwNoDQwoBTAvFfsfw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/fake-timers": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "jest-mock": "^27.5.1", + "jest-util": "^27.5.1", + "jsdom": "^16.6.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-environment-node": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-27.5.1.tgz", + "integrity": "sha512-Jt4ZUnxdOsTGwSRAfKEnE6BcwsSPNOijjwifq5sDFSA2kesnXTvNqKHYgM0hDq3549Uf/KzdXNYn4wMZJPlFLw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/fake-timers": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "jest-mock": "^27.5.1", + "jest-util": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-get-type": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-27.5.1.tgz", + "integrity": "sha512-2KY95ksYSaK7DMBWQn6dQz3kqAf3BB64y2udeG+hv4KfSOb9qwcYQstTJc1KCbsix+wLZWZYN8t7nwX3GOBLRw==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-haste-map": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-27.5.1.tgz", + "integrity": "sha512-7GgkZ4Fw4NFbMSDSpZwXeBiIbx+t/46nJ2QitkOjvwPYyZmqttu2TDSimMHP1EkPOi4xUZAN1doE5Vd25H4Jng==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@types/graceful-fs": "^4.1.2", + "@types/node": "*", + "anymatch": "^3.0.3", + "fb-watchman": "^2.0.0", + "graceful-fs": "^4.2.9", + "jest-regex-util": "^27.5.1", + "jest-serializer": "^27.5.1", + "jest-util": "^27.5.1", + "jest-worker": "^27.5.1", + "micromatch": "^4.0.4", + "walker": "^1.0.7" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + }, + "optionalDependencies": { + "fsevents": "^2.3.2" + } + }, + "node_modules/jest-jasmine2": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-jasmine2/-/jest-jasmine2-27.5.1.tgz", + "integrity": "sha512-jtq7VVyG8SqAorDpApwiJJImd0V2wv1xzdheGHRGyuT7gZm6gG47QEskOlzsN1PG/6WNaCo5pmwMHDf3AkG2pQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/source-map": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "co": "^4.6.0", + "expect": "^27.5.1", + "is-generator-fn": "^2.0.0", + "jest-each": "^27.5.1", + "jest-matcher-utils": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-runtime": "^27.5.1", + "jest-snapshot": "^27.5.1", + "jest-util": "^27.5.1", + "pretty-format": "^27.5.1", + "throat": "^6.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-leak-detector": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-27.5.1.tgz", + "integrity": "sha512-POXfWAMvfU6WMUXftV4HolnJfnPOGEu10fscNCA76KBpRRhcMN2c8d3iT2pxQS3HLbA+5X4sOUPzYO2NUyIlHQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "jest-get-type": "^27.5.1", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-matcher-utils": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-27.5.1.tgz", + "integrity": "sha512-z2uTx/T6LBaCoNWNFWwChLBKYxTMcGBRjAt+2SbP929/Fflb9aa5LGma654Rz8z9HLxsrUaYzxE9T/EFIL/PAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^4.0.0", + "jest-diff": "^27.5.1", + "jest-get-type": "^27.5.1", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-message-util": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-27.5.1.tgz", + "integrity": "sha512-rMyFe1+jnyAAf+NHwTclDz0eAaLkVDdKVHHBFWsBWHnnh5YeJMNWWsv7AbFYXfK3oTqvL7VTWkhNLu1jX24D+g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.12.13", + "@jest/types": "^27.5.1", + "@types/stack-utils": "^2.0.0", + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "micromatch": "^4.0.4", + "pretty-format": "^27.5.1", + "slash": "^3.0.0", + "stack-utils": "^2.0.3" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-mock": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-27.5.1.tgz", + "integrity": "sha512-K4jKbY1d4ENhbrG2zuPWaQBvDly+iZ2yAW+T1fATN78hc0sInwn7wZB8XtlNnvHug5RMwV897Xm4LqmPM4e2Og==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@types/node": "*" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-pnp-resolver": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/jest-pnp-resolver/-/jest-pnp-resolver-1.2.3.tgz", + "integrity": "sha512-+3NpwQEnRoIBtx4fyhblQDPgJI0H1IEIkX7ShLUjPGA7TtUTvI1oiKi3SR4oBR0hQhQR80l4WAe5RrXBwWMA8w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + }, + "peerDependencies": { + "jest-resolve": "*" + }, + "peerDependenciesMeta": { + "jest-resolve": { + "optional": true + } + } + }, + "node_modules/jest-regex-util": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-27.5.1.tgz", + "integrity": "sha512-4bfKq2zie+x16okqDXjXn9ql2B0dScQu+vcwe4TvFVhkVyuWLqpZrZtXxLLWoXYgn0E87I6r6GRYHF7wFZBUvg==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-resolve": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-27.5.1.tgz", + "integrity": "sha512-FFDy8/9E6CV83IMbDpcjOhumAQPDyETnU2KZ1O98DwTnz8AOBsW/Xv3GySr1mOZdItLR+zDZ7I/UdTFbgSOVCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^27.5.1", + "jest-pnp-resolver": "^1.2.2", + "jest-util": "^27.5.1", + "jest-validate": "^27.5.1", + "resolve": "^1.20.0", + "resolve.exports": "^1.1.0", + "slash": "^3.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-resolve-dependencies": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-27.5.1.tgz", + "integrity": "sha512-QQOOdY4PE39iawDn5rzbIePNigfe5B9Z91GDD1ae/xNDlu9kaat8QQ5EKnNmVWPV54hUdxCVwwj6YMgR2O7IOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-snapshot": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-runner": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-27.5.1.tgz", + "integrity": "sha512-g4NPsM4mFCOwFKXO4p/H/kWGdJp9V8kURY2lX8Me2drgXqG7rrZAx5kv+5H7wtt/cdFIjhqYx1HrlqWHaOvDaQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^27.5.1", + "@jest/environment": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "emittery": "^0.8.1", + "graceful-fs": "^4.2.9", + "jest-docblock": "^27.5.1", + "jest-environment-jsdom": "^27.5.1", + "jest-environment-node": "^27.5.1", + "jest-haste-map": "^27.5.1", + "jest-leak-detector": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-runtime": "^27.5.1", + "jest-util": "^27.5.1", + "jest-worker": "^27.5.1", + "source-map-support": "^0.5.6", + "throat": "^6.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-runtime": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-27.5.1.tgz", + "integrity": "sha512-o7gxw3Gf+H2IGt8fv0RiyE1+r83FJBRruoA+FXrlHw6xEyBsU8ugA6IPfTdVyA0w8HClpbK+DGJxH59UrNMx8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/environment": "^27.5.1", + "@jest/fake-timers": "^27.5.1", + "@jest/globals": "^27.5.1", + "@jest/source-map": "^27.5.1", + "@jest/test-result": "^27.5.1", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "chalk": "^4.0.0", + "cjs-module-lexer": "^1.0.0", + "collect-v8-coverage": "^1.0.0", + "execa": "^5.0.0", + "glob": "^7.1.3", + "graceful-fs": "^4.2.9", + "jest-haste-map": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-mock": "^27.5.1", + "jest-regex-util": "^27.5.1", + "jest-resolve": "^27.5.1", + "jest-snapshot": "^27.5.1", + "jest-util": "^27.5.1", + "slash": "^3.0.0", + "strip-bom": "^4.0.0" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-runtime/node_modules/strip-bom": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-4.0.0.tgz", + "integrity": "sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/jest-serializer": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-serializer/-/jest-serializer-27.5.1.tgz", + "integrity": "sha512-jZCyo6iIxO1aqUxpuBlwTDMkzOAJS4a3eYz3YzgxxVQFwLeSA7Jfq5cbqCY+JLvTDrWirgusI/0KwxKMgrdf7w==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*", + "graceful-fs": "^4.2.9" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-snapshot": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-27.5.1.tgz", + "integrity": "sha512-yYykXI5a0I31xX67mgeLw1DZ0bJB+gpq5IpSuCAoyDi0+BhgU/RIrL+RTzDmkNTchvDFWKP8lp+w/42Z3us5sA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/core": "^7.7.2", + "@babel/generator": "^7.7.2", + "@babel/plugin-syntax-typescript": "^7.7.2", + "@babel/traverse": "^7.7.2", + "@babel/types": "^7.0.0", + "@jest/transform": "^27.5.1", + "@jest/types": "^27.5.1", + "@types/babel__traverse": "^7.0.4", + "@types/prettier": "^2.1.5", + "babel-preset-current-node-syntax": "^1.0.0", + "chalk": "^4.0.0", + "expect": "^27.5.1", + "graceful-fs": "^4.2.9", + "jest-diff": "^27.5.1", + "jest-get-type": "^27.5.1", + "jest-haste-map": "^27.5.1", + "jest-matcher-utils": "^27.5.1", + "jest-message-util": "^27.5.1", + "jest-util": "^27.5.1", + "natural-compare": "^1.4.0", + "pretty-format": "^27.5.1", + "semver": "^7.3.2" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-snapshot/node_modules/semver": { + "version": "7.6.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", + "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/jest-util": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-27.5.1.tgz", + "integrity": "sha512-Kv2o/8jNvX1MQ0KGtw480E/w4fBCDOnH6+6DmeKi6LZUIlKA5kwY0YNdlzaWTiVgxqAqik11QyxDOKk543aKXw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "@types/node": "*", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "graceful-fs": "^4.2.9", + "picomatch": "^2.2.3" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-validate": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-27.5.1.tgz", + "integrity": "sha512-thkNli0LYTmOI1tDB3FI1S1RTp/Bqyd9pTarJwL87OIBFuqEb5Apv5EaApEudYg4g86e3CT6kM0RowkhtEnCBQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^27.5.1", + "camelcase": "^6.2.0", + "chalk": "^4.0.0", + "jest-get-type": "^27.5.1", + "leven": "^3.1.0", + "pretty-format": "^27.5.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/jest-validate/node_modules/camelcase": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz", + "integrity": "sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-watch-typeahead": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/jest-watch-typeahead/-/jest-watch-typeahead-1.1.0.tgz", + "integrity": "sha512-Va5nLSJTN7YFtC2jd+7wsoe1pNe5K4ShLux/E5iHEwlB9AxaxmggY7to9KUqKojhaJw3aXqt5WAb4jGPOolpEw==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-escapes": "^4.3.1", + "chalk": "^4.0.0", + "jest-regex-util": "^28.0.0", + "jest-watcher": "^28.0.0", + "slash": "^4.0.0", + "string-length": "^5.0.1", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + }, + "peerDependencies": { + "jest": "^27.0.0 || ^28.0.0" + } + }, + "node_modules/jest-watch-typeahead/node_modules/ansi-regex": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", + "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/jest-watch-typeahead/node_modules/char-regex": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-2.0.1.tgz", + "integrity": "sha512-oSvEeo6ZUD7NepqAat3RqoucZ5SeqLJgOvVIwkafu6IP3V0pO38s/ypdVUmDDK6qIIHNlYHJAKX9E7R7HoKElw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.20" + } + }, + "node_modules/jest-watch-typeahead/node_modules/jest-regex-util": { + "version": "28.0.2", + "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-28.0.2.tgz", + "integrity": "sha512-4s0IgyNIy0y9FK+cjoVYoxamT7Zeo7MhzqRGx7YDYmaQn1wucY9rotiGkBzzcMXTtjrCAP/f7f+E0F7+fxPNdw==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + } + }, + "node_modules/jest-watch-typeahead/node_modules/slash": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", + "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-watch-typeahead/node_modules/string-length": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/string-length/-/string-length-5.0.1.tgz", + "integrity": "sha512-9Ep08KAMUn0OadnVaBuRdE2l615CQ508kr0XMadjClfYpdCyvrbFp6Taebo8yyxokQ4viUd/xPPUA4FGgUa0ow==", + "dev": true, + "license": "MIT", + "dependencies": { + "char-regex": "^2.0.0", + "strip-ansi": "^7.0.1" + }, + "engines": { + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/jest-watch-typeahead/node_modules/strip-ansi": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.0.1" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" + } + }, + "node_modules/jest-watcher": { + "version": "28.1.3", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-28.1.3.tgz", + "integrity": "sha512-t4qcqj9hze+jviFPUN3YAtAEeFnr/azITXQEMARf5cMwKY2SMBRnCQTXLixTl20OR6mLh9KLMrgVJgJISym+1g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/test-result": "^28.1.3", + "@jest/types": "^28.1.3", + "@types/node": "*", + "ansi-escapes": "^4.2.1", + "chalk": "^4.0.0", + "emittery": "^0.10.2", + "jest-util": "^28.1.3", + "string-length": "^4.0.1" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + } + }, + "node_modules/jest-watcher/node_modules/@jest/console": { + "version": "28.1.3", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-28.1.3.tgz", + "integrity": "sha512-QPAkP5EwKdK/bxIr6C1I4Vs0rm2nHiANzj/Z5X2JQkrZo6IqvC4ldZ9K95tF0HdidhA8Bo6egxSzUFPYKcEXLw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^28.1.3", + "@types/node": "*", + "chalk": "^4.0.0", + "jest-message-util": "^28.1.3", + "jest-util": "^28.1.3", + "slash": "^3.0.0" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + } + }, + "node_modules/jest-watcher/node_modules/@jest/test-result": { + "version": "28.1.3", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-28.1.3.tgz", + "integrity": "sha512-kZAkxnSE+FqE8YjW8gNuoVkkC9I7S1qmenl8sGcDOLropASP+BkcGKwhXoyqQuGOGeYY0y/ixjrd/iERpEXHNg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/console": "^28.1.3", + "@jest/types": "^28.1.3", + "@types/istanbul-lib-coverage": "^2.0.0", + "collect-v8-coverage": "^1.0.0" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + } + }, + "node_modules/jest-watcher/node_modules/@jest/types": { + "version": "28.1.3", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-28.1.3.tgz", + "integrity": "sha512-RyjiyMUZrKz/c+zlMFO1pm70DcIlST8AeWTkoUdZevew44wcNZQHsEVOiCVtgVnlFFD82FPaXycys58cf2muVQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/schemas": "^28.1.3", + "@types/istanbul-lib-coverage": "^2.0.0", + "@types/istanbul-reports": "^3.0.0", + "@types/node": "*", + "@types/yargs": "^17.0.8", + "chalk": "^4.0.0" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + } + }, + "node_modules/jest-watcher/node_modules/@types/yargs": { + "version": "17.0.32", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-17.0.32.tgz", + "integrity": "sha512-xQ67Yc/laOG5uMfX/093MRlGGCIBzZMarVa+gfNKJxWAIgykYpVGkBdbqEzGDDfCrVUj6Hiff4mTZ5BA6TmAog==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/yargs-parser": "*" + } + }, + "node_modules/jest-watcher/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/jest-watcher/node_modules/emittery": { + "version": "0.10.2", + "resolved": "https://registry.npmjs.org/emittery/-/emittery-0.10.2.tgz", + "integrity": "sha512-aITqOwnLanpHLNXZJENbOgjUBeHocD+xsSJmNrjovKBW5HbSpW3d1pEls7GFQPUWXiwG9+0P4GtHfEqC/4M0Iw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sindresorhus/emittery?sponsor=1" + } + }, + "node_modules/jest-watcher/node_modules/jest-message-util": { + "version": "28.1.3", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-28.1.3.tgz", + "integrity": "sha512-PFdn9Iewbt575zKPf1286Ht9EPoJmYT7P0kY+RibeYZ2XtOr53pDLEFoTWXbd1h4JiGiWpTBC84fc8xMXQMb7g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.12.13", + "@jest/types": "^28.1.3", + "@types/stack-utils": "^2.0.0", + "chalk": "^4.0.0", + "graceful-fs": "^4.2.9", + "micromatch": "^4.0.4", + "pretty-format": "^28.1.3", + "slash": "^3.0.0", + "stack-utils": "^2.0.3" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + } + }, + "node_modules/jest-watcher/node_modules/jest-util": { + "version": "28.1.3", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-28.1.3.tgz", + "integrity": "sha512-XdqfpHwpcSRko/C35uLYFM2emRAltIIKZiJ9eAmhjsj0CqZMa0p1ib0R5fWIqGhn1a103DebTbpqIaP1qCQ6tQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/types": "^28.1.3", + "@types/node": "*", + "chalk": "^4.0.0", + "ci-info": "^3.2.0", + "graceful-fs": "^4.2.9", + "picomatch": "^2.2.3" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + } + }, + "node_modules/jest-watcher/node_modules/pretty-format": { + "version": "28.1.3", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-28.1.3.tgz", + "integrity": "sha512-8gFb/To0OmxHR9+ZTb14Df2vNxdGCX8g1xWGUTqUw5TiZvcQf5sHKObd5UcPyLLyowNwDAMTF3XWOG1B6mxl1Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jest/schemas": "^28.1.3", + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^18.0.0" + }, + "engines": { + "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0" + } + }, + "node_modules/jest-watcher/node_modules/react-is": { + "version": "18.3.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", + "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==", + "dev": true, + "license": "MIT" + }, + "node_modules/jest-worker": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", + "integrity": "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/jest-worker/node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/js-yaml": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz", + "integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/jsdom": { + "version": "16.7.0", + "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-16.7.0.tgz", + "integrity": "sha512-u9Smc2G1USStM+s/x1ru5Sxrl6mPYCbByG1U/hUmqaVsm4tbNyS7CicOSRyuGQYZhTu0h84qkZZQ/I+dzizSVw==", + "dev": true, + "license": "MIT", + "dependencies": { + "abab": "^2.0.5", + "acorn": "^8.2.4", + "acorn-globals": "^6.0.0", + "cssom": "^0.4.4", + "cssstyle": "^2.3.0", + "data-urls": "^2.0.0", + "decimal.js": "^10.2.1", + "domexception": "^2.0.1", + "escodegen": "^2.0.0", + "form-data": "^3.0.0", + "html-encoding-sniffer": "^2.0.1", + "http-proxy-agent": "^4.0.1", + "https-proxy-agent": "^5.0.0", + "is-potential-custom-element-name": "^1.0.1", + "nwsapi": "^2.2.0", + "parse5": "6.0.1", + "saxes": "^5.0.1", + "symbol-tree": "^3.2.4", + "tough-cookie": "^4.0.0", + "w3c-hr-time": "^1.0.2", + "w3c-xmlserializer": "^2.0.0", + "webidl-conversions": "^6.1.0", + "whatwg-encoding": "^1.0.5", + "whatwg-mimetype": "^2.3.0", + "whatwg-url": "^8.5.0", + "ws": "^7.4.6", + "xml-name-validator": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "peerDependencies": { + "canvas": "^2.5.0" + }, + "peerDependenciesMeta": { + "canvas": { + "optional": true + } + } + }, + "node_modules/jsesc": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", + "integrity": "sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==", + "dev": true, + "license": "MIT", + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/json-buffer": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", + "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-schema-traverse": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", + "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-stable-stringify-without-jsonify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", + "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", + "dev": true, + "license": "MIT" + }, + "node_modules/json5": { + "version": "2.2.3", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", + "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "dev": true, + "license": "MIT", + "bin": { + "json5": "lib/cli.js" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg==", + "dev": true, + "license": "MIT", + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/jsx-ast-utils": { + "version": "3.3.5", + "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.5.tgz", + "integrity": "sha512-ZZow9HBI5O6EPgSJLUb8n2NKgmVWTwCvHGwFuJlMjvLFqlGG6pjirPhtdsseaLZjSibD8eegzmYpUZwoIlj2cQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "array-includes": "^3.1.6", + "array.prototype.flat": "^1.3.1", + "object.assign": "^4.1.4", + "object.values": "^1.1.6" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/keyv": { + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "json-buffer": "3.0.1" + } + }, + "node_modules/kind-of": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", + "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/kleur": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", + "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/language-subtag-registry": { + "version": "0.3.23", + "resolved": "https://registry.npmjs.org/language-subtag-registry/-/language-subtag-registry-0.3.23.tgz", + "integrity": "sha512-0K65Lea881pHotoGEa5gDlMxt3pctLi2RplBb7Ezh4rRdLEOtgi7n4EwK9lamnUCkKBqaeKRVebTq6BAxSkpXQ==", + "dev": true, + "license": "CC0-1.0" + }, + "node_modules/language-tags": { + "version": "1.0.9", + "resolved": "https://registry.npmjs.org/language-tags/-/language-tags-1.0.9.tgz", + "integrity": "sha512-MbjN408fEndfiQXbFQ1vnd+1NoLDsnQW41410oQBXiyXDMYH5z505juWa4KUE1LqxRC7DgOgZDbKLxHIwm27hA==", + "dev": true, + "license": "MIT", + "dependencies": { + "language-subtag-registry": "^0.3.20" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/leven": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", + "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/lines-and-columns": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", + "dev": true, + "license": "MIT" + }, + "node_modules/locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^4.1.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.debounce": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", + "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/lodash.startcase": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/lodash.startcase/-/lodash.startcase-4.4.0.tgz", + "integrity": "sha512-+WKqsK294HMSc2jEbNgpHpd0JfIBhp7rEV4aqXWqFr6AlXov+SlcgB1Fv01y2kGe3Gc8nMW7VA0SrGuSkRfIEg==", + "dev": true, + "license": "MIT" + }, + "node_modules/loose-envify": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", + "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "js-tokens": "^3.0.0 || ^4.0.0" + }, + "bin": { + "loose-envify": "cli.js" + } + }, + "node_modules/lower-case": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", + "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", + "dev": true, + "license": "MIT", + "dependencies": { + "tslib": "^2.0.3" + } + }, + "node_modules/lru-cache": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", + "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "dev": true, + "license": "ISC", + "dependencies": { + "yallist": "^3.0.2" + } + }, + "node_modules/magic-string": { + "version": "0.30.12", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.12.tgz", + "integrity": "sha512-Ea8I3sQMVXr8JhN4z+H/d8zwo+tYDgHE9+5G4Wnrwhs0gaK9fXTKx0Tw5Xwsd/bCPTTZNRAdpyzvoeORe9LYpw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0" + } + }, + "node_modules/magic-string/node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", + "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/make-dir": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-2.1.0.tgz", + "integrity": "sha512-LS9X+dc8KLxXCb8dni79fLIIUA5VyZoyjSMCwTluaXA0o27cCK0bhXkpgw+sTXVpPy/lSO57ilRixqk0vDmtRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "pify": "^4.0.1", + "semver": "^5.6.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/make-dir/node_modules/semver": { + "version": "5.7.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", + "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/makeerror": { + "version": "1.0.12", + "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", + "integrity": "sha512-JmqCvUhmt43madlpFzG4BQzG2Z3m6tvQDNKdClZnO3VbIudJYmxsT0FNJMeiB2+JTSlTQTSbU8QdesVmwJcmLg==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "tmpl": "1.0.5" + } + }, + "node_modules/merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "dev": true, + "license": "MIT" + }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "license": "MIT", + "engines": { + "node": ">= 8" + } + }, + "node_modules/micromatch": { + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", + "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "braces": "^3.0.3", + "picomatch": "^2.3.1" + }, + "engines": { + "node": ">=8.6" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dev": true, + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mimic-fn": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", + "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/minimatch": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/mri": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/mri/-/mri-1.2.0.tgz", + "integrity": "sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true, + "license": "MIT" + }, + "node_modules/natural-compare": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", + "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", + "dev": true, + "license": "MIT" + }, + "node_modules/natural-compare-lite": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/natural-compare-lite/-/natural-compare-lite-1.4.0.tgz", + "integrity": "sha512-Tj+HTDSJJKaZnfiuw+iaF9skdPpTo2GtEly5JHnWV/hfv2Qj/9RKsGISQtLh2ox3l5EAGw487hnBee0sIJ6v2g==", + "dev": true, + "license": "MIT" + }, + "node_modules/no-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", + "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", + "dev": true, + "license": "MIT", + "dependencies": { + "lower-case": "^2.0.2", + "tslib": "^2.0.3" + } + }, + "node_modules/node-environment-flags": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/node-environment-flags/-/node-environment-flags-1.0.6.tgz", + "integrity": "sha512-5Evy2epuL+6TM0lCQGpFIj6KwiEsGh1SrHUhTbNX+sLbBtjidPZFAnVK9y5yU1+h//RitLbRHTIMyxQPtxMdHw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "object.getownpropertydescriptors": "^2.0.3", + "semver": "^5.7.0" + } + }, + "node_modules/node-environment-flags/node_modules/semver": { + "version": "5.7.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", + "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/node-fetch/node_modules/tr46": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", + "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", + "dev": true, + "license": "MIT" + }, + "node_modules/node-fetch/node_modules/webidl-conversions": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", + "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/node-fetch/node_modules/whatwg-url": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", + "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" + } + }, + "node_modules/node-int64": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz", + "integrity": "sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw==", + "dev": true, + "license": "MIT" + }, + "node_modules/node-releases": { + "version": "2.0.18", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.18.tgz", + "integrity": "sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g==", + "dev": true, + "license": "MIT" + }, + "node_modules/nodemon": { + "version": "2.0.22", + "resolved": "https://registry.npmjs.org/nodemon/-/nodemon-2.0.22.tgz", + "integrity": "sha512-B8YqaKMmyuCO7BowF1Z1/mkPqLk6cs/l63Ojtd6otKjMx47Dq1utxfRxcavH1I7VSaL8n5BUaoutadnsX3AAVQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "chokidar": "^3.5.2", + "debug": "^3.2.7", + "ignore-by-default": "^1.0.1", + "minimatch": "^3.1.2", + "pstree.remy": "^1.1.8", + "semver": "^5.7.1", + "simple-update-notifier": "^1.0.7", + "supports-color": "^5.5.0", + "touch": "^3.1.0", + "undefsafe": "^2.0.5" + }, + "bin": { + "nodemon": "bin/nodemon.js" + }, + "engines": { + "node": ">=8.10.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/nodemon" + } + }, + "node_modules/nodemon/node_modules/debug": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", + "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ms": "^2.1.1" + } + }, + "node_modules/nodemon/node_modules/has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/nodemon/node_modules/semver": { + "version": "5.7.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", + "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver" + } + }, + "node_modules/nodemon/node_modules/supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^3.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/normalize-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-key": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/nwsapi": { + "version": "2.2.10", + "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.10.tgz", + "integrity": "sha512-QK0sRs7MKv0tKe1+5uZIQk/C8XGza4DAnztJG8iD+TpJIORARrCxczA738awHrZoHeTjSSoHqao2teO0dC/gFQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/object-inspect": { + "version": "1.13.1", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.1.tgz", + "integrity": "sha512-5qoj1RUiKOMsCCNLV1CBiPYE10sziTsnmNxkAI/rZhiD63CF7IqdFGC/XzjWjpSgLf0LxXX3bDFIh0E18f6UhQ==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.assign": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", + "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "has-symbols": "^1.0.3", + "object-keys": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.entries": { + "version": "1.1.8", + "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.8.tgz", + "integrity": "sha512-cmopxi8VwRIAw/fkijJohSfpef5PdN0pMQJN6VC/ZKvn0LIknWD8KtgY6KlQdEc4tIjcQ3HxSMmnvtzIscdaYQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.fromentries": { + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", + "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.getownpropertydescriptors": { + "version": "2.1.8", + "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.1.8.tgz", + "integrity": "sha512-qkHIGe4q0lSYMv0XI4SsBTJz3WaURhLvd0lKSgtVuOsJ2krg4SgMw3PIRQFMp07yi++UR3se2mkcLqsBNpBb/A==", + "dev": true, + "license": "MIT", + "dependencies": { + "array.prototype.reduce": "^1.0.6", + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0", + "gopd": "^1.0.1", + "safe-array-concat": "^1.1.2" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.groupby": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.3.tgz", + "integrity": "sha512-+Lhy3TQTuzXI5hevh8sBGqbmurHbbIjAi0Z4S63nthVLmLxfbj4T54a4CfZrXIrt9iP4mVAPYMo/v99taj3wjQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.hasown": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/object.hasown/-/object.hasown-1.1.4.tgz", + "integrity": "sha512-FZ9LZt9/RHzGySlBARE3VF+gE26TxR38SdmqOqliuTnl9wrKulaQs+4dee1V+Io8VfxqzAfHu6YuRgUy8OHoTg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object.values": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz", + "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, + "license": "ISC", + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/onetime": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", + "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "mimic-fn": "^2.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/optionator": { + "version": "0.9.4", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", + "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", + "dev": true, + "license": "MIT", + "dependencies": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.5" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/outdent": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/outdent/-/outdent-0.5.0.tgz", + "integrity": "sha512-/jHxFIzoMXdqPzTaCpFzAAWhpkSjZPF4Vsn6jAfNpmbH/ymsmd7Qc6VE9BGn0L6YMj6uwpQLxCECpus4ukKS9Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/p-filter": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/p-filter/-/p-filter-2.1.0.tgz", + "integrity": "sha512-ZBxxZ5sL2HghephhpGAQdoskxplTwr7ICaehZwLIlfL6acuVgZPm8yBNuRAFBGEqtD/hmUeq9eqLg2ys9Xr/yw==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-map": "^2.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^2.2.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/p-map": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/p-map/-/p-map-2.1.0.tgz", + "integrity": "sha512-y3b8Kpd8OAN444hxfBbFfj1FY/RjtTd8tzYwhUqNYXx0fXx2iX4maP4Qr6qhIKbQXI02wTLAda4fYUbDagTUFw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/package-manager-detector": { + "version": "0.2.11", + "resolved": "https://registry.npmjs.org/package-manager-detector/-/package-manager-detector-0.2.11.tgz", + "integrity": "sha512-BEnLolu+yuz22S56CU1SUKq3XC3PkwD5wv4ikR4MfGvnRVcmzXR9DwSlW2fEamyTPyXHomBJRzgapeuBvRNzJQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "quansync": "^0.2.7" + } + }, + "node_modules/param-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz", + "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==", + "dev": true, + "license": "MIT", + "dependencies": { + "dot-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "license": "MIT", + "dependencies": { + "callsites": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/parse-json": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", + "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/parse-passwd": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/parse-passwd/-/parse-passwd-1.0.0.tgz", + "integrity": "sha512-1Y1A//QUXEZK7YKz+rD9WydcE1+EuPr6ZBgKecAB8tmoW6UFv0NREVJe1p+jRxtThkcbbKkfwIbWJe/IeE6m2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/parse5": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-6.0.1.tgz", + "integrity": "sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==", + "dev": true, + "license": "MIT" + }, + "node_modules/pascal-case": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz", + "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==", + "dev": true, + "license": "MIT", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/path-browserify": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz", + "integrity": "sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==", + "license": "MIT" + }, + "node_modules/path-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/path-case/-/path-case-3.0.4.tgz", + "integrity": "sha512-qO4qCFjXqVTrcbPt/hQfhTQ+VhFsqNKOPtytgNKkKxSoEp3XPUQ8ObFuePylOIok5gjn69ry8XiULxCwot3Wfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "dot-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true, + "license": "MIT" + }, + "node_modules/path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "license": "MIT", + "engines": { + "node": ">=8.6" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/pify": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/pify/-/pify-4.0.1.tgz", + "integrity": "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/pirates": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/pirates/-/pirates-4.0.6.tgz", + "integrity": "sha512-saLsH7WeYYPiD25LDuLRRY/i+6HaPYr6G1OUlN39otzkSTxKnubR9RTxS3/Kk50s1g2JTgFwWQDQyplC5/SHZg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, + "node_modules/pkg-dir": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-5.0.0.tgz", + "integrity": "sha512-NPE8TDbzl/3YQYY7CSS228s3g2ollTFnc+Qi3tqmqJp9Vg2ovUpixcJEo2HJScN2Ez+kEaal6y70c0ehqJBJeA==", + "dev": true, + "license": "MIT", + "dependencies": { + "find-up": "^5.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/pkg-dir/node_modules/find-up": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", + "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", + "dev": true, + "license": "MIT", + "dependencies": { + "locate-path": "^6.0.0", + "path-exists": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkg-dir/node_modules/locate-path": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", + "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-locate": "^5.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkg-dir/node_modules/p-limit": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", + "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "yocto-queue": "^0.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pkg-dir/node_modules/p-locate": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", + "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "p-limit": "^3.0.2" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/pluralize": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/possible-typed-array-names": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", + "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/preact": { + "version": "10.27.2", + "resolved": "https://registry.npmjs.org/preact/-/preact-10.27.2.tgz", + "integrity": "sha512-5SYSgFKSyhCbk6SrXyMpqjb5+MQBgfvEKE/OC+PujcY34sOpqtr+0AZQtPYx5IA6VxynQ7rUPCtKzyovpj9Bpg==", + "dev": true, + "license": "MIT", + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/preact" + } + }, + "node_modules/prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/prettier": { + "version": "2.8.8", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.8.tgz", + "integrity": "sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q==", + "dev": true, + "license": "MIT", + "bin": { + "prettier": "bin-prettier.js" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } + }, + "node_modules/prettier-linter-helpers": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz", + "integrity": "sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-diff": "^1.1.2" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/pretty-format": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", + "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1", + "ansi-styles": "^5.0.0", + "react-is": "^17.0.1" + }, + "engines": { + "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" + } + }, + "node_modules/pretty-format/node_modules/ansi-styles": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", + "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/prompts": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", + "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "kleur": "^3.0.3", + "sisteransi": "^1.0.5" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/prop-types": { + "version": "15.8.1", + "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", + "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "dev": true, + "license": "MIT", + "dependencies": { + "loose-envify": "^1.4.0", + "object-assign": "^4.1.1", + "react-is": "^16.13.1" + } + }, + "node_modules/prop-types/node_modules/react-is": { + "version": "16.13.1", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/psl": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.9.0.tgz", + "integrity": "sha512-E/ZsdU4HLs/68gYzgGTkMicWTLPdAftJLfJFlLUAAKZGkStNU72sZjT66SnMDVOfOWY/YAoiD7Jxa9iHvngcag==", + "dev": true, + "license": "MIT" + }, + "node_modules/pstree.remy": { + "version": "1.1.8", + "resolved": "https://registry.npmjs.org/pstree.remy/-/pstree.remy-1.1.8.tgz", + "integrity": "sha512-77DZwxQmxKnu3aR542U+X8FypNzbfJ+C5XQDk3uWjWxn6151aIMGthWYRXTqT1E5oJvg+ljaa2OJi+VfvCOQ8w==", + "dev": true, + "license": "MIT" + }, + "node_modules/pump": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", + "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", + "dev": true, + "license": "MIT", + "dependencies": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + } + }, + "node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/quansync": { + "version": "0.2.11", + "resolved": "https://registry.npmjs.org/quansync/-/quansync-0.2.11.tgz", + "integrity": "sha512-AifT7QEbW9Nri4tAwR5M/uzpBuqfZf+zwaEM/QkzEjj7NBuFD2rBuy0K3dE+8wltbezDV7JMA0WfnCPYRSYbXA==", + "dev": true, + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/antfu" + }, + { + "type": "individual", + "url": "https://github.com/sponsors/sxzz" + } + ], + "license": "MIT" + }, + "node_modules/querystringify": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/querystringify/-/querystringify-2.2.0.tgz", + "integrity": "sha512-FIqgj2EUvTa7R50u0rGsyTftzjYmv/a3hO345bZNrqabNqjtgiDMgmo4mkUjd+nzU5oF3dClKqFIPUKybUyqoQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/react-is": { + "version": "17.0.2", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", + "dev": true, + "license": "MIT" + }, + "node_modules/read-yaml-file": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/read-yaml-file/-/read-yaml-file-1.1.0.tgz", + "integrity": "sha512-VIMnQi/Z4HT2Fxuwg5KrY174U1VdUIASQVWXXyqtNRtxSr9IYkn1rsI6Tb6HsrHCmB7gVpNwX6JxPTHcH6IoTA==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.1.5", + "js-yaml": "^3.6.1", + "pify": "^4.0.1", + "strip-bom": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/readdirp": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", + "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "dev": true, + "license": "MIT", + "dependencies": { + "picomatch": "^2.2.1" + }, + "engines": { + "node": ">=8.10.0" + } + }, + "node_modules/reflect.getprototypeof": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.6.tgz", + "integrity": "sha512-fmfw4XgoDke3kdI6h4xcUz1dG8uaiv5q9gcEwLS4Pnth2kxT+GZ7YehS1JTMGBQmtV7Y4GFGbs2re2NqhdozUg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.1", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4", + "globalthis": "^1.0.3", + "which-builtin-type": "^1.1.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/regenerate": { + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", + "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==", + "dev": true, + "license": "MIT" + }, + "node_modules/regenerate-unicode-properties": { + "version": "10.1.1", + "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.1.1.tgz", + "integrity": "sha512-X007RyZLsCJVVrjgEFVpLUTZwyOZk3oiL75ZcuYjlIWd6rNJtOjkBwQc5AsRrpbKVkxN6sklw/k/9m2jJYOf8Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "regenerate": "^1.4.2" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/regenerator-runtime": { + "version": "0.14.1", + "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.14.1.tgz", + "integrity": "sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==", + "dev": true, + "license": "MIT" + }, + "node_modules/regenerator-transform": { + "version": "0.15.2", + "resolved": "https://registry.npmjs.org/regenerator-transform/-/regenerator-transform-0.15.2.tgz", + "integrity": "sha512-hfMp2BoF0qOk3uc5V20ALGDS2ddjQaLrdl7xrGXvAIow7qeWRM2VA2HuCHkUKk9slq3VwEwLNK3DFBqDfPGYtg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.8.4" + } + }, + "node_modules/regexp.prototype.flags": { + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz", + "integrity": "sha512-NcDiDkTLuPR+++OCKB0nWafEmhg/Da8aUPLPMQbK+bxKKCm1/S5he+AqYa4PlMCVBalb4/yxIRub6qkEx5yJbw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "set-function-name": "^2.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/regexpp": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz", + "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/regexpu-core": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-5.3.2.tgz", + "integrity": "sha512-RAM5FlZz+Lhmo7db9L298p2vHP5ZywrVXmVXpmAD9GuL5MPH6t9ROw1iA/wfHkQ76Qe7AaPF0nGuim96/IrQMQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/regjsgen": "^0.8.0", + "regenerate": "^1.4.2", + "regenerate-unicode-properties": "^10.1.0", + "regjsparser": "^0.9.1", + "unicode-match-property-ecmascript": "^2.0.0", + "unicode-match-property-value-ecmascript": "^2.1.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/regjsparser": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.9.1.tgz", + "integrity": "sha512-dQUtn90WanSNl+7mQKcXAgZxvUe7Z0SqXlgzv0za4LwiUhyzBC58yQO3liFoUgu8GiJVInAhJjkj1N0EtQ5nkQ==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "jsesc": "~0.5.0" + }, + "bin": { + "regjsparser": "bin/parser" + } + }, + "node_modules/regjsparser/node_modules/jsesc": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-0.5.0.tgz", + "integrity": "sha512-uZz5UnB7u4T9LvwmFqXii7pZSouaRPorGs5who1Ip7VO0wxanFvBL7GkM6dTHlgX+jhBApRetaWpnDabOeTcnA==", + "dev": true, + "bin": { + "jsesc": "bin/jsesc" + } + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/requires-port": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz", + "integrity": "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/resolve": { + "version": "1.22.8", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", + "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-core-module": "^2.13.0", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/resolve-cwd": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-3.0.0.tgz", + "integrity": "sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "resolve-from": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/resolve-from": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", + "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/resolve.exports": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-1.1.1.tgz", + "integrity": "sha512-/NtpHNDN7jWhAaQ9BvBUYZ6YTXsRBgfqWFWP7BZBaoMJO/I3G5OFzvTuWNlZC3aPjins1F+TNrLKsGbH4rfsRQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + } + }, + "node_modules/reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "license": "MIT", + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "license": "ISC", + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/rollup": { + "version": "2.79.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.79.1.tgz", + "integrity": "sha512-uKxbd0IhMZOhjAiD5oAFp7BqvkA4Dv47qpOCtaNvng4HBwdbWtdOh8f5nZNuk2rp51PMGk3bzfWu5oayNEuYnw==", + "dev": true, + "license": "MIT", + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=10.0.0" + }, + "optionalDependencies": { + "fsevents": "~2.3.2" + } + }, + "node_modules/rollup-plugin-node-externals": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/rollup-plugin-node-externals/-/rollup-plugin-node-externals-2.2.0.tgz", + "integrity": "sha512-WM7TtQ76GdsLceEGmZzQzn1afj8JgOQT5VLs1Y9RMqowM/8eK2mBj/Lv7hoE833U75QsUZIRirYUtFatu51RJA==", + "dev": true, + "license": "MIT", + "dependencies": { + "find-up": "^4.1.0" + }, + "engines": { + "node": ">=8.0.0" + }, + "peerDependencies": { + "builtin-modules": "^3.1.0" + } + }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, + "node_modules/safe-array-concat": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz", + "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4", + "has-symbols": "^1.0.3", + "isarray": "^2.0.5" + }, + "engines": { + "node": ">=0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/safe-regex-test": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz", + "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-regex": "^1.1.4" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "dev": true, + "license": "MIT" + }, + "node_modules/saxes": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/saxes/-/saxes-5.0.1.tgz", + "integrity": "sha512-5LBh1Tls8c9xgGjw3QrMwETmTMVk0oFgvrFSvWx62llR2hcEInrKNZ2GZCCuuy2lvWrdl5jhbpeqc5hRYKFOcw==", + "dev": true, + "license": "ISC", + "dependencies": { + "xmlchars": "^2.2.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/sentence-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/sentence-case/-/sentence-case-3.0.4.tgz", + "integrity": "sha512-8LS0JInaQMCRoQ7YUytAo/xUu5W2XnQxV2HI/6uM6U7CITS1RqPElr30V6uIqyMKM9lJGRVFy5/4CuzcixNYSg==", + "dev": true, + "license": "MIT", + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3", + "upper-case-first": "^2.0.2" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/set-function-name": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "functions-have-names": "^1.2.3", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/shallow-clone": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/shallow-clone/-/shallow-clone-3.0.1.tgz", + "integrity": "sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==", + "dev": true, + "license": "MIT", + "dependencies": { + "kind-of": "^6.0.2" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/side-channel": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", + "integrity": "sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4", + "object-inspect": "^1.13.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/signal-exit": { + "version": "3.0.7", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/simple-update-notifier": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/simple-update-notifier/-/simple-update-notifier-1.1.0.tgz", + "integrity": "sha512-VpsrsJSUcJEseSbMHkrsrAVSdvVS5I96Qo1QAQ4FxQ9wXFcB+pjj7FB7/us9+GcgfW4ziHtYMc1J0PLczb55mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "semver": "~7.0.0" + }, + "engines": { + "node": ">=8.10.0" + } + }, + "node_modules/simple-update-notifier/node_modules/semver": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.0.0.tgz", + "integrity": "sha512-+GB6zVA9LWh6zovYQLALHwv5rb2PHGlJi3lfiqIHxR0uuwCgefcOJc59v9fv1w8GbStwxuuqqAjI9NMAOOgq1A==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, + "node_modules/sisteransi": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", + "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", + "dev": true, + "license": "MIT" + }, + "node_modules/slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/snake-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", + "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==", + "dev": true, + "license": "MIT", + "dependencies": { + "dot-case": "^3.0.4", + "tslib": "^2.0.3" + } + }, + "node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.21", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", + "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "dev": true, + "license": "MIT", + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "node_modules/sourcemap-codec": { + "version": "1.4.8", + "resolved": "https://registry.npmjs.org/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz", + "integrity": "sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==", + "dev": true, + "license": "MIT" + }, + "node_modules/spawndamnit": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/spawndamnit/-/spawndamnit-3.0.1.tgz", + "integrity": "sha512-MmnduQUuHCoFckZoWnXsTg7JaiLBJrKFj9UI2MbRPGaJeVpsLcVBu6P/IGZovziM/YBsellCmsprgNA+w0CzVg==", + "dev": true, + "license": "SEE LICENSE IN LICENSE", + "dependencies": { + "cross-spawn": "^7.0.5", + "signal-exit": "^4.0.1" + } + }, + "node_modules/spawndamnit/node_modules/cross-spawn": { + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/spawndamnit/node_modules/signal-exit": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", + "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/stack-utils": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.6.tgz", + "integrity": "sha512-XlkWvfIm6RmsWtNJx+uqtKLS8eqFbxUg0ZzLXqY0caEy9l7hruX8IpiDnjsLavoBgqCCR71TqWO8MaXYheJ3RQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "escape-string-regexp": "^2.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/stack-utils/node_modules/escape-string-regexp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", + "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/string-length": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", + "integrity": "sha512-+l6rNN5fYHNhZZy41RXsYptCjA2Igmq4EG7kZAYFQI1E1VTXarr6ZPXBg6eq7Y6eK4FEhY6AJlyuFIb/v/S0VQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "char-regex": "^1.0.2", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/string-width/node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true, + "license": "MIT" + }, + "node_modules/string.prototype.matchall": { + "version": "4.0.11", + "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.11.tgz", + "integrity": "sha512-NUdh0aDavY2og7IbBPenWqR9exH+E26Sv8e0/eTe1tltDGZL+GtBkDAnnyBtmekfK6/Dq3MkcGtzXFEd1LQrtg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-symbols": "^1.0.3", + "internal-slot": "^1.0.7", + "regexp.prototype.flags": "^1.5.2", + "set-function-name": "^2.0.2", + "side-channel": "^1.0.6" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trim": { + "version": "1.2.9", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz", + "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.0", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimend": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz", + "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/string.prototype.trimstart": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", + "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-bom": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", + "integrity": "sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/strip-final-newline": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", + "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-hyperlinks": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/supports-hyperlinks/-/supports-hyperlinks-2.3.0.tgz", + "integrity": "sha512-RpsAZlpWcDwOPQA22aCH4J0t7L8JmAvsCxfOSEwm7cQs3LshN36QaTkwd70DnBOXDWGssw2eUoc8CaRWT0XunA==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0", + "supports-color": "^7.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/symbol-tree": { + "version": "3.2.4", + "resolved": "https://registry.npmjs.org/symbol-tree/-/symbol-tree-3.2.4.tgz", + "integrity": "sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==", + "dev": true, + "license": "MIT" + }, + "node_modules/term-size": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/term-size/-/term-size-2.2.1.tgz", + "integrity": "sha512-wK0Ri4fOGjv/XPy8SBHZChl8CM7uMc5VML7SqiQ0zG7+J5Vr+RMQDoHa2CNT6KHUnTGIXH34UDMkPzAUyapBZg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/terminal-link": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/terminal-link/-/terminal-link-2.1.1.tgz", + "integrity": "sha512-un0FmiRUQNr5PJqy9kP7c40F5BOfpGlYTrxonDChEZB7pzZxRNp/bt+ymiy9/npwXya9KH99nJ/GXFIiUkYGFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-escapes": "^4.2.1", + "supports-hyperlinks": "^2.0.0" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/test-exclude": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", + "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", + "dev": true, + "license": "ISC", + "dependencies": { + "@istanbuljs/schema": "^0.1.2", + "glob": "^7.1.4", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", + "dev": true, + "license": "MIT" + }, + "node_modules/throat": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/throat/-/throat-6.0.2.tgz", + "integrity": "sha512-WKexMoJj3vEuK0yFEapj8y64V0A6xcuPuK9Gt1d0R+dzCSJc0lHqQytAbSB4cDAK0dWh4T0E2ETkoLE2WZ41OQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/tmpl": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", + "integrity": "sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/to-fast-properties": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-2.0.0.tgz", + "integrity": "sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", + "dependencies": { + "is-number": "^7.0.0" + }, + "engines": { + "node": ">=8.0" + } + }, + "node_modules/touch": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/touch/-/touch-3.1.1.tgz", + "integrity": "sha512-r0eojU4bI8MnHr8c5bNo7lJDdI2qXlWWJk6a9EAFG7vbhTjElYhBVS3/miuE0uOuoLdb8Mc/rVfsmm6eo5o9GA==", + "dev": true, + "license": "ISC", + "bin": { + "nodetouch": "bin/nodetouch.js" + } + }, + "node_modules/tough-cookie": { + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.1.4.tgz", + "integrity": "sha512-Loo5UUvLD9ScZ6jh8beX1T6sO1w2/MpCRpEP7V280GKMVUQ0Jzar2U3UJPsrdbziLEMMhu3Ujnq//rhiFuIeag==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "psl": "^1.1.33", + "punycode": "^2.1.1", + "universalify": "^0.2.0", + "url-parse": "^1.5.3" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/tough-cookie/node_modules/universalify": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.2.0.tgz", + "integrity": "sha512-CJ1QgKmNg3CwvAv/kOFmtnEN05f0D/cn9QntgNOQlQF9dgvVTHj3t+8JPdjqawCHk7V/KA+fbUqzZ9XWhcqPUg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/tr46": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-2.1.0.tgz", + "integrity": "sha512-15Ih7phfcdP5YxqiB+iDtLoaTz4Nd35+IiAv0kQ5FNKHzXgdWqPoTIqEDDJmXceQt4JZk6lVPT8lnDlPpGDppw==", + "dev": true, + "license": "MIT", + "dependencies": { + "punycode": "^2.1.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ts-morph": { + "version": "25.0.1", + "resolved": "https://registry.npmjs.org/ts-morph/-/ts-morph-25.0.1.tgz", + "integrity": "sha512-QJEiTdnz1YjrB3JFhd626gX4rKHDLSjSVMvGGG4v7ONc3RBwa0Eei98G9AT9uNFDMtV54JyuXsFeC+OH0n6bXQ==", + "license": "MIT", + "dependencies": { + "@ts-morph/common": "~0.26.0", + "code-block-writer": "^13.0.3" + } + }, + "node_modules/tsconfig-paths": { + "version": "3.15.0", + "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.15.0.tgz", + "integrity": "sha512-2Ac2RgzDe/cn48GvOe3M+o82pEFewD3UPbyoUHHdKasHwJKjds4fLXWf/Ux5kATBKN20oaFGu+jbElp1pos0mg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/json5": "^0.0.29", + "json5": "^1.0.2", + "minimist": "^1.2.6", + "strip-bom": "^3.0.0" + } + }, + "node_modules/tsconfig-paths/node_modules/json5": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz", + "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==", + "dev": true, + "license": "MIT", + "dependencies": { + "minimist": "^1.2.0" + }, + "bin": { + "json5": "lib/cli.js" + } + }, + "node_modules/tslib": { + "version": "2.6.3", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.3.tgz", + "integrity": "sha512-xNvxJEOUiWPGhUuUdQgAJPKOOJfGnIyKySOc09XkKsgdUV/3E2zvwZYdejjmRgPCgcym1juLH3226yA7sEFJKQ==", + "dev": true, + "license": "0BSD" + }, + "node_modules/tsutils": { + "version": "3.21.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", + "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", + "dev": true, + "license": "MIT", + "dependencies": { + "tslib": "^1.8.1" + }, + "engines": { + "node": ">= 6" + }, + "peerDependencies": { + "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta" + } + }, + "node_modules/tsutils/node_modules/tslib": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "dev": true, + "license": "0BSD" + }, + "node_modules/type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "license": "MIT", + "dependencies": { + "prelude-ls": "^1.2.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/type-detect": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", + "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typed-array-buffer": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz", + "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/typed-array-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz", + "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-byte-offset": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz", + "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typed-array-length": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz", + "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13", + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/typedarray-to-buffer": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", + "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-typedarray": "^1.0.0" + } + }, + "node_modules/typescript": { + "version": "4.9.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", + "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, + "node_modules/unbox-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.2.tgz", + "integrity": "sha512-61pPlCD9h51VoreyJ0BReideM3MDKMKnh6+V9L08331ipq6Q8OFXZYiqP6n/tbHx4s5I9uRhcye6BrbkizkBDw==", + "dev": true, + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-bigints": "^1.0.2", + "has-symbols": "^1.0.3", + "which-boxed-primitive": "^1.0.2" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/undefsafe": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/undefsafe/-/undefsafe-2.0.5.tgz", + "integrity": "sha512-WxONCrssBM8TSPRqN5EmsjVrsv4A8X12J4ArBiiayv3DyyG3ZlIg6yysuuSYdZsVz3TKcTg2fd//Ujd4CHV1iA==", + "dev": true, + "license": "MIT" + }, + "node_modules/undici-types": { + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.18.2.tgz", + "integrity": "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w==", + "dev": true, + "license": "MIT" + }, + "node_modules/unicode-canonical-property-names-ecmascript": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz", + "integrity": "sha512-yY5PpDlfVIU5+y/BSCxAJRBIS1Zc2dDG3Ujq+sR0U+JjUevW2JhocOF+soROYDSaAezOzOKuyyixhD6mBknSmQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-ecmascript": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz", + "integrity": "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "unicode-canonical-property-names-ecmascript": "^2.0.0", + "unicode-property-aliases-ecmascript": "^2.0.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-match-property-value-ecmascript": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.1.0.tgz", + "integrity": "sha512-qxkjQt6qjg/mYscYMC0XKRn3Rh0wFPlfxB0xkt9CfyTvpX1Ra0+rAmdX2QyAobptSEvuy4RtpPRui6XkV+8wjA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/unicode-property-aliases-ecmascript": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.1.0.tgz", + "integrity": "sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" + } + }, + "node_modules/universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/update-browserslist-db": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz", + "integrity": "sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "escalade": "^3.1.2", + "picocolors": "^1.0.1" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/update-browserslist-db/node_modules/picocolors": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.1.tgz", + "integrity": "sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew==", + "dev": true, + "license": "ISC" + }, + "node_modules/upper-case": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/upper-case/-/upper-case-2.0.2.tgz", + "integrity": "sha512-KgdgDGJt2TpuwBUIjgG6lzw2GWFRCW9Qkfkiv0DxqHHLYJHmtmdUIKcZd8rHgFSjopVTlw6ggzCm1b8MFQwikg==", + "dev": true, + "license": "MIT", + "dependencies": { + "tslib": "^2.0.3" + } + }, + "node_modules/upper-case-first": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz", + "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==", + "dev": true, + "license": "MIT", + "dependencies": { + "tslib": "^2.0.3" + } + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/url-parse": { + "version": "1.5.10", + "resolved": "https://registry.npmjs.org/url-parse/-/url-parse-1.5.10.tgz", + "integrity": "sha512-WypcfiRhfeUP9vvF0j6rw0J3hrWrw6iZv3+22h6iRMJ/8z1Tj6XfLP4DsUix5MhMPnXpiHDoKyoZ/bdCkwBCiQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "querystringify": "^2.1.1", + "requires-port": "^1.0.0" + } + }, + "node_modules/v8-to-istanbul": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-8.1.1.tgz", + "integrity": "sha512-FGtKtv3xIpR6BYhvgH8MI/y78oT7d8Au3ww4QIxymrCtZEh5b8gCw2siywE+puhEmuWKDtmfrvF5UlB298ut3w==", + "dev": true, + "license": "ISC", + "dependencies": { + "@types/istanbul-lib-coverage": "^2.0.1", + "convert-source-map": "^1.6.0", + "source-map": "^0.7.3" + }, + "engines": { + "node": ">=10.12.0" + } + }, + "node_modules/v8-to-istanbul/node_modules/source-map": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", + "integrity": "sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">= 8" + } + }, + "node_modules/v8flags": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/v8flags/-/v8flags-3.2.0.tgz", + "integrity": "sha512-mH8etigqMfiGWdeXpaaqGfs6BndypxusHHcv2qSHyZkGEznCd/qAXCWWRzeowtL54147cktFOC4P5y+kl8d8Jg==", + "dev": true, + "license": "MIT", + "dependencies": { + "homedir-polyfill": "^1.0.1" + }, + "engines": { + "node": ">= 0.10" + } + }, + "node_modules/w3c-hr-time": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", + "integrity": "sha512-z8P5DvDNjKDoFIHK7q8r8lackT6l+jo/Ye3HOle7l9nICP9lf1Ci25fy9vHd0JOWewkIFzXIEig3TdKT7JQ5fQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "browser-process-hrtime": "^1.0.0" + } + }, + "node_modules/w3c-xmlserializer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/w3c-xmlserializer/-/w3c-xmlserializer-2.0.0.tgz", + "integrity": "sha512-4tzD0mF8iSiMiNs30BiLO3EpfGLZUT2MSX/G+o7ZywDzliWQ3OPtTZ0PTC3B3ca1UAf4cJMHB+2Bf56EriJuRA==", + "dev": true, + "license": "MIT", + "dependencies": { + "xml-name-validator": "^3.0.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/walker": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz", + "integrity": "sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "makeerror": "1.0.12" + } + }, + "node_modules/webidl-conversions": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-6.1.0.tgz", + "integrity": "sha512-qBIvFLGiBpLjfwmYAaHPXsn+ho5xZnGvyGvsarywGNc8VyQJUMHJ8OBKGGrPER0okBeMDaan4mNBlgBROxuI8w==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=10.4" + } + }, + "node_modules/whatwg-encoding": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-1.0.5.tgz", + "integrity": "sha512-b5lim54JOPN9HtzvK9HFXvBma/rnfFeqsic0hSpjtDbVxR3dJKLc+KB4V6GgiGOvl7CY/KNh8rxSo9DKQrnUEw==", + "dev": true, + "license": "MIT", + "dependencies": { + "iconv-lite": "0.4.24" + } + }, + "node_modules/whatwg-encoding/node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "dev": true, + "license": "MIT", + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/whatwg-mimetype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-2.3.0.tgz", + "integrity": "sha512-M4yMwr6mAnQz76TbJm914+gPpB/nCwvZbJU28cUD6dR004SAxDLOOSUaB1JDRqLtaOV/vi0IC5lEAGFgrjGv/g==", + "dev": true, + "license": "MIT" + }, + "node_modules/whatwg-url": { + "version": "8.7.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-8.7.0.tgz", + "integrity": "sha512-gAojqb/m9Q8a5IV96E3fHJM70AzCkgt4uXYX2O7EmuyOnLrViCQlsEBmF9UQIu3/aeAIp2U17rtbpZWNntQqdg==", + "dev": true, + "license": "MIT", + "dependencies": { + "lodash": "^4.7.0", + "tr46": "^2.1.0", + "webidl-conversions": "^6.1.0" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/which-boxed-primitive": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz", + "integrity": "sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-bigint": "^1.0.1", + "is-boolean-object": "^1.1.0", + "is-number-object": "^1.0.4", + "is-string": "^1.0.5", + "is-symbol": "^1.0.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-builtin-type": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/which-builtin-type/-/which-builtin-type-1.1.3.tgz", + "integrity": "sha512-YmjsSMDBYsM1CaFiayOVT06+KJeXf0o5M/CAd4o1lTadFAtacTUM49zoYxr/oroopFDfhvN6iEcBxUyc3gvKmw==", + "dev": true, + "license": "MIT", + "dependencies": { + "function.prototype.name": "^1.1.5", + "has-tostringtag": "^1.0.0", + "is-async-function": "^2.0.0", + "is-date-object": "^1.0.5", + "is-finalizationregistry": "^1.0.2", + "is-generator-function": "^1.0.10", + "is-regex": "^1.1.4", + "is-weakref": "^1.0.2", + "isarray": "^2.0.5", + "which-boxed-primitive": "^1.0.2", + "which-collection": "^1.0.1", + "which-typed-array": "^1.1.9" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-collection": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", + "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-map": "^2.0.3", + "is-set": "^2.0.3", + "is-weakmap": "^2.0.2", + "is-weakset": "^2.0.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/which-typed-array": { + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", + "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", + "dev": true, + "license": "MIT", + "dependencies": { + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "for-each": "^0.3.3", + "gopd": "^1.0.1", + "has-tostringtag": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/word-wrap": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", + "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/write-file-atomic": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", + "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", + "dev": true, + "license": "ISC", + "dependencies": { + "imurmurhash": "^0.1.4", + "is-typedarray": "^1.0.0", + "signal-exit": "^3.0.2", + "typedarray-to-buffer": "^3.1.5" + } + }, + "node_modules/ws": { + "version": "7.5.9", + "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.9.tgz", + "integrity": "sha512-F+P9Jil7UiSKSkppIiD94dN07AwvFixvLIj1Og1Rl9GGMuNipJnV9JzjD6XuqmAeiswGvUmNLjr5cFuXwNS77Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8.3.0" + }, + "peerDependencies": { + "bufferutil": "^4.0.1", + "utf-8-validate": "^5.0.2" + }, + "peerDependenciesMeta": { + "bufferutil": { + "optional": true + }, + "utf-8-validate": { + "optional": true + } + } + }, + "node_modules/xml-name-validator": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-3.0.0.tgz", + "integrity": "sha512-A5CUptxDsvxKJEU3yO6DuWBSJz/qizqzJKOMIfUJHETbBw/sFaDxgd6fxm1ewUaM0jZ444Fc5vC5ROYurg/4Pw==", + "dev": true, + "license": "Apache-2.0" + }, + "node_modules/xmlchars": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz", + "integrity": "sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw==", + "dev": true, + "license": "MIT" + }, + "node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, + "node_modules/yallist": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "dev": true, + "license": "ISC" + }, + "node_modules/yargs": { + "version": "17.7.2", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", + "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "cliui": "^8.0.1", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.3", + "y18n": "^5.0.5", + "yargs-parser": "^21.1.1" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/yargs-parser": { + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=12" + } + }, + "node_modules/yocto-queue": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", + "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "packages/ui-extensions": { + "name": "@shopify/ui-extensions", + "version": "2026.4.0-rc.1", + "license": "MIT", + "dependencies": { + "ts-morph": "^25.0.1" + }, + "devDependencies": { + "@faker-js/faker": "^8.4.1", + "@preact/signals": "^2.3.x", + "@quilted/react-testing": "^0.6.11", + "@remote-ui/async-subscription": "^2.1.16", + "@shopify/generate-docs": "1.0.0", + "preact": "^10.10.x", + "typescript": "^4.9.0" + }, + "peerDependencies": { + "@preact/signals": "*", + "preact": "*" + }, + "peerDependenciesMeta": { + "@preact/signals": { + "optional": true + }, + "preact": { + "optional": true + } + } + } + } +} diff --git a/package.json b/package.json index cc6523efcf..48940999b8 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,6 @@ "deploy:unstable": "changeset version --snapshot unstable && changeset publish --tag unstable --no-git-tag", "predeploy:internal": "yarn build", "deploy:internal": "changeset version --snapshot internal && changeset publish --tag internal --no-git-tag", - "gen-docs:admin": "node ./packages/ui-extensions/docs/surfaces/admin/create-doc-files.js", "lint": "loom lint", "nuke": "rm -rf node_modules && yarn cache clean && rm -rf .loom && git clean -xdf ./packages; rm -rf ./build", "restore-consumer": "./scripts/restore-consumer.sh", @@ -31,7 +30,10 @@ "run:ts": "babel-node --extensions .ts,.tsx,.mjs,.js,.json", "run:ts:watch": "nodemon --ext .ts,.tsx,.mjs,.json,.graphql node_modules/.bin/babel-node --extensions .ts,.tsx,.mjs,.js,.json", "type-check": "loom type-check", - "changeset:exit-pre-mode": "test -f .changeset/pre.json && jq -e '.mode == \"pre\"' .changeset/pre.json > /dev/null && yarn changeset pre exit || true" + "changeset:exit-pre-mode": "test -f .changeset/pre.json && jq -e '.mode == \"pre\"' .changeset/pre.json > /dev/null && yarn changeset pre exit || true", + "test": "loom test --no-watch", + "test:watch": "loom test", + "test:example-suites": "for dir in examples/testing/*/; do (cd \"$dir\" && npm install && npm run typecheck && npm test) || exit 1; done" }, "devDependencies": { "@babel/node": "^7.8.7", diff --git a/packages/ui-extensions-tester/AGENTS.md b/packages/ui-extensions-tester/AGENTS.md new file mode 100644 index 0000000000..9e41d86ee1 --- /dev/null +++ b/packages/ui-extensions-tester/AGENTS.md @@ -0,0 +1,16 @@ +# AGENTS.md + +Implement every feature with TDD. See `./tests`. + +After every change, run the relevant test suites in `examples/testing/*` to verify that example tests still pass. + +Keep documentation up to date in both the package README (`packages/ui-extensions-tester/README.md`) and each surface-specific README: + +- `packages/ui-extensions-tester/src/admin/README.md` +- `packages/ui-extensions-tester/src/checkout/README.md` +- `packages/ui-extensions-tester/src/customer-account/README.md` +- `packages/ui-extensions-tester/src/point-of-sale/README.md` + +Any change to exports, function signatures, or behavior must be reflected in the relevant docs. + +Code blocks in README files are formatted at print width 50 via the root `.prettierrc` override. Run `npx prettier --write` on any changed README. diff --git a/packages/ui-extensions-tester/CHANGELOG.md b/packages/ui-extensions-tester/CHANGELOG.md new file mode 100644 index 0000000000..cb66377357 --- /dev/null +++ b/packages/ui-extensions-tester/CHANGELOG.md @@ -0,0 +1,99 @@ +# @shopify/ui-extensions-tester + +## 2026.7.0-rc.7 + +### Patch Changes + +- Updated dependencies [[`f972657`](https://github.com/Shopify/ui-extensions/commit/f972657cc48c1b6a674f55ccb586e56d5be35e80)]: + - @shopify/ui-extensions@2026.7.0-rc.7 + +## 2026.7.0-rc.6 + +### Minor Changes + +- [#4489](https://github.com/Shopify/ui-extensions/pull/4489) [`8f27436`](https://github.com/Shopify/ui-extensions/commit/8f274366bdae412475113320e77bf1b6042ee735) Thanks [@akhayoon](https://github.com/akhayoon)! - Add `session.staffMember` for POS UI extensions so extensions can read and subscribe to the currently pinned staff member. + +### Patch Changes + +- [#4491](https://github.com/Shopify/ui-extensions/pull/4491) [`2399687`](https://github.com/Shopify/ui-extensions/commit/23996878ba8d12aa290a14b0f267d28ead3781f7) Thanks [@jasonblickhan](https://github.com/jasonblickhan)! - Add `admin.abandoned-checkout-index.action.render` and `admin.abandoned-checkout-index.action.should-render` extension targets for the abandoned checkout index page. This mirrors the action targets already available on other resource index pages (orders, customers, products, draft orders, etc.) and unblocks `admin.abandoned-checkout-index.action.link` admin link extensions. + +- [#4468](https://github.com/Shopify/ui-extensions/pull/4468) [`84c8acd`](https://github.com/Shopify/ui-extensions/commit/84c8acd397c77dd9f34f75b93f0b3516e66f08a5) Thanks [@JoviDeCroock](https://github.com/JoviDeCroock)! - Narrow `AppHomeApi.intents` to a new `AppHomeIntents` shape that exposes a signal-like `request` so the runtime can stream link intents into a long-lived `admin.app.home.render` extension. `WithGeneratedIntents` continues to narrow `request.value` to the CLI-generated variants. + +- [#4468](https://github.com/Shopify/ui-extensions/pull/4468) [`84c8acd`](https://github.com/Shopify/ui-extensions/commit/84c8acd397c77dd9f34f75b93f0b3516e66f08a5) Thanks [@JoviDeCroock](https://github.com/JoviDeCroock)! - Expose the `Tools` API on `AppHomeApi` so `admin.app.home.render` extensions can call `shopify.tools.register(...)` even before the CLI generates typed overloads. Adds a matching mock to `@shopify/ui-extensions-tester`. + +- Updated dependencies [[`2399687`](https://github.com/Shopify/ui-extensions/commit/23996878ba8d12aa290a14b0f267d28ead3781f7), [`84c8acd`](https://github.com/Shopify/ui-extensions/commit/84c8acd397c77dd9f34f75b93f0b3516e66f08a5), [`84c8acd`](https://github.com/Shopify/ui-extensions/commit/84c8acd397c77dd9f34f75b93f0b3516e66f08a5), [`338a696`](https://github.com/Shopify/ui-extensions/commit/338a696739672a058813810771d737d84bee5559), [`d607e02`](https://github.com/Shopify/ui-extensions/commit/d607e026f6652eafa19a1a3c8352a431b9ecc47b), [`fe62c86`](https://github.com/Shopify/ui-extensions/commit/fe62c86217956ebf72c6b8e63b81d226f3a97da4), [`cc5f4b3`](https://github.com/Shopify/ui-extensions/commit/cc5f4b3d624bcf12bb0ce4d8dc7d71ee0494ad1e), [`8f27436`](https://github.com/Shopify/ui-extensions/commit/8f274366bdae412475113320e77bf1b6042ee735)]: + - @shopify/ui-extensions@2026.7.0-rc.6 + +## 2026.7.0-rc.5 + +### Patch Changes + +- Updated dependencies [[`be8c9e2`](https://github.com/Shopify/ui-extensions/commit/be8c9e206525a41f2544810a328d901e2cdcbb95)]: + - @shopify/ui-extensions@2026.7.0-rc.5 + +## 2026.7.0-rc.4 + +### Patch Changes + +- Updated dependencies [[`060e669`](https://github.com/Shopify/ui-extensions/commit/060e669fb5ff34b30f7e8a8fb1b2696e038a4938)]: + - @shopify/ui-extensions@2026.7.0-rc.4 + +## 2026.7.0-rc.3 + +### Patch Changes + +- [#4349](https://github.com/Shopify/ui-extensions/pull/4349) [`f2b2b10`](https://github.com/Shopify/ui-extensions/commit/f2b2b10e99c4672c38b83cc048c2de93abbb7444) Thanks [@vividviolet](https://github.com/vividviolet)! - Publish package with admin.app.home.render target + +- Updated dependencies [[`234aead`](https://github.com/Shopify/ui-extensions/commit/234aead78ce9ac90077a67fbc219897832aafd74), [`ea1b6f4`](https://github.com/Shopify/ui-extensions/commit/ea1b6f4c725cc61efa03f4d859ba82ea3d50c2d1), [`f2b2b10`](https://github.com/Shopify/ui-extensions/commit/f2b2b10e99c4672c38b83cc048c2de93abbb7444)]: + - @shopify/ui-extensions@2026.7.0-rc.3 + +## 2026.7.0-rc.2 + +### Patch Changes + +- Updated dependencies [[`bf2184a`](https://github.com/Shopify/ui-extensions/commit/bf2184a8d55a756533c46a60bf022653b7bfc423)]: + - @shopify/ui-extensions@2026.7.0-rc.2 + +## 2026.7.0-rc.1 + +### Major Changes + +- [`eb74ecc`](https://github.com/Shopify/ui-extensions/commit/eb74eccd35fdf7b6a780320c6eb3830cee7ea24f) Thanks [@lrsterrett](https://github.com/lrsterrett)! - 2026-07-rc release + +### Patch Changes + +- Updated dependencies [[`eb74ecc`](https://github.com/Shopify/ui-extensions/commit/eb74eccd35fdf7b6a780320c6eb3830cee7ea24f)]: + - @shopify/ui-extensions@2026.7.0-rc.1 + +## 2026.4.0 + +### Minor Changes + +- [#4114](https://github.com/Shopify/ui-extensions/pull/4114) [`9556ec6`](https://github.com/Shopify/ui-extensions/commit/9556ec6da13bc810bb1967f61afda2e9b4613884) Thanks [@kumar303](https://github.com/kumar303)! - Add `setUpExtension()` for Explicit Resource Management (`using` keyword) support. + +### Patch Changes + +- [#4148](https://github.com/Shopify/ui-extensions/pull/4148) [`3b9614b`](https://github.com/Shopify/ui-extensions/commit/3b9614b572b7eb84715dc7656364ad38c9a4ead2) Thanks [@lrsterrett](https://github.com/lrsterrett)! - Remove types for `ui` from checkout ui extension api as `ui` wasn't supported since 2025.10.0 For reference, closing a modal can be done declaritively on the modal polaris component, instead of the deprecated `ui.overlay.close` + +- Updated dependencies [[`a5c2bbf`](https://github.com/Shopify/ui-extensions/commit/a5c2bbf71decdf210d46ad4d6dc814faa6c0912f), [`db7cec2`](https://github.com/Shopify/ui-extensions/commit/db7cec21f1fd428115d4540158f235a714b585de), [`3b9614b`](https://github.com/Shopify/ui-extensions/commit/3b9614b572b7eb84715dc7656364ad38c9a4ead2), [`6c3ac55`](https://github.com/Shopify/ui-extensions/commit/6c3ac5559c50553314cdea0993e39fcf853cc3d0), [`acd9002`](https://github.com/Shopify/ui-extensions/commit/acd9002d9d8768732bbbf19eccae268ffde9a07b), [`12df6f9`](https://github.com/Shopify/ui-extensions/commit/12df6f92b68bca036132b3c54a69e28e15330a65), [`21566b3`](https://github.com/Shopify/ui-extensions/commit/21566b391651653c8e3d626811d5b787b26f9fe3), [`b60a9a1`](https://github.com/Shopify/ui-extensions/commit/b60a9a18a1da763fe8c9c01ce4911c4754926cce), [`7408712`](https://github.com/Shopify/ui-extensions/commit/7408712b9d85eb4464560bf2078aa2a81a1ff3af), [`d1c35f2`](https://github.com/Shopify/ui-extensions/commit/d1c35f25cc86dfa1dcf8934a7b7cf5fa9856846a), [`77d447c`](https://github.com/Shopify/ui-extensions/commit/77d447c7f34151d3af49f6b7c4bc987558eec292)]: + - @shopify/ui-extensions@2026.4.0 + +## 2026.4.0-rc.3 + +### Minor Changes + +- [#4114](https://github.com/Shopify/ui-extensions/pull/4114) [`9556ec6`](https://github.com/Shopify/ui-extensions/commit/9556ec6da13bc810bb1967f61afda2e9b4613884) Thanks [@kumar303](https://github.com/kumar303)! - Add `setUpExtension()` for Explicit Resource Management (`using` keyword) support. + +### Patch Changes + +- [#4148](https://github.com/Shopify/ui-extensions/pull/4148) [`3b9614b`](https://github.com/Shopify/ui-extensions/commit/3b9614b572b7eb84715dc7656364ad38c9a4ead2) Thanks [@lrsterrett](https://github.com/lrsterrett)! - Remove types for `ui` from checkout ui extension api as `ui` wasn't supported since 2025.10.0 For reference, closing a modal can be done declaritively on the modal polaris component, instead of the deprecated `ui.overlay.close` + +- Updated dependencies [[`3b9614b`](https://github.com/Shopify/ui-extensions/commit/3b9614b572b7eb84715dc7656364ad38c9a4ead2), [`7408712`](https://github.com/Shopify/ui-extensions/commit/7408712b9d85eb4464560bf2078aa2a81a1ff3af)]: + - @shopify/ui-extensions@2026.4.0-rc.3 + +## 2026.4.0-rc.2 + +### Patch Changes + +- Updated dependencies [[`db7cec2`](https://github.com/Shopify/ui-extensions/commit/db7cec21f1fd428115d4540158f235a714b585de), [`6c3ac55`](https://github.com/Shopify/ui-extensions/commit/6c3ac5559c50553314cdea0993e39fcf853cc3d0), [`12df6f9`](https://github.com/Shopify/ui-extensions/commit/12df6f92b68bca036132b3c54a69e28e15330a65), [`21566b3`](https://github.com/Shopify/ui-extensions/commit/21566b391651653c8e3d626811d5b787b26f9fe3), [`b60a9a1`](https://github.com/Shopify/ui-extensions/commit/b60a9a18a1da763fe8c9c01ce4911c4754926cce)]: + - @shopify/ui-extensions@2026.4.0-rc.2 diff --git a/packages/ui-extensions-tester/README.md b/packages/ui-extensions-tester/README.md new file mode 100644 index 0000000000..f24ae79116 --- /dev/null +++ b/packages/ui-extensions-tester/README.md @@ -0,0 +1,465 @@ +# 🧪 @shopify/ui-extensions-tester + +Write unit tests for [Shopify UI extensions](../ui-extensions) to ensure correctness and prevent regressions. + +This testing library provides strongly typed mocks of the extension API--like the `shopify` global--so you can verify the correctness of your extension without needing a real Shopify host. + +## 📋 Requirements + +- **API version `2025-10` or later** in your `shopify.extension.toml` +- **Node.js v20.20.0** or later +- **a mock DOM** such as [`environment: 'jsdom'`](https://vitest.dev/config/environment.html) in [`vitest`](https://vitest.dev/) +- **Test isolation** — extensions rely on the `shopify` global, so each test file must run in its own environment. We recommend [`vitest`](https://vitest.dev/) in [isolate mode](https://vitest.dev/config/isolate.html#isolate) (enabled by default). + +## 📋 Recommendations + +- **TypeScript** — we recommend TypeScript to enforce API compliance against mock objects +- **Node.js ≥ 22.0.0** and **TypeScript ≥ 5.2** — to use ([Explicit Resource Management](https://github.com/tc39/proposal-explicit-resource-management)) +- **@testing-library/preact** — if your extension uses [Preact](https://preactjs.com/), we recommend installing [`@testing-library/preact`](https://preactjs.com/guide/v10/preact-testing-library/) for its `fireEvent` and `waitFor` helpers + +## 📦 Installation + +Install the tester as a dev dependency alongside your preferred test runner: + +```bash +npm install --save-dev @shopify/ui-extensions-tester vitest +``` + +If your extension renders with Preact, also install `@testing-library/preact`: + +```bash +npm install --save-dev @testing-library/preact +``` + +## 🏗️ Adding to an existing extension + +If your extension was seeded from an older template using shopify app generate extension, follow these steps. + +
+Expand for details + +The template gives you a project structure like this: + +``` +my-app/ +├── extensions/ +│ └── my-extension/ +│ ├── src/ +│ │ └── Checkout.jsx +│ ├── package.json +│ ├── shopify.d.ts +│ ├── shopify.extension.toml +│ └── tsconfig.json +├── package.json +└── shopify.app.toml +``` + +You need to add a few things: + +### 1. Add dependencies to the root `package.json` + +Your extension's own `package.json` (inside `extensions/my-extension/`) already lists `@shopify/ui-extensions` for Shopify CLI. However, tests and typechecking run from the **root** project directory, so you also need `@shopify/ui-extensions` in the root `package.json` — otherwise TypeScript and vitest won't be able to resolve it. + +```jsonc +{ + "scripts": { + // ...existing scripts + "test": "vitest run", + "typecheck": "tsc --noEmit --project extensions/my-extension/tsconfig.json" + }, + "dependencies": { + "@shopify/ui-extensions": "latest" + }, + "devDependencies": { + "@shopify/ui-extensions-tester": "latest", + "@testing-library/preact": "^3.2.0", + "typescript": "^5.2.0", + "vitest": "^3.0.0" + } +} +``` + +### 2. Create `vitest.config.ts` at the project root + +```ts +import {defineConfig} from 'vitest/config'; + +export default defineConfig({ + esbuild: { + jsx: 'automatic', + jsxImportSource: 'preact', + }, + test: { + environment: 'jsdom', + }, +}); +``` + +### 3. Update the extension's `tsconfig.json` + +Add the `tests` directory to the `include` array so your test files are typechecked: + +```jsonc +{ + "compilerOptions": { + "jsx": "react-jsx", + "jsxImportSource": "preact", + "target": "ES2020", + "strict": true, + "checkJs": true, + "allowJs": true, + "moduleResolution": "node", + "esModuleInterop": true, + "skipLibCheck": true + }, + "include": [ + "./src", + "./tests", + "./shopify.d.ts" + ] +} +``` + +### 4. Create a `tests/` directory inside your extension + +``` +extensions/ +└── my-extension/ + ├── src/ + │ └── Checkout.jsx + └── tests/ + └── Checkout.test.ts ← your tests go here +``` + +### 5. Add a triple-slash reference in each test file + +Add a [triple-slash directive](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html) for your target so TypeScript knows about Shopify element types (`s-button`, `s-text`, etc.): + +```ts +/// +``` + +The path must match the target you pass to `getExtension()`. + +
+ +## 🏊‍♀️ Getting started + +Every test file follows the same pattern: +create an extension harness, set it up before +each test, and tear it down after. + +### Quick start with `using` (Node ≥ 22.0.0) + +If your runtime supports +[Explicit Resource Management](https://github.com/tc39/proposal-explicit-resource-management), +use `setUpExtension` for zero-boilerplate +setup and automatic teardown: + +```ts +import {setUpExtension} from '@shopify/ui-extensions-tester'; + +test('rendering the extension', async () => { + using extension = setUpExtension( + 'purchase.checkout.block.render', + ); + await extension.render(); + // tearDown() is called automatically at the end of the block +}); +``` + +### Classic setup + +Alternatively, create the harness once and +manage the lifecycle with `beforeEach` / +`afterEach`: + +```ts +import {getExtension} from '@shopify/ui-extensions-tester'; +import {beforeEach, afterEach} from 'vitest'; + +const extension = getExtension( + 'purchase.checkout.block.render', +); + +beforeEach(() => { + extension.setUp(); +}); + +afterEach(() => { + extension.tearDown(); +}); +``` + +`setUp()` creates a complete mock `shopify` global compliant with the target. `tearDown()` clears the DOM and removes the global, among other surface-specific things. + +### 🔍 Rendering and querying elements + +Call `extension.render()` to import and execute your extension's callback, then query the DOM with standard DOM APIs like [`document.body.querySelector()`](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector) and [`document.body.querySelectorAll()`](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll): + +```ts +test('it handles an empty cart', async () => { + await extension.render(); + + const text = + document.body.querySelector('s-text')!; + expect(text.textContent).toEqual( + 'No items in cart', + ); +}); +``` + +### 🎨 Mocking shopify API values + +The test setup will create a `shopify` global with sensible defaults for the target. You can mutate global property values on `extension.shopify` before rendering. + +```ts +test('it handles an empty order', async () => { + extension.shopify.order.value = undefined; + + await extension.render(); + + const text = + document.body.querySelector('s-text')!; + expect(text.textContent).toEqual( + 'Order not found', + ); +}); +``` + +### 🖱️ Triggering events + +To simulate how a user would interact with your UI extension, you can call [`dispatchEvent()`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent) or use `fireEvent` from `@testing-library/preact`. When an event triggers an async state change (like a Preact re-render), wrap follow-up assertions in `await waitFor()` to wait for the DOM to settle: + +```ts +import { + fireEvent, + waitFor, +} from '@testing-library/preact'; + +test('it handles date field changes', async () => { + await extension.render(); + + const dateField = document.body.querySelector( + 's-date-field', + )!; + dateField.value = '1990-05-20'; + fireEvent.change(dateField); + + const button = + document.body.querySelector('s-button')!; + fireEvent.click(button); + + await waitFor(() => { + const banner = + document.body.querySelector('s-banner')!; + expect(banner.textContent).toEqual('Saved'); + }); +}); +``` + +### 🔒 Safely mocking mutation functions + +When mocking without strict typing, like with [`vitest` mocks](https://vitest.dev/api/vi.html#mocking-functions-and-objects), you can use a surface-specific `createResult()` helper to return type-safe values: + +```ts +import {createResult} from '@shopify/ui-extensions-tester/checkout'; + +const applyMetafieldChange = vi + .fn() + .mockResolvedValue( + createResult('applyMetafieldChange', { + type: 'error', + message: + 'Could not apply metafield changes', + }), + ); +extension.shopify.applyMetafieldChange = + applyMetafieldChange; +``` + +The first argument is the mutation API name. The second is an optional result override — omit it to get sensible defaults (like `{type: 'success'}`). + +### ⚡ Testing extension code that relies on signals + +Extensions typically subscribe to signal-like objects such as [`shopify.lines.value`](https://shopify.dev/docs/api/checkout-ui-extensions/latest/apis/cart-lines#standardapi-propertydetail-lines). +The mock Shopify API **does not implement working signals** so you'll need to test each state change separately. + +For example, let's say your extension has a button that updates the quantity of an item in the cart. Test the button first: + +```ts +import {createCartLine} from '@shopify/ui-extensions-tester/checkout'; + +test('increments cart line quantity on click', async () => { + const line = createCartLine(); + extension.shopify.lines.value = [line]; + const applyCartLinesChange = vi.spyOn( + extension.shopify, + 'applyCartLinesChange', + ); + + await extension.render(); + + const button = + document.body.querySelector('s-button')!; + fireEvent.click(button); + + // Make sure clicking the button updates the quantity: + await waitFor(() => { + expect( + applyCartLinesChange, + ).toHaveBeenCalledWith({ + type: 'updateCartLine', + id: line.id, + quantity: line.quantity + 1, + }); + }); +}); +``` + +Next, simulate the state change for updated quantities that would have happened on the checkout host: + +```ts +test('it renders the cart line quantity', async () => { + extension.shopify.lines.value = [ + createCartLine({quantity: 2}), + ]; + + await extension.render(); + + const text = + document.body.querySelector('s-text')!; + expect(text.textContent).toContain('2'); +}); +``` + +### 🌐 Working with translations + +The default `shopify.i18n.translate()` mock returns key names as-is to make assertions easier. + +For example, if you render `shopify.i18n.translate('headings.orderNotFound')` in extension code, you can test by looking for the rendered key name: + +```ts +test('it renders a banner when the order does not exist', async () => { + extension.shopify.order.value = undefined; + + await extension.render(); + + const banner = + document.body.querySelector('s-banner')!; + // Check for the translation key, not the actual translation: + expect(banner.getAttribute('heading')).toEqual( + 'headings.orderNotFound', + ); +}); +``` + +## ☯️ Surface-specific guides + +Each surface exports some helpers: + +- ⚙️ [Admin](./src/admin/README.md) +- 🛒 [Checkout](./src/checkout/README.md) +- 🛂 [Customer Account](./src/customer-account/README.md) +- 🛍️ [Point of Sale](./src/point-of-sale/README.md) + +## 📖 API reference + +Exports from `@shopify/ui-extensions-tester`: + +### `setUpExtension(target, options?)` + +Sets up an extension for testing and returns a +disposable object that supports automatic +teardown with the `using` keyword: + +```ts +test('example', async () => { + using extension = setUpExtension( + 'purchase.checkout.block.render', + ); + await extension.render(); + // tearDown() called automatically +}); +``` + +It reads `shopify.extension.toml`, finds the module for the given target, and provides helpers to mock the environment and render the extension. It locates `shopify.extension.toml` by walking up from the calling test file's directory, and falls back to searching `extensions/` under the current working directory. Results are cached: calling `getExtension` twice with the same target and the same resolved TOML returns the same instance. + +| Option | Type | Default | Description | +| ----------------- | -------- | ----------------------------- | ---------------------------------------------------------- | +| `configSearchDir` | `string` | calling test file's directory | Directory to start searching for `shopify.extension.toml`. | + +By default, it walks up from the test file's directory to find `shopify.extension.toml`. + +**Returns** an `Extension` object with the following members: + +#### `extension.render()` + +Imports and executes the extension module's default export, rendering the extension into `document.body`. Returns a `Promise`. + +#### `extension.shopify` + +A mock `shopify` global, typed correctly for the target under test. You can mutate any property. + +When testing `admin.app.home.render`, the mock `shopify` object also includes `toast`, `app`, `loading()`, `tools`, and `intents.request`. + +When testing `admin.app.intent.render`, the mock `shopify.intents` object also includes `response.ok()`, `response.error()`, and `response.closed()`. + +#### `extension.fetch` + +A mock `fetch()` function installed as `globalThis.fetch` during `setUp()` and removed during `tearDown()`. + +Override it with a mock to control responses: + +```ts +extension.fetch = vi + .fn() + .mockResolvedValue( + new Response(JSON.stringify({ok: true})), + ); +``` + +Assigning to `extension.fetch` also updates `globalThis.fetch`, so extension code that calls `fetch()` directly will use the mock. + +#### `extension.navigation` + +A mock [`Navigation`](https://developer.mozilla.org/en-US/docs/Web/API/Navigation) object installed as `globalThis.navigation` during `setUp()` and removed during `tearDown()`. Typed using the `Navigation` interface from `@shopify/ui-extensions/customer-account`. + +Override its properties with mocks to control navigation behaviour: + +```ts +import {createNavigationHistoryEntry} from '@shopify/ui-extensions-tester'; + +extension.navigation.navigate = vi.fn(); +extension.navigation.currentEntry = + createNavigationHistoryEntry({ + url: '/cart', + state: {items: 3}, + }); +``` + +Assigning to `extension.navigation` also updates `globalThis.navigation`, so extension code that calls `navigation.navigate()` directly will use the mock. + +### `getExtension(target, options?)` + +> ⚠️ Prefer [`setUpExtension`](#setupextensiontarget-options) on Node ≥ 22.0.0. Use `getExtension` only if your runtime does not support [Explicit Resource Management](https://github.com/tc39/proposal-explicit-resource-management). + +Accepts the same arguments as `setUpExtension`. You must call `extension.setUp()` and `extension.tearDown()` explicitly. + +**Returns** an `Extension` object with the following additional members: + +#### `extension.setUp()` + +Sets up an extension environment for testing. Creates a mock `shopify` global with some defaults. + +#### `extension.tearDown()` + +Tears down the extension environment. Resets the `shopify` global and clears `document.body`. + +### `createNavigationHistoryEntry(options?)` + +Creates a [`NavigationHistoryEntry`](https://developer.mozilla.org/en-US/docs/Web/API/NavigationHistoryEntry) for mocking `navigation.currentEntry` or other navigation values. + +- `url` — URL of the history entry (default `''`) +- `key` — key of the history entry (default `''`) +- `state` — developer-defined state retrieved via `getState()` (default `undefined`). Each `getState()` call returns a structured clone, matching real browser behaviour. diff --git a/packages/ui-extensions-tester/loom.config.ts b/packages/ui-extensions-tester/loom.config.ts new file mode 100644 index 0000000000..b1081b8b17 --- /dev/null +++ b/packages/ui-extensions-tester/loom.config.ts @@ -0,0 +1,76 @@ +import {createPackage} from '@shopify/loom'; +import {copyFileSync, readFileSync, writeFileSync} from 'fs'; +import {resolve} from 'path'; + +import {rollupPlugins} from '@shopify/loom-plugin-build-library'; +import replace from '@rollup/plugin-replace'; +import {defaultProjectPlugin} from '../../config/loom'; + +const packageJSON = JSON.parse( + readFileSync(resolve(__dirname, './package.json')).toString(), +); + +export default createPackage((pkg) => { + pkg.entry({root: './src/index.ts'}); + pkg.entry({name: 'admin', root: './src/admin/index.ts'}); + pkg.entry({name: 'checkout', root: './src/checkout/index.ts'}); + pkg.entry({name: 'point-of-sale', root: './src/point-of-sale/index.ts'}); + pkg.entry({ + name: 'customer-account', + root: './src/customer-account/index.ts', + }); + pkg.use( + defaultProjectPlugin(), + rollupPlugins([ + replace({ + values: { + __TESTER_PACKAGE_VERSION__: JSON.stringify( + (packageJSON as any).version, + ), + }, + preventAssignment: true, + }), + { + // TypeScript 4.9 cannot emit `typeof Symbol.dispose` or + // `[Symbol.dispose]` in declaration files because it predates + // the Explicit Resource Management proposal (TS >= 5.2). + // + // This plugin patches the emitted .d.ts after the build so + // consumers on TS >= 5.2 can use the `using` keyword: + // + // using extension = setUpExtension('purchase.checkout.block.render'); + // + // Remove this plugin once the repo upgrades to TS >= 5.2. + name: 'patch-disposable-types', + closeBundle: async () => { + const pkgDir = resolve( + process.cwd(), + 'packages/ui-extensions-tester', + ); + const buildDir = resolve(pkgDir, 'build/ts'); + const indexDts = resolve(buildDir, 'index.d.ts'); + + // Copy ambient Disposable type declarations (tsc doesn't emit .d.ts inputs) + copyFileSync( + resolve(pkgDir, 'src/disposable.d.ts'), + resolve(buildDir, 'disposable.d.ts'), + ); + + // Patch index.d.ts so the emitted types use Symbol.dispose + let content = readFileSync(indexDts, 'utf-8'); + // We need to add this in a post-build script so the path doesn't get mangled. + const ref = '/// '; + if (!content.startsWith(ref)) { + content = `${ref}\n${content}`; + } + content = content.replace( + 'declare const SymbolDispose: unique symbol', + 'declare const SymbolDispose: typeof Symbol.dispose', + ); + content = content.replace(/\[SymbolDispose\]/g, '[Symbol.dispose]'); + writeFileSync(indexDts, content); + }, + }, + ]), + ); +}); diff --git a/packages/ui-extensions-tester/package.json b/packages/ui-extensions-tester/package.json new file mode 100644 index 0000000000..daad99ee3f --- /dev/null +++ b/packages/ui-extensions-tester/package.json @@ -0,0 +1,90 @@ +{ + "name": "@shopify/ui-extensions-tester", + "version": "2026.7.0-rc.7", + "main": "index.js", + "module": "index.mjs", + "esnext": "index.esnext", + "types": "./build/ts/index.d.ts", + "exports": { + ".": { + "types": "./build/ts/index.d.ts", + "esnext": "./index.esnext", + "import": "./index.mjs", + "require": "./index.js" + }, + "./admin": { + "types": "./build/ts/admin/index.d.ts", + "esnext": "./admin.esnext", + "import": "./admin.mjs", + "require": "./admin.js" + }, + "./checkout": { + "types": "./build/ts/checkout/index.d.ts", + "esnext": "./checkout.esnext", + "import": "./checkout.mjs", + "require": "./checkout.js" + }, + "./point-of-sale": { + "types": "./build/ts/point-of-sale/index.d.ts", + "esnext": "./point-of-sale.esnext", + "import": "./point-of-sale.mjs", + "require": "./point-of-sale.js" + }, + "./customer-account": { + "types": "./build/ts/customer-account/index.d.ts", + "esnext": "./customer-account.esnext", + "import": "./customer-account.mjs", + "require": "./customer-account.js" + } + }, + "typesVersions": { + "*": { + "admin": [ + "./build/ts/admin/index.d.ts" + ], + "checkout": [ + "./build/ts/checkout/index.d.ts" + ], + "point-of-sale": [ + "./build/ts/point-of-sale/index.d.ts" + ], + "customer-account": [ + "./build/ts/customer-account/index.d.ts" + ] + } + }, + "license": "MIT", + "dependencies": { + "@shopify/ui-extensions": "2026.7.0-rc.7" + }, + "peerDependencies": { + "preact": "^10.0.0" + }, + "peerDependenciesMeta": { + "preact": { + "optional": true + } + }, + "devDependencies": { + "typescript": "^4.9.0" + }, + "publishConfig": { + "access": "public", + "@shopify:registry": "https://registry.npmjs.org/" + }, + "repository": { + "type": "git", + "url": "https://github.com/Shopify/ui-extensions.git", + "directory": "packages/ui-extensions-tester" + }, + "files": [ + "build", + "src", + "index.*", + "admin.*", + "checkout.*", + "point-of-sale.*", + "customer-account.*", + "README.md" + ] +} diff --git a/packages/ui-extensions-tester/src/admin/README.md b/packages/ui-extensions-tester/src/admin/README.md new file mode 100644 index 0000000000..f826ea8dbb --- /dev/null +++ b/packages/ui-extensions-tester/src/admin/README.md @@ -0,0 +1,104 @@ +# ⚙️ Admin helpers + +Surface-specific helpers for testing admin UI extensions. Import from `@shopify/ui-extensions-tester/admin`. + +These helpers also support app-level admin targets such as `admin.app.intent.render`. + +```ts +import { + createStorage, + createResult, +} from '@shopify/ui-extensions-tester/admin'; +``` + +## 💾 Mocking storage + +Admin extensions use a key-value `Storage` API. Create a mock with initial values: + +```ts +import {createStorage} from '@shopify/ui-extensions-tester/admin'; + +extension.shopify.storage = createStorage({ + 'my-setting': 'saved-value', +}); +``` + +## 🏠 App home mocks + +The `admin.app.home.render` target mock includes `shopify.toast`, `shopify.app`, `shopify.loading()`, `shopify.tools`, and `shopify.intents.request`. + +## 🧭 App intent mocks + +The `admin.app.intent.render` target mock includes `shopify.intents.response.ok()`, `.error()`, and `.closed()`. + +## 🔒 Mocking mutation return values + +Replace mutation functions with `vi.fn()` and use `createResult()` to build typed return values. The first argument is the mutation name; the second is an optional result override. + +```ts +import {createResult} from '@shopify/ui-extensions-tester/admin'; + +const applyMetafieldChange = vi + .fn() + .mockResolvedValue( + createResult('applyMetafieldChange'), + ); +extension.shopify.applyMetafieldChange = + applyMetafieldChange; +``` + +For discount function settings targets: + +```ts +import {createResult} from '@shopify/ui-extensions-tester/admin'; + +extension.shopify.applyMetafieldChange = vi + .fn() + .mockResolvedValue( + createResult('applyMetafieldChange'), + ); + +extension.shopify.discounts.updateDiscountClasses = + vi + .fn() + .mockReturnValue( + createResult('updateDiscountClasses'), + ); + +extension.shopify.discounts.updatePurchaseType = + vi + .fn() + .mockReturnValue( + createResult('updatePurchaseType'), + ); + +extension.shopify.discounts.updateRecurringCycleLimit = + vi + .fn() + .mockReturnValue( + createResult('updateRecurringCycleLimit'), + ); +``` + +## 📂 Example + +See the [admin example](../../../../examples/testing/admin-testing-example) for a fully working extension with a test suite. + +## 📖 API reference + +### `createStorage(initialEntries?)` + +Creates a mock `Storage` instance. Optionally accepts a `Record` of initial entries. + +### `createResult(mutation, result?)` + +Creates a typed mock result for an admin mutation API. + +Supported mutations: + +| Mutation | Default | +| ----------------------------- | --------------------------------------------- | +| `'applyMetafieldChange'` | `{type: 'success'}` | +| `'updateDiscountClasses'` | `{success: true, value: []}` | +| `'updatePurchaseType'` | `{success: true, value: 'one_time_purchase'}` | +| `'updateRecurringCycleLimit'` | `{success: true, value: null}` | diff --git a/packages/ui-extensions-tester/src/admin/factories.ts b/packages/ui-extensions-tester/src/admin/factories.ts new file mode 100644 index 0000000000..aa157d3022 --- /dev/null +++ b/packages/ui-extensions-tester/src/admin/factories.ts @@ -0,0 +1,458 @@ +import type { + ExtensionTarget, + ExtensionTargets, + StandardApi, + ActionExtensionApi, + BlockExtensionApi, + ProductDetailsConfigurationApi, + Intents, + ToastApi, + AppApi, + LoadingApi, + Tools, +} from '@shopify/ui-extensions/admin'; +import {createReadonlySignalLike} from '../mocks/signals'; +import {createMockI18n} from '../mocks/i18n'; +import {createStorage, createResult} from './index'; + +/** + * Extracts the API type for a given admin extension target directly from the + * implementation's `ExtensionTargets` interface. + * + * Properties prefixed with `__` are private internal APIs and are excluded + * from the mock type so they cannot be relied on in test suites. + */ +export type ApiForAdminExtension = + ExtensionTargets[T] extends {api: infer Api} + ? Omit + : never; + +// --------------------------------------------------------------------------- +// Derived types — not directly exported from the admin surface barrel +// --------------------------------------------------------------------------- + +type Navigation = BlockExtensionApi['navigation']; +type Data = ActionExtensionApi['data']; +type ResourcePickerApi = ActionExtensionApi['resourcePicker']; +type PickerApi = ActionExtensionApi['picker']; +type IntentActivity = NonNullable< + Awaited>> +>; +type IntentResponse = NonNullable< + Awaited> +>; +type IntentResponseApi = NonNullable; + +type ProductDetailsConfigData = + ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>['data']; +type ConfigApp = ProductDetailsConfigData['app']; + +export function gidFromTarget(target: ExtensionTarget): string { + const resource = target + .split('.')[1] + .replace(/-details$|-index$|-fulfilled-card$|-purchase-option$/, '') + .split('-') + .map((part) => part.charAt(0).toUpperCase() + part.slice(1)) + .join(''); + return `gid://shopify/${resource}/1`; +} + +function createData(selected: Data['selected'] = []): Data { + return {selected}; +} + +function createNavigation(): Navigation { + return {navigate: () => {}}; +} + +function createConfigApp(): ConfigApp { + return { + launchUrl: 'https://mock-app.test/launch', + applicationUrl: 'https://mock-app.test', + }; +} + +function createIntentResponseApi(): IntentResponseApi { + return { + ok: async () => {}, + error: async () => {}, + closed: async () => {}, + }; +} + +function createMockStandardApi( + target: T, +): StandardApi { + return { + extension: {target}, + auth: {idToken: async () => 'mock-id-token'}, + i18n: createMockI18n(), + intents: { + launchUrl: undefined, + invoke: async () => ({ + complete: Promise.resolve({code: 'closed'} as IntentResponse), + }), + }, + storage: createStorage(), + query: async () => ({data: undefined}), + }; +} + +function createMockStandardRenderingApi(target: T) { + return { + ...createMockStandardApi(target), + resourcePicker: (async () => undefined) as ResourcePickerApi, + picker: (async () => ({ + selected: Promise.resolve(undefined), + })) as PickerApi, + }; +} + +function createMockToastApi(): ToastApi { + return { + show: () => {}, + hide: () => {}, + }; +} + +function createMockAppApi(): AppApi { + return { + extensions: async () => [], + }; +} + +function createMockLoadingApi(): LoadingApi { + return () => {}; +} + +function createMockToolsApi(): Tools { + return { + register: () => () => {}, + unregister: () => {}, + clear: () => {}, + }; +} + +function createAppHomeMock(target: T) { + const {invoke} = createMockStandardApi(target).intents; + + return { + ...createMockStandardRenderingApi(target), + toast: createMockToastApi(), + app: createMockAppApi(), + loading: createMockLoadingApi(), + tools: createMockToolsApi(), + intents: { + invoke, + request: { + value: null, + subscribe: () => () => {}, + }, + }, + }; +} + +function createAppIntentRenderMock(target: T) { + return { + ...createMockStandardRenderingApi(target), + intents: { + ...createMockStandardApi(target).intents, + response: createIntentResponseApi(), + }, + }; +} + +function createMockBlockApi(target: T) { + return { + ...createMockStandardRenderingApi(target), + data: createData([{id: gidFromTarget(target)}]), + navigation: createNavigation(), + }; +} + +function createMockActionApi(target: T) { + return { + ...createMockStandardRenderingApi(target), + close: () => {}, + data: createData([{id: gidFromTarget(target)}]), + }; +} + +// --------------------------------------------------------------------------- +// Group factory functions — each composes the correct API for a target group +// --------------------------------------------------------------------------- + +function createPrintActionMock(target: T) { + return { + ...createMockStandardRenderingApi(target), + data: createData(), + }; +} + +function createShouldRenderMock(target: T) { + return { + ...createMockStandardApi(target), + data: createData(), + }; +} + +function createProductDetailsConfigMock(target: T) { + return { + ...createMockBlockApi(target), + data: { + selected: [], + product: { + id: 'gid://shopify/Product/1', + title: 'Mock Product', + handle: 'mock-product', + status: 'ACTIVE' as const, + totalVariants: 1, + totalInventory: 10, + hasOnlyDefaultVariant: true, + onlineStoreUrl: 'https://mock-shop.myshopify.com/products/mock-product', + options: [], + productType: '', + productComponents: [], + }, + app: createConfigApp(), + }, + }; +} + +function createProductVariantDetailsConfigMock( + target: T, +) { + return { + ...createMockBlockApi(target), + data: { + selected: [], + variant: { + id: 'gid://shopify/ProductVariant/1', + sku: 'MOCK-SKU', + barcode: '', + title: 'Default', + displayName: 'Mock Product - Default', + price: '0.00', + compareAtPrice: '0.00', + taxable: true, + taxCode: '', + weight: 0, + selectedOptions: [], + productVariantComponents: [], + }, + app: createConfigApp(), + }, + }; +} + +function createDiscountFunctionSettingsMock( + target: T, +) { + return { + ...createMockStandardRenderingApi(target), + navigation: createNavigation(), + applyMetafieldChange: async () => createResult('applyMetafieldChange'), + data: { + id: 'gid://shopify/DiscountAutomaticApp/1', + metafields: [], + }, + discounts: { + discountClasses: createReadonlySignalLike([]), + updateDiscountClasses: () => createResult('updateDiscountClasses'), + discountMethod: createReadonlySignalLike('automatic' as const), + purchaseType: createReadonlySignalLike('one_time_purchase' as const), + updatePurchaseType: () => createResult('updatePurchaseType'), + recurringCycleLimit: createReadonlySignalLike(null), + updateRecurringCycleLimit: () => + createResult('updateRecurringCycleLimit'), + }, + }; +} + +function createOrderRoutingRuleMock(target: T) { + return { + ...createMockStandardRenderingApi(target), + applyMetafieldsChange: () => {}, + data: { + rule: { + label: 'Mock Routing Rule', + description: 'A mock order routing rule', + id: 'gid://shopify/DeliveryCustomization/1', + metafields: [], + }, + }, + }; +} + +function createValidationSettingsMock(target: T) { + return { + ...createMockStandardRenderingApi(target), + applyMetafieldChange: async () => createResult('applyMetafieldChange'), + data: { + validation: undefined, + shopifyFunction: {id: 'gid://shopify/ShopifyFunction/1'}, + }, + }; +} + +function createPurchaseOptionsCardMock(target: T) { + return { + ...createMockActionApi(target), + data: {selected: []}, + }; +} + +function createCustomerSegmentTemplateMock( + target: T, +) { + return { + ...createMockStandardApi(target), + }; +} + +// --------------------------------------------------------------------------- +// Factory map — TypeScript verifies each entry against ApiForTarget +// --------------------------------------------------------------------------- + +type AdminMockFactory = { + [K in ExtensionTarget]: (target: K) => ApiForAdminExtension; +}; + +const adminMockFactories: AdminMockFactory = { + // Runnable targets + 'admin.customers.segmentation-templates.data': + createCustomerSegmentTemplateMock, + 'admin.app.tools.data': createMockStandardApi, + + // App render targets + 'admin.app.home.render': createAppHomeMock, + 'admin.app.intent.render': createAppIntentRenderMock, + + // Block targets + 'admin.product-details.block.render': createMockBlockApi, + 'admin.order-details.block.render': createMockBlockApi, + 'admin.customer-details.block.render': createMockBlockApi, + 'admin.collection-details.block.render': createMockBlockApi, + 'admin.draft-order-details.block.render': createMockBlockApi, + 'admin.abandoned-checkout-details.block.render': createMockBlockApi, + 'admin.catalog-details.block.render': createMockBlockApi, + 'admin.company-details.block.render': createMockBlockApi, + 'admin.company-location-details.block.render': createMockBlockApi, + 'admin.gift-card-details.block.render': createMockBlockApi, + 'admin.product-variant-details.block.render': createMockBlockApi, + 'admin.product-details.reorder.render': createMockBlockApi, + + // Action targets + 'admin.product-details.action.render': createMockActionApi, + 'admin.catalog-details.action.render': createMockActionApi, + 'admin.company-details.action.render': createMockActionApi, + 'admin.gift-card-details.action.render': createMockActionApi, + 'admin.order-details.action.render': createMockActionApi, + 'admin.customer-details.action.render': createMockActionApi, + 'admin.customer-segment-details.action.render': createMockActionApi, + 'admin.product-index.action.render': createMockActionApi, + 'admin.order-index.action.render': createMockActionApi, + 'admin.customer-index.action.render': createMockActionApi, + 'admin.discount-index.action.render': createMockActionApi, + 'admin.collection-details.action.render': createMockActionApi, + 'admin.collection-index.action.render': createMockActionApi, + 'admin.abandoned-checkout-details.action.render': createMockActionApi, + 'admin.abandoned-checkout-index.action.render': createMockActionApi, + 'admin.product-variant-details.action.render': createMockActionApi, + 'admin.draft-order-details.action.render': createMockActionApi, + 'admin.draft-order-index.action.render': createMockActionApi, + 'admin.discount-details.action.render': createMockActionApi, + 'admin.order-fulfilled-card.action.render': createMockActionApi, + + // Bulk action targets + 'admin.product-index.selection-action.render': createMockActionApi, + 'admin.order-index.selection-action.render': createMockActionApi, + 'admin.customer-index.selection-action.render': createMockActionApi, + 'admin.draft-order-index.selection-action.render': createMockActionApi, + 'admin.discount-index.selection-action.render': createMockActionApi, + + // Purchase options card action targets + 'admin.product-purchase-option.action.render': createPurchaseOptionsCardMock, + 'admin.product-variant-purchase-option.action.render': + createPurchaseOptionsCardMock, + + // Print action targets + 'admin.order-details.print-action.render': createPrintActionMock, + 'admin.product-details.print-action.render': createPrintActionMock, + 'admin.order-index.selection-print-action.render': createPrintActionMock, + 'admin.product-index.selection-print-action.render': createPrintActionMock, + + // Configuration targets + 'admin.product-details.configuration.render': createProductDetailsConfigMock, + 'admin.product-variant-details.configuration.render': + createProductVariantDetailsConfigMock, + + // Function settings targets + 'admin.discount-details.function-settings.render': + createDiscountFunctionSettingsMock, + 'admin.settings.internal-order-routing-rule.render': + createOrderRoutingRuleMock, + 'admin.settings.order-routing-rule.render': createOrderRoutingRuleMock, + 'admin.settings.validation.render': createValidationSettingsMock, + + // Should-render targets (action) + 'admin.product-details.action.should-render': createShouldRenderMock, + 'admin.catalog-details.action.should-render': createShouldRenderMock, + 'admin.company-details.action.should-render': createShouldRenderMock, + 'admin.gift-card-details.action.should-render': createShouldRenderMock, + 'admin.order-details.action.should-render': createShouldRenderMock, + 'admin.customer-details.action.should-render': createShouldRenderMock, + 'admin.customer-segment-details.action.should-render': createShouldRenderMock, + 'admin.product-index.action.should-render': createShouldRenderMock, + 'admin.order-index.action.should-render': createShouldRenderMock, + 'admin.customer-index.action.should-render': createShouldRenderMock, + 'admin.discount-index.action.should-render': createShouldRenderMock, + 'admin.collection-details.action.should-render': createShouldRenderMock, + 'admin.collection-index.action.should-render': createShouldRenderMock, + 'admin.abandoned-checkout-details.action.should-render': + createShouldRenderMock, + 'admin.abandoned-checkout-index.action.should-render': createShouldRenderMock, + 'admin.product-variant-details.action.should-render': createShouldRenderMock, + 'admin.draft-order-details.action.should-render': createShouldRenderMock, + 'admin.draft-order-index.action.should-render': createShouldRenderMock, + 'admin.discount-details.action.should-render': createShouldRenderMock, + 'admin.order-fulfilled-card.action.should-render': createShouldRenderMock, + + // Should-render targets (bulk action) + 'admin.product-index.selection-action.should-render': createShouldRenderMock, + 'admin.order-index.selection-action.should-render': createShouldRenderMock, + 'admin.customer-index.selection-action.should-render': createShouldRenderMock, + 'admin.draft-order-index.selection-action.should-render': + createShouldRenderMock, + 'admin.discount-index.selection-action.should-render': createShouldRenderMock, + + // Should-render targets (print action) + 'admin.order-details.print-action.should-render': createShouldRenderMock, + 'admin.product-details.print-action.should-render': createShouldRenderMock, + 'admin.order-index.selection-print-action.should-render': + createShouldRenderMock, + 'admin.product-index.selection-print-action.should-render': + createShouldRenderMock, +}; + +// --------------------------------------------------------------------------- +// Main factory +// --------------------------------------------------------------------------- + +/** + * Creates a complete mock API for an admin extension target. + * Each entry in the factory map is type-checked by TypeScript against + * the concrete API type for that target. + */ +export function createMockAdminTargetApi( + target: T, +): ApiForAdminExtension { + const factory = adminMockFactories[target]; + if (!factory) { + throw new Error( + `Unsupported admin target: "${target}". ` + + 'Add an entry for this target in adminMockFactories.', + ); + } + return factory(target); +} diff --git a/packages/ui-extensions-tester/src/admin/index.ts b/packages/ui-extensions-tester/src/admin/index.ts new file mode 100644 index 0000000000..8d1b79ca8a --- /dev/null +++ b/packages/ui-extensions-tester/src/admin/index.ts @@ -0,0 +1,94 @@ +import type { + ExtensionTarget, + StandardApi, + ValidationSettingsApi, + DiscountFunctionSettingsApi, +} from '@shopify/ui-extensions/admin'; + +type Storage = StandardApi['storage']; +type DiscountsApi = + DiscountFunctionSettingsApi<'admin.discount-details.function-settings.render'>['discounts']; +type ValidationApplyMetafieldChange = + ValidationSettingsApi<'admin.settings.validation.render'>['applyMetafieldChange']; +type DiscountApplyMetafieldChange = + DiscountFunctionSettingsApi<'admin.discount-details.function-settings.render'>['applyMetafieldChange']; +/** + * Creates a mock `Storage` instance. + * + * Optionally accepts a `Record` of initial entries. + */ +export function createStorage( + initialEntries?: Record, +): Storage { + const store = new Map( + initialEntries ? Object.entries(initialEntries) : [], + ); + return { + set: async (key, value) => { + store.set(key as string, value); + }, + setMany: async (entries) => { + for (const [entryKey, entryValue] of Object.entries(entries)) { + store.set(entryKey, entryValue); + } + }, + get: async (key) => store.get(key as string) as any, + getMany: async (keys) => + (keys as string[]).map((entry) => store.get(entry)) as any, + clear: async () => { + store.clear(); + }, + delete: async (key) => store.delete(key as string), + deleteMany: async (keys) => { + const result: Record = {}; + for (const entry of keys as string[]) { + result[entry] = store.delete(entry); + } + return result as any; + }, + entries: async () => store.entries() as any, + }; +} + +/** + * Maps each admin mutation API name to its result type. + */ +export interface AdminMutationResults { + applyMetafieldChange: + | Awaited> + | Awaited>; + updateDiscountClasses: ReturnType; + updatePurchaseType: ReturnType; + updateRecurringCycleLimit: ReturnType< + DiscountsApi['updateRecurringCycleLimit'] + >; +} + +const adminMutationDefaults: { + [K in keyof AdminMutationResults]: () => AdminMutationResults[K]; +} = { + applyMetafieldChange: () => ({type: 'success'}), + updateDiscountClasses: () => ({success: true as const, value: []}), + updatePurchaseType: () => ({ + success: true as const, + value: 'one_time_purchase' as const, + }), + updateRecurringCycleLimit: () => ({success: true as const, value: null}), +}; + +/** + * Creates a typed mock result for an admin mutation API. + * + * @param mutation - The mutation API name (e.g. `'applyMetafieldChange'`). + * @param result - Optional partial override merged with the default. + * + * @example + * createResult('applyMetafieldChange'); + * createResult('updateDiscountClasses', {value: ['ORDER']}); + */ +export function createResult( + mutation: K, + result?: Partial, +): AdminMutationResults[K] { + return {...adminMutationDefaults[mutation](), ...result}; +} diff --git a/packages/ui-extensions-tester/src/api-version.ts b/packages/ui-extensions-tester/src/api-version.ts new file mode 100644 index 0000000000..794d7bbcd6 --- /dev/null +++ b/packages/ui-extensions-tester/src/api-version.ts @@ -0,0 +1,23 @@ +/** + * The API version supported by this version of the library. + * + * At build time, `__TESTER_PACKAGE_VERSION__` is replaced by rollup with the + * raw NPM version string from package.json (e.g. `"2026.4.0-rc.1"`). + * + * When running from source (e.g. in tests), the placeholder is still + * present, so we fall back to reading package.json via require. + */ + +declare const __TESTER_PACKAGE_VERSION__: string; + +const npmVersion: string = + typeof __TESTER_PACKAGE_VERSION__ === 'undefined' + ? (require('../package.json') as {version: string}).version // eslint-disable-line @typescript-eslint/no-var-requires + : __TESTER_PACKAGE_VERSION__; + +function npmVersionToApiVersion(version: string): string { + const [year, minor] = version.split('.'); + return `${year}-${minor!.padStart(2, '0')}`; +} + +export const API_VERSION: string = npmVersionToApiVersion(npmVersion); diff --git a/packages/ui-extensions-tester/src/checkout/README.md b/packages/ui-extensions-tester/src/checkout/README.md new file mode 100644 index 0000000000..609bfbdb65 --- /dev/null +++ b/packages/ui-extensions-tester/src/checkout/README.md @@ -0,0 +1,152 @@ +# 🛒 Checkout helpers + +Surface-specific helpers for testing checkout UI extensions. Import from `@shopify/ui-extensions-tester/checkout`. + +```ts +import { + createCartLine, + createResult, +} from '@shopify/ui-extensions-tester/checkout'; +``` + +## 🧩 Mocking cart lines + +Use `createCartLine()` to build realistic cart line data with sensible defaults, then assign it to the mock: + +```ts +import {createCartLine} from '@shopify/ui-extensions-tester/checkout'; + +extension.shopify.lines.value = [ + createCartLine({quantity: 2}), + createCartLine({ + id: 'gid://shopify/CartLine/2', + merchandise: { + type: 'variant', + id: 'gid://shopify/ProductVariant/99', + title: 'Large Widget', + selectedOptions: [], + product: { + id: 'gid://shopify/Product/42', + vendor: 'Acme', + productType: 'widget', + }, + requiresShipping: true, + }, + }), +]; +``` + +## 📦 Mocking shipping options + +```ts +import {createShippingOption} from '@shopify/ui-extensions-tester/checkout'; + +extension.shopify.target.value = + createShippingOption({ + title: 'Express Shipping', + cost: {amount: 15, currencyCode: 'USD'}, + }); +``` + +## 📍 Mocking pickup locations + +```ts +import { + createPickupLocationOption, + createPickupLocation, +} from '@shopify/ui-extensions-tester/checkout'; + +extension.shopify.target.value = + createPickupLocationOption({ + location: createPickupLocation({ + name: 'Downtown Store', + }), + }); +``` + +## 💾 Mocking storage + +```ts +import {createStorage} from '@shopify/ui-extensions-tester/checkout'; + +extension.shopify.storage = createStorage({ + acceptedTerms: true, +}); +``` + +## 🔒 Mocking mutation return values + +Replace any mutation function with a `vi.fn()` and use `createResult()` to build a typed return value. The first argument is the mutation API name; the second is an optional result override (defaults to `{type: 'success'}`). + +```ts +import {createResult} from '@shopify/ui-extensions-tester/checkout'; + +const applyCartLinesChange = vi + .fn() + .mockResolvedValue( + createResult('applyCartLinesChange', { + type: 'success', + }), + ); +extension.shopify.applyCartLinesChange = + applyCartLinesChange; +``` + +To simulate an error: + +```ts +import {createResult} from '@shopify/ui-extensions-tester/checkout'; + +const applyCartLinesChange = vi + .fn() + .mockResolvedValue( + createResult('applyCartLinesChange', { + type: 'error', + message: 'Out of stock', + }), + ); +``` + +## 📂 Example + +See the [checkout example](../../../../examples/testing/checkout-basic-testing-example) for a fully working extension with a test suite. + +## 📖 API reference + +### `createCartLine(overrides?)` + +Creates a mock `CartLine` with sensible defaults. Pass a partial override to customize any field. + +### `createShippingOption(overrides?)` + +Creates a mock `ShippingOption` with sensible defaults. + +### `createPickupLocation(overrides?)` + +Creates a mock pickup `Location` object with sensible defaults. + +### `createPickupLocationOption(overrides?)` + +Creates a mock `PickupLocationOption` with sensible defaults. + +### `createStorage(initialEntries?)` + +Creates a mock `Storage` instance. Optionally accepts a `Record` of initial entries. + +### `createResult(mutation, result?)` + +Creates a typed mock result for a checkout mutation API. The `mutation` argument is strongly typed to only accept known mutation names. The return type matches the result type of the given mutation. + +Supported mutations: + +| Mutation | Default | +| -------------------------------------- | ------------------- | +| `'applyAttributeChange'` | `{type: 'success'}` | +| `'applyCartLinesChange'` | `{type: 'success'}` | +| `'applyDiscountCodeChange'` | `{type: 'success'}` | +| `'applyGiftCardChange'` | `{type: 'success'}` | +| `'applyMetafieldChange'` | `{type: 'success'}` | +| `'applyNoteChange'` | `{type: 'success'}` | +| `'applyTrackingConsentChange'` | `{type: 'success'}` | +| `'applyPaymentMethodAttributesChange'` | `{type: 'success'}` | +| `'applyRedeemableChange'` | `{type: 'success'}` | diff --git a/packages/ui-extensions-tester/src/checkout/factories.ts b/packages/ui-extensions-tester/src/checkout/factories.ts new file mode 100644 index 0000000000..e5e6d3773b --- /dev/null +++ b/packages/ui-extensions-tester/src/checkout/factories.ts @@ -0,0 +1,482 @@ +import type { + ApiForExtension, + ExtensionTarget, + StandardApi, + CheckoutApi, + OrderConfirmationApi, + CartLineItemApi, + ShippingOptionItemApi, + ShippingOptionListApi, + PickupPointListApi, + PickupLocationListApi, + PickupLocationItemApi, + PaymentOptionItemApi, + RedeemableApi, + Language, +} from '@shopify/ui-extensions/checkout'; +import {createSubscribableSignalLike} from '../mocks/signals'; +import {createMockI18n} from '../mocks/i18n'; +import {createMoney} from '../mocks/money'; +import {API_VERSION} from '../api-version'; +import { + createCartLine, + createShippingOption, + createPickupLocationOption, + createStorage, + createResult, +} from './index'; + +function createLanguage(): Language { + return {isoCode: 'en'}; +} + +function createSharedApiMocks() { + return { + analytics: { + publish: async () => true, + visitor: async () => ({type: 'success' as const}), + }, + i18n: createMockI18n(), + sessionToken: {get: async () => 'mock-session-token'}, + shop: { + id: 'gid://shopify/Shop/1', + name: 'Mock Shop', + storefrontUrl: 'https://mock-shop.myshopify.com', + myshopifyDomain: 'mock-shop.myshopify.com', + }, + storage: createStorage(), + }; +} + +function createMockStandardApi( + target: T, +): StandardApi { + const shared = createSharedApiMocks(); + return { + ...shared, + appliedGiftCards: createSubscribableSignalLike([]), + instructions: createSubscribableSignalLike({ + attributes: {canUpdateAttributes: true}, + delivery: {canSelectCustomAddress: true}, + discounts: {canUpdateDiscountCodes: true}, + lines: { + canAddCartLine: true, + canRemoveCartLine: true, + canUpdateCartLine: true, + }, + metafields: {canSetCartMetafields: true, canDeleteCartMetafield: true}, + notes: {canUpdateNote: true}, + }), + appMetafields: createSubscribableSignalLike([]), + attributes: createSubscribableSignalLike([]), + availablePaymentOptions: createSubscribableSignalLike([]), + buyerJourney: { + intercept: async () => () => {}, + completed: createSubscribableSignalLike(false), + steps: createSubscribableSignalLike([]), + activeStep: createSubscribableSignalLike(undefined), + }, + checkoutSettings: createSubscribableSignalLike({ + orderSubmission: 'ORDER', + shippingAddress: {isEditable: true}, + }), + checkoutToken: createSubscribableSignalLike(undefined), + cost: { + subtotalAmount: createSubscribableSignalLike(createMoney()), + totalShippingAmount: createSubscribableSignalLike(undefined), + totalTaxAmount: createSubscribableSignalLike(undefined), + totalAmount: createSubscribableSignalLike(createMoney()), + }, + deliveryGroups: createSubscribableSignalLike([]), + discountCodes: createSubscribableSignalLike([]), + discountAllocations: createSubscribableSignalLike([]), + extension: { + apiVersion: API_VERSION as any, + capabilities: createSubscribableSignalLike([]), + rendered: createSubscribableSignalLike(true), + scriptUrl: 'https://example-cdn.com/extension.js', + target, + }, + extensionPoint: target, + lines: createSubscribableSignalLike([]), + localization: { + currency: createSubscribableSignalLike({isoCode: 'USD' as const}), + timezone: createSubscribableSignalLike('America/New_York' as const), + language: createSubscribableSignalLike(createLanguage()), + extensionLanguage: createSubscribableSignalLike(createLanguage()), + country: createSubscribableSignalLike({isoCode: 'US' as const}), + market: createSubscribableSignalLike(undefined), + }, + note: createSubscribableSignalLike(undefined), + query: async () => ({data: undefined, errors: []}), + selectedPaymentOptions: createSubscribableSignalLike([]), + settings: createSubscribableSignalLike({}), + version: '0.0.0', + customerPrivacy: createSubscribableSignalLike({ + allowedProcessing: { + analytics: true, + marketing: true, + preferences: true, + saleOfData: true, + }, + metafields: [], + visitorConsent: {}, + shouldShowBanner: false, + saleOfDataRegion: false, + }), + applyTrackingConsentChange: async () => + createResult('applyTrackingConsentChange'), + }; +} + +function createMockCheckoutApi(): CheckoutApi { + return { + applyAttributeChange: async () => createResult('applyAttributeChange'), + applyCartLinesChange: async () => createResult('applyCartLinesChange'), + applyDiscountCodeChange: async () => + createResult('applyDiscountCodeChange'), + applyGiftCardChange: async () => createResult('applyGiftCardChange'), + applyMetafieldChange: async () => createResult('applyMetafieldChange'), + applyNoteChange: async () => createResult('applyNoteChange'), + }; +} + +function createMockOrderConfirmationApi(): OrderConfirmationApi { + return { + orderConfirmation: createSubscribableSignalLike({ + order: {id: 'gid://shopify/Order/1'}, + isFirstOrder: false, + }), + }; +} + +function createMockCartLineItemApi(): CartLineItemApi { + return { + target: createSubscribableSignalLike(createCartLine()), + }; +} + +// --------------------------------------------------------------------------- +// Group factory functions — each composes the correct API for a target group +// --------------------------------------------------------------------------- + +function createCheckoutStandardMock( + target: T, +): CheckoutApi & StandardApi { + return {...createMockStandardApi(target), ...createMockCheckoutApi()}; +} + +function createCheckoutCartLineItemMock( + target: T, +): CheckoutApi & CartLineItemApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockCheckoutApi(), + ...createMockCartLineItemApi(), + }; +} + +function createCartLineItemMock( + target: T, +): CartLineItemApi & StandardApi { + return {...createMockStandardApi(target), ...createMockCartLineItemApi()}; +} + +function createCheckoutRedeemableMock( + target: T, +): RedeemableApi & CheckoutApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockCheckoutApi(), + applyRedeemableChange: async () => createResult('applyRedeemableChange'), + }; +} + +function createCheckoutPaymentOptionItemMock( + target: T, +): PaymentOptionItemApi & CheckoutApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockCheckoutApi(), + applyPaymentMethodAttributesChange: async () => + createResult('applyPaymentMethodAttributesChange'), + }; +} + +function createCheckoutShippingOptionListMock( + target: T, +): ShippingOptionListApi & CheckoutApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockCheckoutApi(), + target: createSubscribableSignalLike(undefined), + deliverySelectionGroups: createSubscribableSignalLike(undefined), + }; +} + +function createCheckoutShippingOptionItemMock( + target: T, +): ShippingOptionItemApi & CheckoutApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockCheckoutApi(), + target: createSubscribableSignalLike(createShippingOption()), + isTargetSelected: createSubscribableSignalLike(false), + renderMode: {overlay: false}, + }; +} + +function createCheckoutPickupLocationListMock( + target: T, +): PickupLocationListApi & CheckoutApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockCheckoutApi(), + isLocationFormVisible: createSubscribableSignalLike(false), + }; +} + +function createCheckoutPickupPointListMock( + target: T, +): PickupPointListApi & CheckoutApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockCheckoutApi(), + isLocationFormVisible: createSubscribableSignalLike(false), + }; +} + +function createCheckoutPickupLocationItemMock( + target: T, +): PickupLocationItemApi & CheckoutApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockCheckoutApi(), + target: createSubscribableSignalLike(createPickupLocationOption()), + isTargetSelected: createSubscribableSignalLike(false), + }; +} + +function createOrderConfirmationMock( + target: T, +): OrderConfirmationApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockOrderConfirmationApi(), + }; +} + +function createOrderConfirmationCartLineItemMock( + target: T, +): OrderConfirmationApi & CartLineItemApi & StandardApi { + return { + ...createMockStandardApi(target), + ...createMockOrderConfirmationApi(), + ...createMockCartLineItemApi(), + }; +} + +function createAddressAutocompleteSuggestMock( + target: T, +): ApiForExtension { + return { + ...createMockAddressAutocompleteStandardApi(target), + signal: new AbortController().signal, + target: {value: '', field: 'address1' as const}, + } as ApiForExtension; +} + +function createAddressAutocompleteFormatSuggestionMock< + T extends ExtensionTarget, +>(target: T): ApiForExtension { + return { + ...createMockAddressAutocompleteStandardApi(target), + target: {selectedSuggestion: {label: ''}}, + } as ApiForExtension; +} + +function createMockAddressAutocompleteStandardApi( + target: T, +) { + const shared = createSharedApiMocks(); + return { + ...shared, + appMetafields: [], + attributes: undefined, + billingAddress: undefined, + checkoutToken: undefined, + extension: { + apiVersion: API_VERSION as any, + capabilities: [], + editor: undefined, + target, + version: '0.0.0', + }, + localization: { + currency: {isoCode: 'USD' as const}, + timezone: 'America/New_York' as const, + language: createLanguage(), + extensionLanguage: createLanguage(), + country: {isoCode: 'US' as const}, + market: undefined, + }, + query: async () => ({data: undefined, errors: []}), + settings: {}, + shippingAddress: undefined, + version: '0.0.0', + }; +} + +// --------------------------------------------------------------------------- +// Factory map — TypeScript verifies each entry against ApiForExtension +// --------------------------------------------------------------------------- + +type CheckoutMockFactory = { + [K in ExtensionTarget]: (target: K) => ApiForExtension; +}; + +const checkoutMockFactories: CheckoutMockFactory = { + // CheckoutApi & StandardApi + 'purchase.checkout.actions.render-before': createCheckoutStandardMock, + 'Checkout::Actions::RenderBefore': createCheckoutStandardMock, + 'purchase.checkout.cart-line-list.render-after': createCheckoutStandardMock, + 'Checkout::CartLines::RenderAfter': createCheckoutStandardMock, + 'purchase.checkout.contact.render-after': createCheckoutStandardMock, + 'Checkout::Contact::RenderAfter': createCheckoutStandardMock, + 'Checkout::CustomerInformation::RenderAfter': createCheckoutStandardMock, + 'purchase.checkout.delivery-address.render-before': + createCheckoutStandardMock, + 'Checkout::DeliveryAddress::RenderBefore': createCheckoutStandardMock, + 'purchase.checkout.delivery-address.render-after': createCheckoutStandardMock, + 'purchase.checkout.block.render': createCheckoutStandardMock, + 'Checkout::Dynamic::Render': createCheckoutStandardMock, + 'purchase.checkout.payment-option-item.action-required.render': + createCheckoutStandardMock, + 'Checkout::PaymentMethod::RenderRequiredAction': createCheckoutStandardMock, + 'purchase.checkout.payment-method-list.render-before': + createCheckoutStandardMock, + 'purchase.checkout.payment-method-list.render-after': + createCheckoutStandardMock, + 'purchase.checkout.reductions.render-before': createCheckoutStandardMock, + 'Checkout::Reductions::RenderBefore': createCheckoutStandardMock, + 'purchase.checkout.reductions.render-after': createCheckoutStandardMock, + 'Checkout::Reductions::RenderAfter': createCheckoutStandardMock, + 'purchase.checkout.header.render-after': createCheckoutStandardMock, + 'purchase.checkout.footer.render-after': createCheckoutStandardMock, + 'purchase.checkout.chat.render': createCheckoutStandardMock, + + // CheckoutApi & CartLineItemApi & StandardApi + 'purchase.checkout.cart-line-item.render-after': + createCheckoutCartLineItemMock, + 'Checkout::CartLineDetails::RenderAfter': createCheckoutCartLineItemMock, + + // CartLineItemApi & StandardApi + 'purchase.cart-line-item.line-components.render': createCartLineItemMock, + 'Checkout::CartLineDetails::RenderLineComponents': createCartLineItemMock, + + // RedeemableApi & CheckoutApi & StandardApi + 'purchase.checkout.gift-card.render': createCheckoutRedeemableMock, + 'Checkout::GiftCard::Render': createCheckoutRedeemableMock, + + // PaymentOptionItemApi & CheckoutApi & StandardApi + 'purchase.checkout.payment-option-item.details.render': + createCheckoutPaymentOptionItemMock, + 'Checkout::PaymentMethod::Render': createCheckoutPaymentOptionItemMock, + 'purchase.checkout.payment-option-item.hosted-fields.render-after': + createCheckoutPaymentOptionItemMock, + 'Checkout::PaymentMethod::HostedFields::RenderAfter': + createCheckoutPaymentOptionItemMock, + + // ShippingOptionListApi & CheckoutApi & StandardApi + 'purchase.checkout.shipping-option-list.render-before': + createCheckoutShippingOptionListMock, + 'Checkout::ShippingMethods::RenderBefore': + createCheckoutShippingOptionListMock, + 'purchase.checkout.shipping-option-list.render-after': + createCheckoutShippingOptionListMock, + 'Checkout::ShippingMethods::RenderAfter': + createCheckoutShippingOptionListMock, + + // ShippingOptionItemApi & CheckoutApi & StandardApi + 'purchase.checkout.shipping-option-item.render-after': + createCheckoutShippingOptionItemMock, + 'Checkout::ShippingMethodDetails::RenderAfter': + createCheckoutShippingOptionItemMock, + 'purchase.checkout.shipping-option-item.details.render': + createCheckoutShippingOptionItemMock, + 'Checkout::ShippingMethodDetails::RenderExpanded': + createCheckoutShippingOptionItemMock, + + // PickupLocationListApi & CheckoutApi & StandardApi + 'purchase.checkout.pickup-location-list.render-before': + createCheckoutPickupLocationListMock, + 'Checkout::PickupLocations::RenderBefore': + createCheckoutPickupLocationListMock, + 'purchase.checkout.pickup-location-list.render-after': + createCheckoutPickupLocationListMock, + 'Checkout::PickupLocations::RenderAfter': + createCheckoutPickupLocationListMock, + + // PickupPointListApi & CheckoutApi & StandardApi + 'purchase.checkout.pickup-point-list.render-before': + createCheckoutPickupPointListMock, + 'Checkout::PickupPoints::RenderBefore': createCheckoutPickupPointListMock, + 'purchase.checkout.pickup-point-list.render-after': + createCheckoutPickupPointListMock, + 'Checkout::PickupPoints::RenderAfter': createCheckoutPickupPointListMock, + + // PickupLocationItemApi & CheckoutApi & StandardApi + 'purchase.checkout.pickup-location-option-item.render-after': + createCheckoutPickupLocationItemMock, + + // OrderConfirmationApi & StandardApi + 'purchase.thank-you.block.render': createOrderConfirmationMock, + 'Checkout::ThankYou::Dynamic::Render': createOrderConfirmationMock, + 'purchase.thank-you.cart-line-list.render-after': createOrderConfirmationMock, + 'Checkout::ThankYou::CartLines::RenderAfter': createOrderConfirmationMock, + 'purchase.thank-you.customer-information.render-after': + createOrderConfirmationMock, + 'Checkout::ThankYou::CustomerInformation::RenderAfter': + createOrderConfirmationMock, + 'purchase.thank-you.header.render-after': createOrderConfirmationMock, + 'purchase.thank-you.footer.render-after': createOrderConfirmationMock, + 'purchase.thank-you.chat.render': createOrderConfirmationMock, + 'purchase.thank-you.announcement.render': createOrderConfirmationMock, + + // OrderConfirmationApi & CartLineItemApi & StandardApi + 'purchase.thank-you.cart-line-item.render-after': + createOrderConfirmationCartLineItemMock, + 'Checkout::ThankYou::CartLineDetails::RenderAfter': + createOrderConfirmationCartLineItemMock, + + // AddressAutocompleteStandardApi & AddressAutocompleteSuggestApi + 'purchase.address-autocomplete.suggest': createAddressAutocompleteSuggestMock, + + // AddressAutocompleteStandardApi & AddressAutocompleteFormatSuggestionApi + 'purchase.address-autocomplete.format-suggestion': + createAddressAutocompleteFormatSuggestionMock, +}; + +// --------------------------------------------------------------------------- +// Main factory +// --------------------------------------------------------------------------- + +/** + * Creates a complete mock API for a checkout extension target. + * + * Each entry in the factory map is type-checked by TypeScript against + * the concrete `ApiForExtension` for that target. Indexing the mapped + * type with generic `T` preserves the relationship, so no cast is needed. + */ +export function createMockCheckoutTargetApi( + target: T, +): ApiForExtension { + const factory = checkoutMockFactories[target]; + if (!factory) { + throw new Error( + `Unsupported checkout target: "${target}". ` + + 'Add an entry for this target in checkoutMockFactories.', + ); + } + return factory(target); +} diff --git a/packages/ui-extensions-tester/src/checkout/index.ts b/packages/ui-extensions-tester/src/checkout/index.ts new file mode 100644 index 0000000000..acc0600848 --- /dev/null +++ b/packages/ui-extensions-tester/src/checkout/index.ts @@ -0,0 +1,174 @@ +import type { + CartLine, + Storage, + ShippingOption, + PickupLocationOption, + CheckoutApi, + StandardApi, + ExtensionTarget, + RedeemableApi, + PaymentOptionItemApi, +} from '@shopify/ui-extensions/checkout'; +import {createMoney} from '../mocks/money'; + +/** + * Creates a mock `CartLine` with sensible defaults. + * Pass a partial override to customize any field. + */ +export function createCartLine(overrides?: Partial): CartLine { + return { + id: 'gid://shopify/CartLine/1', + merchandise: { + type: 'variant' as const, + id: 'gid://shopify/ProductVariant/1', + title: 'Mock Variant', + selectedOptions: [], + product: { + id: 'gid://shopify/Product/1', + vendor: 'Mock Vendor', + productType: '', + }, + requiresShipping: true, + }, + quantity: 1, + cost: {totalAmount: createMoney()}, + attributes: [], + discountAllocations: [], + lineComponents: [], + parentRelationship: null, + ...overrides, + }; +} + +/** + * Creates a mock `ShippingOption` with sensible defaults. + */ +export function createShippingOption( + overrides?: Partial, +): ShippingOption { + return { + type: 'shipping' as const, + handle: 'mock-shipping-option', + title: 'Mock Shipping', + code: 'MOCK', + metafields: [], + carrier: {}, + cost: createMoney(), + costAfterDiscounts: createMoney(), + deliveryEstimate: {}, + ...overrides, + }; +} + +type PickupLocation = PickupLocationOption['location']; + +/** + * Creates a mock pickup `Location` object with sensible defaults. + */ +export function createPickupLocation( + overrides?: Partial, +): PickupLocation { + return { + name: 'Mock Pickup', + address: {countryCode: 'US' as const}, + ...overrides, + }; +} + +/** + * Creates a mock `PickupLocationOption` with sensible defaults. + */ +export function createPickupLocationOption( + overrides?: Partial, +): PickupLocationOption { + return { + type: 'pickup' as const, + handle: 'mock-pickup-location', + code: 'MOCK', + metafields: [], + location: createPickupLocation(), + ...overrides, + }; +} + +/** + * Creates a mock `Storage` instance. + * + * Optionally accepts a `Record` of initial entries. + */ +export function createStorage( + initialEntries?: Record, +): Storage { + const store: Record = {...initialEntries}; + return { + read: async (key: string) => + (store[key] as T | undefined) ?? null, + write: async (key: string, data: unknown) => { + store[key] = data; + }, + delete: async (key: string) => { + delete store[key]; + }, + }; +} + +/** + * Maps each checkout mutation API name to its result type, + * derived from the actual API method signatures. + */ +export interface CheckoutMutationResults { + applyAttributeChange: Awaited< + ReturnType + >; + applyCartLinesChange: Awaited< + ReturnType + >; + applyDiscountCodeChange: Awaited< + ReturnType + >; + applyGiftCardChange: Awaited>; + applyMetafieldChange: Awaited< + ReturnType + >; + applyNoteChange: Awaited>; + applyTrackingConsentChange: Awaited< + ReturnType['applyTrackingConsentChange']> + >; + applyPaymentMethodAttributesChange: Awaited< + ReturnType + >; + applyRedeemableChange: Awaited< + ReturnType + >; +} + +const checkoutMutationDefaults: { + [K in keyof CheckoutMutationResults]: () => CheckoutMutationResults[K]; +} = { + applyAttributeChange: () => ({type: 'success'}), + applyCartLinesChange: () => ({type: 'success'}), + applyDiscountCodeChange: () => ({type: 'success'}), + applyGiftCardChange: () => ({type: 'success'}), + applyMetafieldChange: () => ({type: 'success'}), + applyNoteChange: () => ({type: 'success'}), + applyTrackingConsentChange: () => ({type: 'success'}), + applyPaymentMethodAttributesChange: () => ({type: 'success'}), + applyRedeemableChange: () => ({type: 'success'}), +}; + +/** + * Creates a typed mock result for a checkout mutation API. + * + * @param mutation - The mutation API name (e.g. `'applyMetafieldChange'`). + * @param result - Optional partial override merged with the default. + * + * @example + * createResult('applyMetafieldChange'); + * createResult('applyCartLinesChange', {type: 'error', message: 'out of stock'}); + */ +export function createResult( + mutation: K, + result?: Partial, +): CheckoutMutationResults[K] { + return {...checkoutMutationDefaults[mutation](), ...result}; +} diff --git a/packages/ui-extensions-tester/src/customer-account/README.md b/packages/ui-extensions-tester/src/customer-account/README.md new file mode 100644 index 0000000000..9f67026073 --- /dev/null +++ b/packages/ui-extensions-tester/src/customer-account/README.md @@ -0,0 +1,86 @@ +# 🛂 Customer Account helpers + +Surface-specific helpers for testing customer account UI extensions. Import from `@shopify/ui-extensions-tester/customer-account`. + +```ts +import { + createCartLine, + createStorage, + createResult, +} from '@shopify/ui-extensions-tester/customer-account'; +``` + +## 🛒 Mocking cart lines + +Use `createCartLine()` to build order line item data for order status targets: + +```ts +import {createCartLine} from '@shopify/ui-extensions-tester/customer-account'; + +extension.shopify.lines.value = [ + createCartLine({quantity: 3}), + createCartLine({ + id: 'gid://shopify/CartLine/2', + merchandise: { + type: 'variant', + id: 'gid://shopify/ProductVariant/7', + title: 'Blue Shirt', + selectedOptions: [], + product: { + id: 'gid://shopify/Product/3', + vendor: 'Apparel Co', + productType: 'shirt', + }, + requiresShipping: true, + }, + }), +]; +``` + +## 💾 Mocking storage + +```ts +import {createStorage} from '@shopify/ui-extensions-tester/customer-account'; + +extension.shopify.storage = createStorage({ + alreadyRequestedReturn: true, +}); +``` + +## 🔒 Mocking mutation return values + +```ts +import {createResult} from '@shopify/ui-extensions-tester/customer-account'; + +extension.shopify.applyTrackingConsentChange = vi + .fn() + .mockResolvedValue( + createResult('applyTrackingConsentChange', { + type: 'success', + }), + ); +``` + +## 📂 Example + +See the [customer account example](../../../../examples/testing/customer-account-testing-example) for a fully working extension with a test suite. + +## 📖 API reference + +### `createCartLine(overrides?)` + +Creates a mock `CartLine` with sensible defaults. Pass a partial override to customize any field. + +### `createStorage(initialEntries?)` + +Creates a mock `Storage` instance. Optionally accepts a `Record` of initial entries. + +### `createResult(mutation, result?)` + +Creates a typed mock result for a customer account mutation API. The `mutation` argument is strongly typed to only accept known mutation names. + +Supported mutations: + +| Mutation | Default | +| ------------------------------ | ------------------- | +| `'applyTrackingConsentChange'` | `{type: 'success'}` | diff --git a/packages/ui-extensions-tester/src/customer-account/factories.ts b/packages/ui-extensions-tester/src/customer-account/factories.ts new file mode 100644 index 0000000000..4e9050d66d --- /dev/null +++ b/packages/ui-extensions-tester/src/customer-account/factories.ts @@ -0,0 +1,272 @@ +import type { + ApiForExtension, + AppliedGiftCard, + AuthenticationState, + ExtensionTarget, + StandardApi, + TrackingConsentMetafield, + Language, + Attribute, + CartDiscountAllocation, + CartDiscountCode, + AppMetafieldEntry, +} from '@shopify/ui-extensions/customer-account'; +import {createSubscribableSignalLike} from '../mocks/signals'; +import {createMockI18n} from '../mocks/i18n'; +import {createMoney} from '../mocks/money'; +import {API_VERSION} from '../api-version'; +import {createCartLine, createStorage, createResult} from './index'; + +// --------------------------------------------------------------------------- +// Derived types — not exported from the customer-account surface barrel +// --------------------------------------------------------------------------- + +type Intents = StandardApi['intents']; +type IntentActivity = Awaited>; +type IntentResponse = Awaited; + +function createLanguage(): Language { + return {isoCode: 'en'}; +} + +function createStandardApiProperties(target: T) { + return { + extensionPoint: target, + extension: { + apiVersion: API_VERSION as any, + capabilities: createSubscribableSignalLike([]), + rendered: createSubscribableSignalLike(true), + scriptUrl: 'https://mock-extension.test/index.js', + target, + }, + authenticatedAccount: { + purchasingCompany: createSubscribableSignalLike(undefined), + customer: createSubscribableSignalLike(undefined), + }, + version: '0.0.0' as const, + localization: { + language: createSubscribableSignalLike(createLanguage()), + extensionLanguage: createSubscribableSignalLike(createLanguage()), + country: createSubscribableSignalLike(undefined), + }, + i18n: createMockI18n(), + storage: createStorage(), + sessionToken: {get: async () => 'mock-session-token'}, + analytics: { + publish: async () => true, + visitor: async () => ({type: 'success' as const}), + }, + intents: { + invoke: async () => ({ + complete: Promise.resolve({code: 'closed'} as IntentResponse), + }), + }, + settings: createSubscribableSignalLike({}), + toast: {show: async () => ({hide: () => {}})}, + query: async () => ({data: undefined}), + customerPrivacy: createSubscribableSignalLike({ + allowedProcessing: { + analytics: true, + marketing: true, + preferences: true, + saleOfData: true, + }, + metafields: [] as TrackingConsentMetafield[], + visitorConsent: {}, + shouldShowBanner: false, + saleOfDataRegion: false, + }), + applyTrackingConsentChange: async () => + createResult('applyTrackingConsentChange'), + }; +} + +function createOrderStatusAndStandardApiProperties( + target: T, +) { + return { + ...createStandardApiProperties(target), + appliedGiftCards: createSubscribableSignalLike([] as AppliedGiftCard[]), + appMetafields: createSubscribableSignalLike([] as AppMetafieldEntry[]), + attributes: createSubscribableSignalLike( + undefined as Attribute[] | undefined, + ), + checkoutSettings: createSubscribableSignalLike({ + orderSubmission: 'ORDER' as const, + shippingAddress: {isEditable: true}, + }), + cost: { + subtotalAmount: createSubscribableSignalLike(createMoney()), + totalShippingAmount: createSubscribableSignalLike(undefined), + totalTaxAmount: createSubscribableSignalLike(undefined), + totalAmount: createSubscribableSignalLike(createMoney()), + }, + discountCodes: createSubscribableSignalLike([] as CartDiscountCode[]), + discountAllocations: createSubscribableSignalLike( + [] as CartDiscountAllocation[], + ), + lines: createSubscribableSignalLike([createCartLine()]), + localization: { + currency: createSubscribableSignalLike({isoCode: 'USD' as const}), + timezone: createSubscribableSignalLike('America/New_York' as const), + language: createSubscribableSignalLike(createLanguage()), + extensionLanguage: createSubscribableSignalLike(createLanguage()), + country: createSubscribableSignalLike(undefined), + market: createSubscribableSignalLike(undefined), + }, + note: createSubscribableSignalLike(undefined as string | undefined), + order: createSubscribableSignalLike({ + id: 'gid://shopify/Order/1', + name: '#1000', + }), + checkoutToken: createSubscribableSignalLike(undefined), + shop: { + id: 'gid://shopify/Shop/1', + name: 'Mock Shop', + storefrontUrl: 'https://mock-shop.myshopify.com', + myshopifyDomain: 'mock-shop.myshopify.com', + }, + requireLogin: async () => {}, + authenticationState: createSubscribableSignalLike( + 'fully_authenticated' as AuthenticationState, + ), + }; +} + +// --------------------------------------------------------------------------- +// Group factory functions +// --------------------------------------------------------------------------- + +// Group C: CartLineItemApi + OrderStatusApi + StandardApi +function createGroupC(target: T) { + return { + ...createOrderStatusAndStandardApiProperties(target), + target: createSubscribableSignalLike(createCartLine()), + }; +} + +// Group D: OrderStatusApi + StandardApi + ReturnApi +function createGroupD(target: T) { + return { + ...createOrderStatusAndStandardApiProperties(target), + returnId: 'gid://shopify/Return/1', + }; +} + +// Group E: OrderStatusApi + StandardApi + FulfillmentApi +function createGroupE(target: T) { + return { + ...createOrderStatusAndStandardApiProperties(target), + fulfillmentId: 'gid://shopify/Fulfillment/1', + }; +} + +// Group F: StandardApi + CompanyLocationApi +function createGroupF(target: T) { + return { + ...createStandardApiProperties(target), + locationId: 'gid://shopify/CompanyLocation/1', + }; +} + +// Group G: StandardApi + OrderApi +function createGroupG(target: T) { + return { + ...createStandardApiProperties(target), + orderId: 'gid://shopify/Order/1', + }; +} + +// Group H: StandardApi + ActionExtensionApi + OrderApi +function createGroupH(target: T) { + return { + ...createStandardApiProperties(target), + close: () => {}, + orderId: 'gid://shopify/Order/1', + }; +} + +// --------------------------------------------------------------------------- +// Factory map — associates each target with the correct factory +// --------------------------------------------------------------------------- + +type CustomerAccountMockFactory = { + [K in ExtensionTarget]: (target: K) => ApiForExtension; +}; + +const customerAccountMockFactories: CustomerAccountMockFactory = { + // StandardApi only + 'customer-account.page.render': createStandardApiProperties, + 'customer-account.order-index.block.render': createStandardApiProperties, + 'customer-account.order-index.announcement.render': + createStandardApiProperties, + 'customer-account.profile.block.render': createStandardApiProperties, + 'customer-account.profile.announcement.render': createStandardApiProperties, + 'customer-account.profile.addresses.render-after': + createStandardApiProperties, + 'customer-account.footer.render-after': createStandardApiProperties, + 'customer-account.profile.payment.render-after': createStandardApiProperties, + 'customer-account.profile.company-details.render-after': + createStandardApiProperties, + + // OrderStatusApi + StandardApi + 'customer-account.order-status.block.render': + createOrderStatusAndStandardApiProperties, + 'customer-account.order-status.announcement.render': + createOrderStatusAndStandardApiProperties, + 'customer-account.order-status.cart-line-list.render-after': + createOrderStatusAndStandardApiProperties, + 'customer-account.order-status.unfulfilled-items.render-after': + createOrderStatusAndStandardApiProperties, + 'customer-account.order-status.payment-details.render-after': + createOrderStatusAndStandardApiProperties, + 'customer-account.order-status.customer-information.render-after': ( + _target, + ) => + createOrderStatusAndStandardApiProperties( + 'customer-account.order-status.cart-line-list.render-after', + ), + 'customer-account.order.page.render': + createOrderStatusAndStandardApiProperties, + + // Group C: CartLineItemApi + OrderStatusApi + StandardApi + 'customer-account.order-status.cart-line-item.render-after': createGroupC, + + // Group D: OrderStatusApi + StandardApi + ReturnApi + 'customer-account.order-status.return-details.render-after': createGroupD, + + // Group E: OrderStatusApi + StandardApi + FulfillmentApi + 'customer-account.order-status.fulfillment-details.render-after': + createGroupE, + + // Group F: StandardApi + CompanyLocationApi + 'customer-account.profile.company-location-addresses.render-after': + createGroupF, + 'customer-account.profile.company-location-payment.render-after': + createGroupF, + 'customer-account.profile.company-location-staff.render-after': createGroupF, + + // Group G: StandardApi + OrderApi + 'customer-account.order.action.menu-item.render': createGroupG, + + // Group H: StandardApi + ActionExtensionApi + OrderApi + 'customer-account.order.action.render': createGroupH, +}; + +/** + * Creates a complete mock API for a customer account extension target. + * Each entry in the factory map is type-checked by TypeScript against + * the concrete `ApiForExtension` for that target. + */ +export function createMockCustomerAccountTargetApi( + target: T, +): ApiForExtension { + const factory = customerAccountMockFactories[target]; + if (!factory) { + throw new Error( + `Unsupported customer-account target: "${target}". ` + + 'Add an entry for this target in customerAccountMockFactories.', + ); + } + return factory(target); +} diff --git a/packages/ui-extensions-tester/src/customer-account/index.ts b/packages/ui-extensions-tester/src/customer-account/index.ts new file mode 100644 index 0000000000..9173d6bed3 --- /dev/null +++ b/packages/ui-extensions-tester/src/customer-account/index.ts @@ -0,0 +1,90 @@ +import type { + CartLine, + Storage, + Attribute, + CartDiscountAllocation, + StandardApi, +} from '@shopify/ui-extensions/customer-account'; +import {createMoney} from '../mocks/money'; + +/** + * Creates a mock `CartLine` with sensible defaults. + * + * Pass a partial override to customize any field. + */ +export function createCartLine(overrides?: Partial): CartLine { + return { + id: 'gid://shopify/CartLine/1', + merchandise: { + type: 'variant' as const, + id: 'gid://shopify/ProductVariant/1', + title: 'Mock Variant', + selectedOptions: [], + product: { + id: 'gid://shopify/Product/1', + vendor: 'Mock Vendor', + productType: '', + }, + requiresShipping: true, + }, + quantity: 1, + cost: {totalAmount: createMoney()}, + attributes: [] as Attribute[], + discountAllocations: [] as CartDiscountAllocation[], + lineComponents: [] as CartLine['lineComponents'], + ...overrides, + }; +} + +/** + * Creates a mock `Storage` instance. + * + * Optionally accepts a `Record` of initial entries. + */ +export function createStorage( + initialEntries?: Record, +): Storage { + const store: Record = {...initialEntries}; + return { + read: async (key: string) => + (store[key] as T | undefined) ?? null, + write: async (key: string, data: unknown) => { + store[key] = data; + }, + delete: async (key: string) => { + delete store[key]; + }, + }; +} + +/** + * Maps each customer account mutation API name to its result type. + */ +export interface CustomerAccountMutationResults { + applyTrackingConsentChange: Awaited< + ReturnType + >; +} + +/** + * Creates a typed mock result for a customer account mutation API. + * + * @param mutation - The mutation API name (e.g. `'applyTrackingConsentChange'`). + * @param result - Optional partial override merged with the default. + * + * @example + * createResult('applyTrackingConsentChange'); + * createResult('applyTrackingConsentChange', {type: 'error', message: 'denied'}); + */ +const customerAccountMutationDefaults: { + [K in keyof CustomerAccountMutationResults]: () => CustomerAccountMutationResults[K]; +} = { + applyTrackingConsentChange: () => ({type: 'success'}), +}; + +export function createResult( + mutation: K, + result?: Partial, +): CustomerAccountMutationResults[K] { + return {...customerAccountMutationDefaults[mutation](), ...result}; +} diff --git a/packages/ui-extensions-tester/src/disposable.d.ts b/packages/ui-extensions-tester/src/disposable.d.ts new file mode 100644 index 0000000000..e69b2196fe --- /dev/null +++ b/packages/ui-extensions-tester/src/disposable.d.ts @@ -0,0 +1,20 @@ +/** + * Polyfill type declarations for the Explicit Resource Management proposal + * (https://github.com/tc39/proposal-explicit-resource-management). + * + * TypeScript >= 5.2 ships these in `lib.esnext.disposable.d.ts`. + * For older versions we declare them here so that consumers can write + * `using extension = setUpExtension(...)` with full type safety. + * + * These declarations are additive — if `Symbol.dispose` already exists + * in the type system (TS >= 5.2 with `lib: ["esnext"]`), the interfaces + * merge harmlessly. + */ + +interface SymbolConstructor { + readonly dispose: unique symbol; +} + +interface Disposable { + [Symbol.dispose](): void; +} diff --git a/packages/ui-extensions-tester/src/fetch-polyfills.ts b/packages/ui-extensions-tester/src/fetch-polyfills.ts new file mode 100644 index 0000000000..cbfe12c61d --- /dev/null +++ b/packages/ui-extensions-tester/src/fetch-polyfills.ts @@ -0,0 +1,222 @@ +/** + * Minimal polyfills for the standard `Request` and `Response` classes. + * + * Jest 27's test environments (both `jsdom` and `node`) do not forward the + * fetch-API globals that Node 18+ provides. These polyfills are installed + * on `globalThis` during `setUp()` so that both the tester's own code and + * user test code can use `new Request()` / `new Response()`. + */ + +function notImplemented(name: string): never { + throw new Error( + `${name}() is not implemented by the @shopify/ui-extensions-tester polyfill.`, + ); +} + +class BodyBase { + readonly bodyUsed: boolean = false; + protected _body: string; + + constructor(body?: BodyInit | null) { + this._body = body == null ? '' : String(body); + } + + get body(): Response['body'] { + return null; + } + + async arrayBuffer(): Promise { + const encoder = new TextEncoder(); + return encoder.encode(this._body).buffer as ArrayBuffer; + } + + async blob(): Promise { + return notImplemented('blob'); + } + + // The return type uses `any` to bridge TS 4.x (where Uint8Array is not + // generic) and TS 5.7+ (where Body.bytes() returns Promise>). + async bytes(): Promise { + const encoder = new TextEncoder(); + return encoder.encode(this._body); + } + + async formData(): Promise { + return notImplemented('formData'); + } + + async json(): Promise { + return JSON.parse(this._body); + } + + async text(): Promise { + return this._body; + } +} + +class ResponsePolyfill extends BodyBase implements Response { + static error(): Response { + return new ResponsePolyfill(null, {status: 0, statusText: ''}); + } + + static redirect(url: string | URL, status = 302): Response { + const res = new ResponsePolyfill(null, {status, statusText: ''}); + (res as {url: string}).url = String(url); + (res as {redirected: boolean}).redirected = true; + return res; + } + + static json(data: unknown, init?: ResponseInit): Response { + const body = JSON.stringify(data); + const headers = new Headers(init?.headers); + if (!headers.has('content-type')) { + headers.set('content-type', 'application/json'); + } + return new ResponsePolyfill(body, {...init, headers}); + } + + readonly headers: Headers; + readonly ok: boolean; + readonly redirected: boolean = false; + readonly status: number; + readonly statusText: string; + readonly type: ResponseType = 'basic'; + readonly url: string = ''; + + constructor(body?: BodyInit | null, init?: ResponseInit) { + super(body); + this.status = init?.status ?? 200; + this.statusText = init?.statusText ?? ''; + this.ok = this.status >= 200 && this.status < 300; + this.headers = new Headers(init?.headers); + } + + clone(): Response { + return new ResponsePolyfill(this._body, { + status: this.status, + statusText: this.statusText, + headers: this.headers, + }); + } +} + +class RequestPolyfill extends BodyBase implements Request { + readonly cache: RequestCache = 'default'; + readonly credentials: RequestCredentials = 'same-origin'; + readonly destination: RequestDestination = '' as RequestDestination; + readonly headers: Headers; + readonly integrity: string = ''; + readonly keepalive: boolean = false; + readonly method: string; + readonly mode: RequestMode = 'cors'; + readonly redirect: RequestRedirect = 'follow'; + readonly referrer: string = 'about:client'; + readonly referrerPolicy: ReferrerPolicy = ''; + readonly signal: AbortSignal = + typeof AbortController === 'undefined' + ? (undefined as any) + : new AbortController().signal; + + readonly url: string; + + constructor(input: RequestInfo | URL, init?: RequestInit) { + super(init?.body); + if (typeof input === 'string') { + this.url = input; + } else if (input instanceof URL) { + this.url = input.href; + } else { + // input is a Request-like object + this.url = input.url; + } + + this.method = (init?.method ?? 'GET').toUpperCase(); + this.headers = new Headers(init?.headers); + + if (init?.cache !== undefined) + (this as {cache: RequestCache}).cache = init.cache; + if (init?.credentials !== undefined) + (this as {credentials: RequestCredentials}).credentials = + init.credentials; + if (init?.integrity !== undefined) + (this as {integrity: string}).integrity = init.integrity; + if (init?.keepalive !== undefined) + (this as {keepalive: boolean}).keepalive = init.keepalive; + if (init?.mode !== undefined) + (this as {mode: RequestMode}).mode = init.mode; + if (init?.redirect !== undefined) + (this as {redirect: RequestRedirect}).redirect = init.redirect; + if (init?.referrer !== undefined) + (this as {referrer: string}).referrer = init.referrer; + if (init?.referrerPolicy !== undefined) + (this as {referrerPolicy: ReferrerPolicy}).referrerPolicy = + init.referrerPolicy; + if (init?.signal !== undefined && init.signal !== null) + (this as {signal: AbortSignal}).signal = init.signal; + } + + clone(): Request { + return new RequestPolyfill(this.url, { + method: this.method, + headers: this.headers, + body: this._body || undefined, + cache: this.cache, + credentials: this.credentials, + integrity: this.integrity, + keepalive: this.keepalive, + mode: this.mode, + redirect: this.redirect, + referrer: this.referrer, + referrerPolicy: this.referrerPolicy, + }); + } +} + +const POLYFILLED = Symbol.for('ui-extensions-tester:fetch-polyfilled'); + +interface PolyfillRecord { + Response?: boolean; + Request?: boolean; +} + +/** + * Installs `Response` and `Request` on `globalThis` when they are missing. + * Call from `setUp()`. + */ +export function installFetchPolyfills(): void { + const record: PolyfillRecord = (globalThis as any)[POLYFILLED] ?? {}; + + if (typeof globalThis.Response === 'undefined') { + (globalThis as any).Response = ResponsePolyfill; + record.Response = true; + } else { + record.Response = false; + } + + if (typeof globalThis.Request === 'undefined') { + (globalThis as any).Request = RequestPolyfill; + record.Request = true; + } else { + record.Request = false; + } + + (globalThis as any)[POLYFILLED] = record; +} + +/** + * Removes only the polyfills that `installFetchPolyfills` added. + * Call from `tearDown()`. + */ +export function uninstallFetchPolyfills(): void { + const record: PolyfillRecord = (globalThis as any)[POLYFILLED] ?? {}; + + if (record.Response) { + delete (globalThis as any).Response; + } + + if (record.Request) { + delete (globalThis as any).Request; + } + + delete (globalThis as any)[POLYFILLED]; +} diff --git a/packages/ui-extensions-tester/src/index.ts b/packages/ui-extensions-tester/src/index.ts new file mode 100644 index 0000000000..5b999d8e4a --- /dev/null +++ b/packages/ui-extensions-tester/src/index.ts @@ -0,0 +1,621 @@ +import * as fs from 'fs'; +import * as path from 'path'; + +import type { + AnyExtensionTarget, + ApiForTarget, + EventMapForTarget, +} from './targets'; +import {isCheckoutTarget} from './targets'; +import {createMockTargetApi} from './mocks/target-apis'; +import {createMockNavigation, type Navigation} from './navigation'; +import {API_VERSION} from './api-version'; +import { + installFetchPolyfills, + uninstallFetchPolyfills, +} from './fetch-polyfills'; + +export type {AnyExtensionTarget, ApiForTarget} from './targets'; +export {createNavigationHistoryEntry} from './navigation'; +export type { + Navigation, + NavigationHistoryEntry, + NavigationNavigateOptions, +} from './navigation'; + +/** + * Makes all properties in the API deeply mutable so tests can + * override any value through the `extension.shopify` proxy: + * + * extension.shopify.cart.current.value = createPosCart({lineItems: [...]}); + * extension.shopify.i18n.translate = (key) => myTranslations[key]; + */ +type Mutable = T extends (...args: any[]) => any + ? T + : T extends object + ? {-readonly [K in keyof T]: Mutable} + : T; + +/** + * `Symbol.dispose` for runtimes that support it, with a polyfill + * fallback so the library works on older Node versions too. + */ +export const SymbolDispose: typeof Symbol.dispose = ((Symbol as any).dispose ?? + Symbol.for('Symbol.dispose')) as typeof Symbol.dispose; + +/** + * Members shared by both {@link ExtensionHarness} (returned by + * `getExtension`) and {@link DisposableExtensionHarness} (returned + * by `setUpExtension`). + */ +interface BaseExtensionHarness { + /** + * Imports and executes the extension module's default export, + * rendering the extension into `document.body`. + */ + render(): Promise; + + /** + * A mock `shopify` global, typed correctly for the target under test. + * + * You can mutate any property. Example: + * + * ```ts + * extension.shopify.cart.current.value = { lineItems: [...] }; + * ``` + */ + shopify: Mutable>; + + /** + * A mock `fetch()` function installed as `globalThis.fetch` during + * `setUp()`. + * + * Override it with a mock to control responses: + * + * ```ts + * extension.fetch = vi.fn().mockResolvedValue( + * new Response(JSON.stringify({ ok: true })), + * ); + * ``` + */ + fetch: typeof globalThis.fetch; + + /** + * A mock `navigation` object installed as `globalThis.navigation` + * during `setUp()`. + * + * Override its methods with mocks to control navigation behaviour: + * + * ```ts + * import { createNavigationHistoryEntry } from '@shopify/ui-extensions-tester'; + * extension.navigation.navigate = vi.fn(); + * extension.navigation.currentEntry = + * createNavigationHistoryEntry({ url: '/cart' }); + * ``` + */ + navigation: Navigation; + + /** + * Fires a host event at every listener registered via + * `shopify.addEventListener(name, listener)`. + * + * Matches the `shopify.addEventListener` contract: listener return values + * are ignored, and thrown errors are caught per-listener so one bad + * listener doesn't block the others. + * + * Pass the same payload shape that the host dispatches at runtime: + * + * ```ts + * shopify.addEventListener('transactioncomplete', (event) => { ... }); + * + * extension.dispatch('transactioncomplete', { + * transactionType: 'Sale', + * orderId: 1, + * grandTotal: { amount: 10, currency: 'USD' }, + * // ... + * }); + * ``` + */ + dispatch>( + type: K, + event: EventMapForTarget[K], + ): void; +} + +/** + * Returned by `getExtension`. The caller is responsible for calling + * `setUp()` before each test and `tearDown()` after. + */ +interface ExtensionHarness + extends BaseExtensionHarness { + /** + * Sets up an extension environment for testing. + * + * For example, it creates a mock `shopify` global with some defaults. + */ + setUp(): void; + + /** + * Tears down the extension environment. + * + * For example, it resets the `shopify` global and clears `document.body`. + */ + tearDown(): void; +} + +/** + * Returned by `setUpExtension`. Already set up — tears down + * automatically via `Symbol.dispose` (the `using` keyword): + * + * ```ts + * using extension = setUpExtension('purchase.checkout.block.render'); + * ``` + */ +interface DisposableExtensionHarness + extends BaseExtensionHarness { + [SymbolDispose](): void; +} + +class Extension implements ExtensionHarness { + #target: T; + #resolvedModule: string; + #modulePath: string; + #checkout: boolean; + #networkAccess: boolean; + #apiAccess: boolean; + + #fetchImpl!: typeof globalThis.fetch; + #previousFetch: typeof globalThis.fetch | undefined; + #navigationImpl: Navigation = createMockNavigation(); + #previousNavigation: any; + #eventListeners = new Map void>>(); + + constructor(target: T, options?: {configSearchDir?: string}) { + const configSearchDir = + options?.configSearchDir ?? path.dirname(getCallerFile()); + const tomlPath = findToml(configSearchDir); + const tomlDir = path.dirname(tomlPath); + const tomlContent = fs.readFileSync(tomlPath, 'utf-8'); + validateApiVersion(tomlContent); + const modulePath = parseTargetModule(tomlContent, target); + + this.#target = target; + this.#modulePath = modulePath; + this.#resolvedModule = path.resolve(tomlDir, modulePath); + this.#checkout = isCheckoutTarget(target); + this.#networkAccess = this.#checkout && parseNetworkAccess(tomlContent); + this.#apiAccess = this.#checkout && parseApiAccess(tomlContent); + } + + setUp(): void { + installFetchPolyfills(); + + this.#fetchImpl = + this.#checkout && !this.#networkAccess && !this.#apiAccess + ? async () => { + // Checkout is the only surface that currently enforces + // fetch capabilities. + throw new Error( + 'fetch() is not available. Add network_access = true or ' + + 'api_access = true to [extensions.capabilities] in shopify.extension.toml.', + ); + } + : async () => new Response(); + + this.#previousFetch = (globalThis as any).fetch; + this.#previousNavigation = (globalThis as any).navigation; + this.#navigationImpl = createMockNavigation(); + this.#eventListeners.clear(); + (globalThis as any).shopify = deepWritableProxy( + Object.assign(createMockTargetApi(this.#target), { + addEventListener: this.#addEventListener, + removeEventListener: this.#removeEventListener, + }), + ); + (globalThis as any).fetch = this.#fetchImpl; + (globalThis as any).navigation = this.#navigationImpl; + } + + #addEventListener = (type: string, listener: (event: any) => void): void => { + let set = this.#eventListeners.get(type); + if (!set) { + set = new Set(); + this.#eventListeners.set(type, set); + } + set.add(listener); + }; + + #removeEventListener = ( + type: string, + listener: (event: any) => void, + ): void => { + this.#eventListeners.get(type)?.delete(listener); + }; + + dispatch>( + type: K, + event: EventMapForTarget[K], + ): void { + const listeners = this.#eventListeners.get(type as string); + if (!listeners) return; + // Snapshot so listeners that register/unregister during dispatch + // don't mutate the iteration. + for (const listener of [...listeners]) { + try { + listener(event); + } catch { + // Fire-and-forget: per the shopify.addEventListener contract, + // listener errors must not affect other listeners. + } + } + } + + get shopify(): Mutable> { + if (!(globalThis as any).shopify) { + throw new Error( + 'You must call extension.setUp() before accessing extension.shopify.', + ); + } + return (globalThis as any).shopify; + } + + get fetch(): typeof globalThis.fetch { + return this.#fetchImpl; + } + + set fetch(fn: typeof globalThis.fetch) { + this.#fetchImpl = fn; + (globalThis as any).fetch = fn; + } + + get navigation() { + return this.#navigationImpl; + } + + set navigation(obj: any) { + this.#navigationImpl = obj; + (globalThis as any).navigation = obj; + } + + async render(): Promise { + const mod = await import(this.#resolvedModule); + const renderFn = mod.default; + if (typeof renderFn !== 'function') { + throw new Error( + `Expected default export of ${ + this.#modulePath + } to be a function, got ${typeof renderFn}`, + ); + } + await renderFn(); + } + + tearDown(): void { + // Dynamically import preact to unmount cleanly without requiring + // the test file to depend on preact directly. + try { + // eslint-disable-next-line @typescript-eslint/no-var-requires + const {render} = require('preact'); + render(null, document.body); + } catch { + // Fallback if preact isn't available + document.body.innerHTML = ''; + } + delete (globalThis as any).shopify; + this.#eventListeners.clear(); + if (this.#previousFetch === undefined) { + delete (globalThis as any).fetch; + } else { + (globalThis as any).fetch = this.#previousFetch; + } + if (this.#previousNavigation === undefined) { + delete (globalThis as any).navigation; + } else { + (globalThis as any).navigation = this.#previousNavigation; + } + uninstallFetchPolyfills(); + } +} + +const extensionCache = new Map>(); + +/** + * Returns an extension test harness for the given target. + * + * It reads `shopify.extension.toml`, finds the module for the given target, + * and provides helpers to mock the environment and render the extension. + * + * It locates `shopify.extension.toml` by walking up from the calling + * test file's directory, and falls back to searching `extensions/` + * under the current working directory. + * + * @param target - The extension target to mock. + * @param options - Optional configuration. + * @param options.configSearchDir - Directory containing (or a parent of) + * `shopify.extension.toml`. Defaults to the calling test file's directory. + */ +export function getExtension( + target: T, + options?: {configSearchDir?: string}, +): ExtensionHarness { + const resolvedConfigSearchDir = + options?.configSearchDir ?? path.dirname(getCallerFile()); + const tomlPath = findToml(resolvedConfigSearchDir); + const tomlMtimeMs = fs.statSync(tomlPath).mtimeMs; + const cacheKey = JSON.stringify([target, tomlPath, tomlMtimeMs]); + + const cached = extensionCache.get(cacheKey); + if (cached) { + return cached as Extension; + } + + const ext = new Extension(target, { + configSearchDir: resolvedConfigSearchDir, + }); + extensionCache.set(cacheKey, ext); + return ext; +} + +/** + * Sets up an extension for testing and returns a disposable object + * that supports automatic teardown with the `using` keyword: + * + * ```ts + * test('rendering the extension', async () => { + * using extension = setUpExtension( + * 'purchase.checkout.block.render', + * ); + * await extension.render(); + * // tearDown() is called automatically at the end of the block + * }); + * ``` + * + * @param target - The extension target to mock. + * @param options - Optional configuration (same as {@link getExtension}). + */ +export function setUpExtension( + target: T, + options?: {configSearchDir?: string}, +): DisposableExtensionHarness { + const extension = getExtension(target, options); + extension.setUp(); + + return Object.assign(extension, { + [SymbolDispose]: () => extension.tearDown(), + }) as DisposableExtensionHarness; +} + +function validateApiVersion(toml: string): void { + const match = toml.match(/^\s*api_version\s*=\s*"([^"]+)"/m); + const tomlVersion = match?.[1]; + if (tomlVersion !== API_VERSION) { + throw new Error( + `api_version "${tomlVersion ?? '(not found)'}" does not match ` + + `the version supported by @shopify/ui-extensions-tester ("${API_VERSION}"). ` + + `Update api_version in shopify.extension.toml or install the matching tester version.`, + ); + } +} + +function parseCapability(toml: string, key: string): boolean { + const lines = toml.split('\n'); + let inCapabilities = false; + const pattern = new RegExp(`^${key}\\s*=\\s*(.+)`); + + for (const line of lines) { + const trimmed = line.trim(); + + if (trimmed === '[extensions.capabilities]') { + inCapabilities = true; + continue; + } + + // A new section header ends the capabilities block + if (trimmed.startsWith('[')) { + inCapabilities = false; + continue; + } + + if (inCapabilities) { + const match = trimmed.match(pattern); + if (match) { + return match[1]!.trim() === 'true'; + } + } + } + + return false; +} + +function parseNetworkAccess(toml: string): boolean { + return parseCapability(toml, 'network_access'); +} + +function parseApiAccess(toml: string): boolean { + return parseCapability(toml, 'api_access'); +} + +// Resolve the path of this module from a stack trace at load time. +// This works in both CJS (__filename available) and ESM (where __filename +// is not defined) without relying on import.meta.url. +function getCurrentFilePath(): string { + const originalPrepare = Error.prepareStackTrace; + try { + let filePath = ''; + Error.prepareStackTrace = (_err, stack) => { + filePath = stack[0]?.getFileName() ?? ''; + }; + // eslint-disable-next-line @babel/no-unused-expressions + new Error().stack; + return filePath; + } finally { + Error.prepareStackTrace = originalPrepare; + } +} + +// Resolved at module load time so the stack frame reliably points to this +// file, even if a bundler inlines or merges modules later. +const thisPackageFilePath = getCurrentFilePath(); + +function getCallerFile(): string { + const originalPrepare = Error.prepareStackTrace; + try { + const err = new Error(); + let callerFile = ''; + + Error.prepareStackTrace = (_err, stack) => { + // Walk the stack, skipping all frames that originate from this + // package file. This works regardless of whether the caller is + // getExtension() or setUpExtension() → getExtension(). + for (let i = 1; i < stack.length; i++) { + const fileName = stack[i]!.getFileName(); + if (fileName && fileName !== thisPackageFilePath) { + callerFile = fileName; + break; + } + } + }; + + // Trigger stack trace preparation + // eslint-disable-next-line @babel/no-unused-expressions + err.stack; + + if (!callerFile) { + throw new Error('Could not determine caller file from stack trace'); + } + + // Handle file:// URLs (ESM) + if (callerFile.startsWith('file://')) { + return new URL(callerFile).pathname; + } + + return callerFile; + } finally { + Error.prepareStackTrace = originalPrepare; + } +} + +function findToml(startDir: string): string { + // First, walk up from the start directory looking for shopify.extension.toml + let dir = startDir; + const root = path.parse(dir).root; + + while (dir !== root) { + const candidate = path.join(dir, 'shopify.extension.toml'); + if (fs.existsSync(candidate)) { + return candidate; + } + dir = path.dirname(dir); + } + + // If not found walking up, search from cwd (project root) in extensions/*/ + const cwd = process.cwd(); + const extensionsDir = path.join(cwd, 'extensions'); + if (fs.existsSync(extensionsDir)) { + const entries = fs.readdirSync(extensionsDir, {withFileTypes: true}); + for (const entry of entries) { + if (entry.isDirectory()) { + const candidate = path.join( + extensionsDir, + entry.name, + 'shopify.extension.toml', + ); + if (fs.existsSync(candidate)) { + return candidate; + } + } + } + } + + throw new Error( + `Could not find shopify.extension.toml in any parent directory of ${startDir} or in extensions/ under ${cwd}`, + ); +} + +function parseTargetModule(toml: string, target: string): string { + // Simple TOML parser for [[extensions.targeting]] sections. + // Looks for blocks with matching target and extracts the module. + const lines = toml.split('\n'); + let inTargeting = false; + let currentTarget = ''; + let currentModule = ''; + + for (const line of lines) { + const trimmed = line.trim(); + + if (trimmed === '[[extensions.targeting]]') { + // Save previous block if it matched + if (inTargeting && currentTarget === target && currentModule) { + return currentModule; + } + inTargeting = true; + currentTarget = ''; + currentModule = ''; + continue; + } + + // A new section header ends the current targeting block + if (trimmed.startsWith('[') && trimmed !== '[[extensions.targeting]]') { + if (inTargeting && currentTarget === target && currentModule) { + return currentModule; + } + inTargeting = false; + continue; + } + + if (inTargeting) { + const targetMatch = trimmed.match(/^target\s*=\s*"(.+)"/); + if (targetMatch) { + currentTarget = targetMatch[1]!; + } + const moduleMatch = trimmed.match(/^module\s*=\s*"(.+)"/); + if (moduleMatch) { + currentModule = moduleMatch[1]!; + } + } + } + + // Check last block + if (inTargeting && currentTarget === target && currentModule) { + return currentModule; + } + + throw new Error( + `Could not find target "${target}" in shopify.extension.toml`, + ); +} + +/** + * Creates a recursive proxy that makes all properties writable. + * For nested objects, returns another proxy so that deep assignments + * like `extension.shopify.cart.current.value = ...` work. + */ +function deepWritableProxy(obj: any): any { + if (obj == null || typeof obj !== 'object') return obj; + + function assertExists(target: any, prop: string | symbol) { + if (typeof prop !== 'symbol' && prop !== 'toJSON' && !(prop in target)) { + throw new Error( + `Property "${String( + prop, + )}" does not exist on the shopify API for this target.`, + ); + } + } + + return new Proxy(obj, { + get(target: any, prop: string | symbol) { + assertExists(target, prop); + const val = target[prop]; + if (val != null && typeof val === 'object' && !Array.isArray(val)) { + return deepWritableProxy(val); + } + return val; + }, + set(target: any, prop: string | symbol, newValue: any) { + assertExists(target, prop); + target[prop] = newValue; + return true; + }, + }); +} diff --git a/packages/ui-extensions-tester/src/mocks/i18n.ts b/packages/ui-extensions-tester/src/mocks/i18n.ts new file mode 100644 index 0000000000..af60d47bc9 --- /dev/null +++ b/packages/ui-extensions-tester/src/mocks/i18n.ts @@ -0,0 +1,15 @@ +/** + * Shared mock `i18n` object used by all surfaces. + * + * - `formatNumber` / `formatCurrency` stringify the number. + * - `formatDate` returns the ISO string. + * - `translate` echoes the translation key. + */ +export function createMockI18n() { + return { + formatNumber: (number: number | bigint) => String(number), + formatCurrency: (number: number | bigint) => String(number), + formatDate: (date: Date) => date.toISOString(), + translate: ((key: string) => key) as any, + }; +} diff --git a/packages/ui-extensions-tester/src/mocks/money.ts b/packages/ui-extensions-tester/src/mocks/money.ts new file mode 100644 index 0000000000..17d632fb31 --- /dev/null +++ b/packages/ui-extensions-tester/src/mocks/money.ts @@ -0,0 +1,7 @@ +/** + * Creates a mock money value with sensible defaults. + * Structurally compatible with the `Money` type from all surfaces. + */ +export function createMoney(): {amount: number; currencyCode: 'USD'} { + return {amount: 0, currencyCode: 'USD'}; +} diff --git a/packages/ui-extensions-tester/src/mocks/signals.ts b/packages/ui-extensions-tester/src/mocks/signals.ts new file mode 100644 index 0000000000..3d901fa4e8 --- /dev/null +++ b/packages/ui-extensions-tester/src/mocks/signals.ts @@ -0,0 +1,37 @@ +import type {SubscribableSignalLike} from '@shopify/ui-extensions/checkout'; + +/** + * Creates a mock `SubscribableSignalLike` that wraps a static value. + * The `subscribe` callback is never invoked since test values are static. + */ +export function createSubscribableSignalLike( + value: T, +): SubscribableSignalLike { + return { + value, + current: value, + subscribe: () => () => {}, + destroy: async () => {}, + }; +} + +/** + * A minimal read-only signal for surfaces (like POS) that use + * `ReadonlySignalLike` instead of `SubscribableSignalLike`. + */ +export interface MockReadonlySignalLike { + readonly value: T; + subscribe(fn: (value: T) => void): () => void; +} + +/** + * Creates a mock `ReadonlySignalLike` that wraps a static value. + */ +export function createReadonlySignalLike( + value: T, +): MockReadonlySignalLike { + return { + value, + subscribe: () => () => {}, + }; +} diff --git a/packages/ui-extensions-tester/src/mocks/target-apis.ts b/packages/ui-extensions-tester/src/mocks/target-apis.ts new file mode 100644 index 0000000000..5c44170d89 --- /dev/null +++ b/packages/ui-extensions-tester/src/mocks/target-apis.ts @@ -0,0 +1,56 @@ +import type {ExtensionTarget as AdminExtensionTarget} from '@shopify/ui-extensions/admin'; +import type {ExtensionTarget as CheckoutExtensionTarget} from '@shopify/ui-extensions/checkout'; +import type {ExtensionTarget as CustomerAccountExtensionTarget} from '@shopify/ui-extensions/customer-account'; +import type {ExtensionTarget as PosExtensionTarget} from '@shopify/ui-extensions/point-of-sale'; +import type {AnyExtensionTarget, ApiForTarget} from '../targets'; +import { + isCheckoutTarget, + isCustomerAccountTarget, + isPosTarget, + isAdminTarget, +} from '../targets'; +import {createMockCheckoutTargetApi} from '../checkout/factories'; +import {createMockCustomerAccountTargetApi} from '../customer-account/factories'; +import {createMockPosTargetApi} from '../point-of-sale/factories'; +import { + createMockAdminTargetApi, + type ApiForAdminExtension, +} from '../admin/factories'; + +/** + * Returns the default mock API values for a given target. + */ +export function createMockTargetApi( + target: T, +): ApiForAdminExtension; +export function createMockTargetApi( + target: T, +): ApiForTarget; +export function createMockTargetApi( + target: T, +): ApiForTarget; +export function createMockTargetApi( + target: T, +): ApiForTarget; +export function createMockTargetApi(target: AnyExtensionTarget): never; +export function createMockTargetApi(target: AnyExtensionTarget): object { + let api: object; + if (isCheckoutTarget(target)) { + api = createMockCheckoutTargetApi(target); + } else if (isPosTarget(target)) { + api = createMockPosTargetApi(target); + } else if (isCustomerAccountTarget(target)) { + api = createMockCustomerAccountTargetApi(target); + } else if (isAdminTarget(target)) { + api = createMockAdminTargetApi(target); + } else { + throw new Error( + `Unsupported target: "${target}". No mock factory is available for this target.`, + ); + } + + // `@shopify/ui-extensions/preact` calls `shopify.setSignals()` as a + // side-effect when imported. Include a no-op so the proxy doesn't + // reject the access. + return Object.assign(api, {setSignals() {}}); +} diff --git a/packages/ui-extensions-tester/src/navigation.ts b/packages/ui-extensions-tester/src/navigation.ts new file mode 100644 index 0000000000..769c9a3249 --- /dev/null +++ b/packages/ui-extensions-tester/src/navigation.ts @@ -0,0 +1,72 @@ +import type { + Navigation, + NavigationHistoryEntry, +} from '@shopify/ui-extensions/customer-account'; + +export type { + Navigation, + NavigationHistoryEntry, + NavigationNavigateOptions, +} from '@shopify/ui-extensions/customer-account'; + +/** + * Options for {@link createNavigationHistoryEntry}. + */ +export interface CreateNavigationResultOptions { + /** The URL of the navigation history entry. Defaults to `''`. */ + url?: string; + /** The `key` of the navigation history entry. Defaults to `''`. */ + key?: string; + /** + * Developer-defined state stored in the entry, retrieved via + * `getState()`. Each call to `getState()` returns a structured + * clone, matching the real browser behaviour. + */ + state?: unknown; +} + +/** + * Creates a `NavigationHistoryEntry` suitable for mocking navigation + * values such as `navigation.currentEntry`. + * + * ```ts + * extension.navigation.currentEntry = + * createNavigationHistoryEntry({ + * url: '/cart', + * state: { items: 3 }, + * }); + * ``` + * + * @see https://developer.mozilla.org/en-US/docs/Web/API/NavigationHistoryEntry + */ +export function createNavigationHistoryEntry( + options?: CreateNavigationResultOptions, +): NavigationHistoryEntry { + const {url = '', key = '', state} = options ?? {}; + return { + url, + key, + getState() { + return state === undefined + ? undefined + : JSON.parse(JSON.stringify(state)); + }, + }; +} + +/** + * Creates a mock `Navigation` object matching the interface from + * `@shopify/ui-extensions/customer-account`. The default `navigate()` + * is a no-op; `currentEntry` starts as a blank entry. + * + * @see https://developer.mozilla.org/en-US/docs/Web/API/Navigation + */ +export function createMockNavigation(): Navigation { + return { + navigate: () => {}, + currentEntry: createNavigationHistoryEntry(), + updateCurrentEntry: () => {}, + addEventListener: () => {}, + removeEventListener: () => {}, + }; +} diff --git a/packages/ui-extensions-tester/src/point-of-sale/README.md b/packages/ui-extensions-tester/src/point-of-sale/README.md new file mode 100644 index 0000000000..a30a20cc41 --- /dev/null +++ b/packages/ui-extensions-tester/src/point-of-sale/README.md @@ -0,0 +1,100 @@ +# 🛍️ Point of Sale helpers + +Surface-specific helpers for testing point of sale (POS) UI extensions. Import from `@shopify/ui-extensions-tester/point-of-sale`. + +```ts +import { + createCartLineItem, + createStorage, + createResult, +} from '@shopify/ui-extensions-tester/point-of-sale'; +``` + +## 🛒 Mocking cart line items + +Use `createCartLineItem()` to build POS cart line data, then assign it to the cart mock: + +```ts +import {createCartLineItem} from '@shopify/ui-extensions-tester/point-of-sale'; + +extension.shopify.cart.current.value.lineItems = [ + createCartLineItem({ + title: 'Widget', + quantity: 3, + }), + createCartLineItem({ + title: 'Gadget', + quantity: 1, + }), +]; + +await extension.render(); + +const tile = + document.body.querySelector('s-tile')!; +expect(tile.getAttribute('subheading')).toEqual( + '4 item(s)', +); +``` + +## 💾 Mocking storage + +POS storage is a typed key-value store: + +```ts +import {createStorage} from '@shopify/ui-extensions-tester/point-of-sale'; + +extension.shopify.storage = createStorage({ + 'last-synced': '2026-01-01', +}); +``` + +## 🔒 Mocking mutation return values + +Replace mutation functions with `vi.fn()` and use `createResult()` to build typed return values. The first argument is the mutation name; the second is an optional result override. + +```ts +import { + createResult, + createCartLineItem, +} from '@shopify/ui-extensions-tester/point-of-sale'; + +extension.shopify.cart.bulkCartUpdate = vi + .fn() + .mockResolvedValue( + createResult('bulkCartUpdate', { + subtotal: '10.00', + taxTotal: '1.00', + grandTotal: '11.00', + cartDiscounts: [], + lineItems: [ + createCartLineItem({title: 'Widget'}), + ], + properties: {}, + }), + ); +``` + +## 📂 Example + +See the [point of sale example](../../../../examples/testing/point-of-sale-testing-example) for a fully working extension with a test suite. + +## 📖 API reference + +### `createCartLineItem(overrides?)` + +Creates a mock POS `LineItem` with sensible defaults. Pass a partial override to customize fields. + +### `createStorage(initialValues?)` + +Creates a mock `Storage` instance. Optionally accepts a `Record` of initial entries. + +### `createResult(mutation, result?)` + +Creates a typed mock result for a POS mutation API. The `mutation` argument is strongly typed to only accept known mutation names. + +Supported mutations: + +| Mutation | Default | +| ------------------ | --------------------------- | +| `'bulkCartUpdate'` | Empty cart with zero totals | diff --git a/packages/ui-extensions-tester/src/point-of-sale/factories.ts b/packages/ui-extensions-tester/src/point-of-sale/factories.ts new file mode 100644 index 0000000000..981223a93b --- /dev/null +++ b/packages/ui-extensions-tester/src/point-of-sale/factories.ts @@ -0,0 +1,608 @@ +import type { + ExtensionTarget, + ExtensionTargets, + RenderExtensionTarget, + StandardApi, + ActionTargetApi, + DataTargetApi, + ActionApi, + CartApi, + OrderApi, + ProductApi, + CustomerApi, + DraftOrderApi, + CartLineItemApi, + CashDrawerApi, + ScannerSource, + StorageApi, + ConnectivityApiContent, + ConnectivityState, + Cart, + Session, + StaffMember, + TransactionCompleteWithReprintData, + Money, +} from '@shopify/ui-extensions/point-of-sale'; + +import {createReadonlySignalLike} from '../mocks/signals'; +import {createMockI18n} from '../mocks/i18n'; +import {createCartLineItem, createStorage, createResult} from './index'; + +/** + * Extracts the API type for a given POS extension target directly from the + * implementation's `ExtensionTargets` interface. + * + * - For render targets: extracts the `api` property from `RenderExtension`. + * - For event targets: extracts the `data` parameter from the handler function. + */ +type ApiForPosExtension = + ExtensionTargets[T] extends {api: infer Api} + ? Api + : ExtensionTargets[T] extends (data: infer D) => any + ? D + : never; + +type Transaction = TransactionCompleteWithReprintData['transaction']; + +function createConnectivityState(): ConnectivityState { + return {internetConnected: 'Connected'}; +} + +function createSessionCurrentSession(): Session { + return { + shopId: 1, + userId: 1, + shopDomain: 'mock-shop.myshopify.com', + locationId: 1, + staffMemberId: 1, + currency: 'USD', + posVersion: '9.0.0', + }; +} + +function createStaffMember(): StaffMember { + return { + id: 1, + }; +} + +function createPosCart(): Cart { + return { + subtotal: '0.00', + taxTotal: '0.00', + grandTotal: '0.00', + cartDiscounts: [], + lineItems: [], + properties: {}, + }; +} + +function createTransaction(): Transaction { + const money: Money = {amount: 0, currency: 'USD'}; + return { + transactionType: 'Sale' as const, + orderId: 1, + taxTotal: money, + subtotal: money, + grandTotal: money, + paymentMethods: [], + balanceDue: money, + executedAt: new Date().toISOString(), + lineItems: [], + } as Transaction; +} + +function createConnectivityApiContent(): ConnectivityApiContent { + return { + current: createReadonlySignalLike(createConnectivityState()), + }; +} + +function createMockBaseEventData() { + return { + connectivity: createConnectivityApiContent(), + device: {name: 'Mock POS Device', deviceId: 1, isTablet: false}, + locale: 'en-US', + session: createSessionCurrentSession(), + storage: createStorage(), + }; +} + +function createMockStandardApi( + target: T, +): StandardApi { + return { + extensionPoint: target, + extension: { + apiVersion: '2026-04', + target, + }, + i18n: createMockI18n(), + locale: {current: createReadonlySignalLike('en-US')}, + toast: {show: () => {}}, + session: { + currentSession: createSessionCurrentSession(), + staffMember: createReadonlySignalLike(createStaffMember()), + getSessionToken: async () => 'mock-session-token', + deviceId: 1, + }, + print: {print: async () => {}}, + printing: { + getPrinters: async () => [], + print: async () => {}, + }, + productSearch: { + searchProducts: async () => ({items: [], hasNextPage: false}), + fetchProductWithId: async () => undefined, + fetchProductsWithIds: async () => ({ + fetchedResources: [], + idsForResourcesNotFound: [], + }), + fetchProductVariantWithId: async () => undefined, + fetchProductVariantsWithIds: async () => ({ + fetchedResources: [], + idsForResourcesNotFound: [], + }), + fetchProductVariantsWithProductId: async () => [], + fetchPaginatedProductVariantsWithProductId: async () => ({ + items: [], + hasNextPage: false, + }), + }, + device: { + name: 'Mock POS Device', + registerName: 'Register 1', + getDeviceId: async () => 'mock-device-id', + isTablet: async () => false, + }, + connectivity: { + current: createReadonlySignalLike(createConnectivityState()), + }, + storage: createStorage(), + pinPad: {showPinPad: () => {}}, + camera: { + takePhoto: async () => ({ + base64: '', + width: 0, + height: 0, + fileSize: 0, + type: 'image/jpeg', + }), + }, + }; +} + +function createMockActionTargetApi( + target: T, +): ActionTargetApi { + return { + ...createMockStandardApi(target), + extensionPoint: target, + scanner: { + scannerData: { + current: createReadonlySignalLike({ + data: undefined, + source: undefined, + }), + }, + sources: { + current: createReadonlySignalLike([]), + }, + showCameraScanner: () => {}, + hideCameraScanner: () => {}, + }, + }; +} + +function createMockActionApi(): ActionApi { + return {action: {presentModal: () => {}}}; +} + +function createMockCartApi(): CartApi { + return { + cart: { + current: createReadonlySignalLike(createPosCart()), + bulkCartUpdate: async () => createResult('bulkCartUpdate'), + applyCartDiscount: async () => {}, + addCartCodeDiscount: async () => {}, + removeCartDiscount: async () => {}, + removeAllDiscounts: async () => {}, + clearCart: async () => {}, + setCustomer: async () => {}, + removeCustomer: async () => {}, + addCustomSale: async () => '', + addLineItem: async () => '', + removeLineItem: async () => {}, + addCartProperties: async () => {}, + removeCartProperties: async () => {}, + addLineItemProperties: async () => {}, + bulkAddLineItemProperties: async () => {}, + removeLineItemProperties: async () => {}, + setLineItemDiscount: async () => {}, + bulkSetLineItemDiscounts: async () => {}, + setAttributedStaff: async () => {}, + setAttributedStaffToLineItem: async () => {}, + removeLineItemDiscount: async () => {}, + addAddress: async () => {}, + deleteAddress: async () => {}, + updateDefaultAddress: async () => {}, + addLineItemSellingPlan: async () => {}, + removeLineItemSellingPlan: async () => {}, + }, + }; +} + +function createMockOrderApi(): OrderApi { + return {order: {id: 1, name: '#1001', customerId: undefined}}; +} + +function createMockProductApi(): ProductApi { + return {product: {id: 1, variantId: 1}}; +} + +function createMockCustomerApi(): CustomerApi { + return {customer: {id: 1}}; +} + +function createMockDraftOrderApi(): DraftOrderApi { + return {draftOrder: {id: 1, name: '#D1', customerId: undefined}}; +} + +function createMockCartLineItemApi(): CartLineItemApi { + return {cartLineItem: createCartLineItem()}; +} + +function createMockCashDrawerApi(): CashDrawerApi { + return {cashDrawer: {open: async () => {}}}; +} + +// --------------------------------------------------------------------------- +// Group factory functions — each composes the correct API for a target group +// --------------------------------------------------------------------------- + +// Group A: StandardApi + ActionApi + CartApi +function createStandardActionCartMock( + target: T, +): StandardApi & ActionApi & CartApi { + return { + ...createMockStandardApi(target), + ...createMockActionApi(), + ...createMockCartApi(), + }; +} + +// Group B: ActionTargetApi + CartApi +function createActionTargetCartMock( + target: T, +): ActionTargetApi & CartApi { + return { + ...createMockActionTargetApi(target), + ...createMockCartApi(), + }; +} + +// Group C: StandardApi + ActionApi + OrderApi +function createStandardActionOrderMock( + target: T, +): StandardApi & ActionApi & OrderApi { + return { + ...createMockStandardApi(target), + ...createMockActionApi(), + ...createMockOrderApi(), + }; +} + +// Group D: ActionTargetApi + OrderApi +function createActionTargetOrderMock( + target: T, +): ActionTargetApi & OrderApi { + return { + ...createMockActionTargetApi(target), + ...createMockOrderApi(), + }; +} + +// Group E: StandardApi + ActionApi + CartApi + ProductApi +function createStandardActionCartProductMock( + target: T, +): StandardApi & ActionApi & CartApi & ProductApi { + return { + ...createMockStandardApi(target), + ...createMockActionApi(), + ...createMockCartApi(), + ...createMockProductApi(), + }; +} + +// Group F: ActionTargetApi + CartApi + ProductApi +function createActionTargetCartProductMock( + target: T, +): ActionTargetApi & CartApi & ProductApi { + return { + ...createMockActionTargetApi(target), + ...createMockCartApi(), + ...createMockProductApi(), + }; +} + +// Group G: StandardApi + ActionApi + CartApi + OrderApi +function createStandardActionCartOrderMock( + target: T, +): StandardApi & ActionApi & CartApi & OrderApi { + return { + ...createMockStandardApi(target), + ...createMockActionApi(), + ...createMockCartApi(), + ...createMockOrderApi(), + }; +} + +// Group H: ActionTargetApi + CartApi + OrderApi +function createActionTargetCartOrderMock( + target: T, +): ActionTargetApi & CartApi & OrderApi { + return { + ...createMockActionTargetApi(target), + ...createMockCartApi(), + ...createMockOrderApi(), + }; +} + +// Group I: StandardApi + ActionApi + CartApi + DraftOrderApi +function createStandardActionCartDraftOrderMock< + T extends RenderExtensionTarget, +>(target: T): StandardApi & ActionApi & CartApi & DraftOrderApi { + return { + ...createMockStandardApi(target), + ...createMockActionApi(), + ...createMockCartApi(), + ...createMockDraftOrderApi(), + }; +} + +// Group J: ActionTargetApi + DraftOrderApi + CartApi +function createActionTargetDraftOrderCartMock( + target: T, +): ActionTargetApi & DraftOrderApi & CartApi { + return { + ...createMockActionTargetApi(target), + ...createMockDraftOrderApi(), + ...createMockCartApi(), + }; +} + +// Group K: StandardApi + ActionApi + CartApi + CustomerApi +function createStandardActionCartCustomerMock( + target: T, +): StandardApi & ActionApi & CartApi & CustomerApi { + return { + ...createMockStandardApi(target), + ...createMockActionApi(), + ...createMockCartApi(), + ...createMockCustomerApi(), + }; +} + +// Group L: ActionTargetApi + CartApi + CustomerApi +function createActionTargetCartCustomerMock( + target: T, +): ActionTargetApi & CartApi & CustomerApi { + return { + ...createMockActionTargetApi(target), + ...createMockCartApi(), + ...createMockCustomerApi(), + }; +} + +// Group M: StandardApi + ActionApi + CartApi + CartLineItemApi +function createStandardActionCartLineItemMock( + target: T, +): StandardApi & ActionApi & CartApi & CartLineItemApi { + return { + ...createMockStandardApi(target), + ...createMockActionApi(), + ...createMockCartApi(), + ...createMockCartLineItemApi(), + }; +} + +// Group N: ActionTargetApi + ActionApi + CartApi + CartLineItemApi +function createActionTargetActionCartLineItemMock< + T extends RenderExtensionTarget, +>(target: T): ActionTargetApi & ActionApi & CartApi & CartLineItemApi { + return { + ...createMockActionTargetApi(target), + ...createMockActionApi(), + ...createMockCartApi(), + ...createMockCartLineItemApi(), + }; +} + +// Group O: Receipt targets +function createReceiptMock( + _target: T, +): {[key: string]: unknown} & StorageApi & TransactionCompleteWithReprintData { + return { + ...createMockBaseEventData(), + transaction: createTransaction(), + }; +} + +// Group P: StandardApi + ActionApi + CashDrawerApi +function createStandardActionCashDrawerMock( + target: T, +): StandardApi & ActionApi & CashDrawerApi { + return { + ...createMockStandardApi(target), + ...createMockActionApi(), + ...createMockCashDrawerApi(), + }; +} + +// Group Q: ActionTargetApi + CashDrawerApi +function createActionTargetCashDrawerMock( + target: T, +): ActionTargetApi & CashDrawerApi { + return { + ...createMockActionTargetApi(target), + ...createMockCashDrawerApi(), + }; +} + +// Data target factories +function createDataTargetMock( + target: T, +): DataTargetApi { + return { + extensionPoint: target, + extension: { + apiVersion: '2026-04', + target, + }, + i18n: createMockI18n(), + session: { + currentSession: createSessionCurrentSession(), + staffMember: createReadonlySignalLike(createStaffMember()), + getSessionToken: async () => 'mock-session-token', + deviceId: 1, + }, + storage: createStorage(), + locale: {current: createReadonlySignalLike('en-US')}, + connectivity: { + current: createReadonlySignalLike(createConnectivityState()), + }, + device: { + name: 'Mock POS Device', + registerName: 'Register 1', + getDeviceId: async () => 'mock-device-id', + isTablet: async () => false, + }, + productSearch: { + searchProducts: async () => ({items: [], hasNextPage: false}), + fetchProductWithId: async () => undefined, + fetchProductsWithIds: async () => ({ + fetchedResources: [], + idsForResourcesNotFound: [], + }), + fetchProductVariantWithId: async () => undefined, + fetchProductVariantsWithIds: async () => ({ + fetchedResources: [], + idsForResourcesNotFound: [], + }), + fetchProductVariantsWithProductId: async () => [], + fetchPaginatedProductVariantsWithProductId: async () => ({ + items: [], + hasNextPage: false, + }), + }, + ...createMockCartApi(), + }; +} + +// --------------------------------------------------------------------------- +// Factory map — TypeScript verifies each entry against ApiForPosExtension +// --------------------------------------------------------------------------- + +type PosMockFactory = { + [K in ExtensionTarget]: (target: K) => ApiForPosExtension; +}; + +const posMockFactories: PosMockFactory = { + // Group A: StandardApi + ActionApi + CartApi + 'pos.home.tile.render': createStandardActionCartMock, + + // Group B: ActionTargetApi + CartApi + 'pos.home.modal.render': createActionTargetCartMock, + + // Group C: StandardApi + ActionApi + OrderApi + 'pos.return.post.action.menu-item.render': createStandardActionOrderMock, + 'pos.return.post.block.render': createStandardActionOrderMock, + 'pos.exchange.post.action.menu-item.render': createStandardActionOrderMock, + 'pos.exchange.post.block.render': createStandardActionOrderMock, + 'pos.purchase.post.action.menu-item.render': createStandardActionOrderMock, + 'pos.purchase.post.block.render': createStandardActionOrderMock, + + // Group D: ActionTargetApi + OrderApi + 'pos.return.post.action.render': createActionTargetOrderMock, + 'pos.exchange.post.action.render': createActionTargetOrderMock, + 'pos.purchase.post.action.render': createActionTargetOrderMock, + + // Group E: StandardApi + ActionApi + CartApi + ProductApi + 'pos.product-details.action.menu-item.render': + createStandardActionCartProductMock, + 'pos.product-details.block.render': createStandardActionCartProductMock, + + // Group F: ActionTargetApi + CartApi + ProductApi + 'pos.product-details.action.render': createActionTargetCartProductMock, + + // Group G: StandardApi + ActionApi + CartApi + OrderApi + 'pos.order-details.action.menu-item.render': + createStandardActionCartOrderMock, + 'pos.order-details.block.render': createStandardActionCartOrderMock, + + // Group H: ActionTargetApi + CartApi + OrderApi + 'pos.order-details.action.render': createActionTargetCartOrderMock, + + // Group I: StandardApi + ActionApi + CartApi + DraftOrderApi + 'pos.draft-order-details.action.menu-item.render': + createStandardActionCartDraftOrderMock, + 'pos.draft-order-details.block.render': + createStandardActionCartDraftOrderMock, + + // Group J: ActionTargetApi + DraftOrderApi + CartApi + 'pos.draft-order-details.action.render': createActionTargetDraftOrderCartMock, + + // Group K: StandardApi + ActionApi + CartApi + CustomerApi + 'pos.customer-details.action.menu-item.render': + createStandardActionCartCustomerMock, + 'pos.customer-details.block.render': createStandardActionCartCustomerMock, + + // Group L: ActionTargetApi + CartApi + CustomerApi + 'pos.customer-details.action.render': createActionTargetCartCustomerMock, + + // Group M: StandardApi + ActionApi + CartApi + CartLineItemApi + 'pos.cart.line-item-details.action.menu-item.render': + createStandardActionCartLineItemMock, + + // Group N: ActionTargetApi + ActionApi + CartApi + CartLineItemApi + 'pos.cart.line-item-details.action.render': + createActionTargetActionCartLineItemMock, + + // Group O: Receipt targets + 'pos.receipt-footer.block.render': createReceiptMock, + 'pos.receipt-header.block.render': createReceiptMock, + + // Group P: StandardApi + ActionApi + CashDrawerApi + 'pos.register-details.action.menu-item.render': + createStandardActionCashDrawerMock, + 'pos.register-details.block.render': createStandardActionCashDrawerMock, + + // Group Q: ActionTargetApi + CashDrawerApi + 'pos.register-details.action.render': createActionTargetCashDrawerMock, + + // Data targets + 'pos.app.ready.data': createDataTargetMock, +}; + +// --------------------------------------------------------------------------- +// Main factory +// --------------------------------------------------------------------------- + +/** + * Creates a complete mock API for a POS extension target. + * + * For render targets this returns the full API object. + * For event targets this returns the data object passed to the handler. + */ +export function createMockPosTargetApi( + target: T, +): ApiForPosExtension { + const factory = posMockFactories[target]; + if (!factory) { + throw new Error( + `Unsupported POS target: "${target}". ` + + 'Add an entry for this target in posMockFactories.', + ); + } + return factory(target); +} diff --git a/packages/ui-extensions-tester/src/point-of-sale/index.ts b/packages/ui-extensions-tester/src/point-of-sale/index.ts new file mode 100644 index 0000000000..404bfa9ca7 --- /dev/null +++ b/packages/ui-extensions-tester/src/point-of-sale/index.ts @@ -0,0 +1,92 @@ +import type { + LineItem, + Storage, + CartApiContent, +} from '@shopify/ui-extensions/point-of-sale'; + +/** + * Creates a mock POS `LineItem` with sensible defaults. + * Pass a partial override to customize fields. + */ +export function createCartLineItem(overrides?: Partial): LineItem { + return { + uuid: 'mock-line-item-uuid', + price: 10, + quantity: 1, + title: 'Mock Line Item', + variantId: 1, + productId: 1, + discounts: [], + taxable: true, + taxLines: [], + sku: 'MOCK-SKU', + vendor: 'Mock Vendor', + properties: {}, + isGiftCard: false, + ...overrides, + }; +} + +/** + * Creates a mock `Storage` instance. + * + * Optionally accepts a `Record` of initial entries. + */ +export function createStorage< + T extends Record = Record, +>(initialValues?: T): Storage { + const store = new Map( + initialValues ? Object.entries(initialValues) : [], + ); + const storage: Storage = { + set: async (key, value) => { + store.set(key as string, value); + }, + get: async (key) => store.get(key as string) as never, + clear: async () => { + store.clear(); + }, + delete: async (key) => { + return store.delete(key as string); + }, + entries: async () => [...store.entries()] as never, + }; + return storage; +} + +/** + * Maps each POS mutation API name to its result type. + */ +export interface PosMutationResults { + bulkCartUpdate: Awaited>; +} + +const posMutationDefaults: { + [K in keyof PosMutationResults]: () => PosMutationResults[K]; +} = { + bulkCartUpdate: () => ({ + subtotal: '0.00', + taxTotal: '0.00', + grandTotal: '0.00', + cartDiscounts: [], + lineItems: [], + properties: {}, + }), +}; + +/** + * Creates a typed mock result for a POS mutation API. + * + * @param mutation - The mutation API name (e.g. `'bulkCartUpdate'`). + * @param result - Optional partial override merged with the default. + * + * @example + * createResult('bulkCartUpdate'); + * createResult('bulkCartUpdate', {grandTotal: '25.00'}); + */ +export function createResult( + mutation: K, + result?: Partial, +): PosMutationResults[K] { + return {...posMutationDefaults[mutation](), ...result}; +} diff --git a/packages/ui-extensions-tester/src/targets.ts b/packages/ui-extensions-tester/src/targets.ts new file mode 100644 index 0000000000..5ec9986ca9 --- /dev/null +++ b/packages/ui-extensions-tester/src/targets.ts @@ -0,0 +1,79 @@ +import type { + ExtensionTargets as CheckoutExtensionTargets, + ExtensionTarget as CheckoutExtensionTarget, +} from '@shopify/ui-extensions/checkout'; +import type { + ExtensionTarget as AdminExtensionTarget, + ExtensionTargets as AdminExtensionTargets, +} from '@shopify/ui-extensions/admin'; +import type { + ExtensionTarget as PosExtensionTarget, + ExtensionTargets as PointOfSaleExtensionTargets, + ShopifyEventMap as PosEventMap, +} from '@shopify/ui-extensions/point-of-sale'; +import type { + CustomerAccountExtensionTarget, + ExtensionTargets as CustomerAccountExtensionTargets, +} from '@shopify/ui-extensions/customer-account'; + +/** + * Combined extension targets from all surfaces. + */ +export interface AllExtensionTargets + extends CheckoutExtensionTargets, + AdminExtensionTargets, + CustomerAccountExtensionTargets, + PointOfSaleExtensionTargets {} + +/** + * Any valid extension target name. + */ +export type AnyExtensionTarget = keyof AllExtensionTargets; + +/** + * Extracts the API type for a given extension target. + * + * For render targets this is the `api` property of the `RenderExtension`. + * For event targets (functions) this is the `data` parameter type. + */ +export type ApiForTarget = + AllExtensionTargets[T] extends {api: infer A} + ? A + : AllExtensionTargets[T] extends (data: infer D) => unknown + ? D + : never; + +/** + * Maps an extension target to the event map available via + * `shopify.addEventListener` on that surface. + * + * - POS targets: the POS `ShopifyEventMap`. + * - Other surfaces: no host events, so the map is empty. + */ +export type EventMapForTarget = + T extends PosExtensionTarget ? PosEventMap : Record; + +export function isCheckoutTarget( + target: string, +): target is CheckoutExtensionTarget { + return ( + target.startsWith('purchase.checkout') || + target.startsWith('purchase.thank-you') || + target.startsWith('purchase.cart-line-item') || + target.startsWith('Checkout::') + ); +} + +export function isPosTarget(target: string): target is PosExtensionTarget { + return target.startsWith('pos.'); +} + +export function isCustomerAccountTarget( + target: string, +): target is CustomerAccountExtensionTarget { + return target.startsWith('customer-account.'); +} + +export function isAdminTarget(target: string): target is AdminExtensionTarget { + return target.startsWith('admin.'); +} diff --git a/packages/ui-extensions-tester/src/tests/admin-app-home-intents.test.ts b/packages/ui-extensions-tester/src/tests/admin-app-home-intents.test.ts new file mode 100644 index 0000000000..e12cace0e3 --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/admin-app-home-intents.test.ts @@ -0,0 +1,73 @@ +import type { + AppHomeApi, + AppHomeIntents, + AppHomeIntentRequest, + Intents, + ShopifyGeneratedIntentVariant, + WithGeneratedIntents, +} from '@shopify/ui-extensions/admin'; + +import {createMockAdminTargetApi} from '../admin/factories'; +import {assertType, type Equals} from './type-assertions'; + +// --------------------------------------------------------------------------- +// Compile-time assertions +// --------------------------------------------------------------------------- + +type AppHome = AppHomeApi<'admin.app.home.render'>; + +// AppHomeApi exposes a richer `Intents` shape than `StandardApi`: a signal- +// like `request` is always present so the runtime can stream link intents +// into the long-lived extension instance. +assertType>(); +assertType>(); + +// `AppHomeIntents` keeps the standard invocation helper. +assertType>(); + +// `WithGeneratedIntents` narrows `request.value` to the generated payload +// union and preserves the signal-like shape. +interface CreateProductRequest { + action: 'create'; + type: 'shopify/Product'; + data?: {title?: string}; +} +type GeneratedVariants = ShopifyGeneratedIntentVariant; +type AppHomeWithGenerated = WithGeneratedIntents; + +assertType< + Equals< + AppHomeWithGenerated['intents']['request']['value'], + CreateProductRequest | null + > +>(); + +// Other `AppHomeApi` properties survive the merge. +assertType>(); +assertType>(); + +// --------------------------------------------------------------------------- +// Runtime behaviour of the mock factory +// --------------------------------------------------------------------------- + +describe('app home intents api', () => { + it('starts with a null request and a no-op subscribe', () => { + const api = createMockAdminTargetApi('admin.app.home.render'); + + expect(api.intents.request.value).toBeNull(); + + const callback = jest.fn(); + const unsubscribe = api.intents.request.subscribe(callback); + + // The mock subscriber is never invoked because the value is static. + expect(callback).not.toHaveBeenCalled(); + expect(typeof unsubscribe).toBe('function'); + expect(() => unsubscribe()).not.toThrow(); + }); + + it('exposes the standard `invoke` helper alongside `request`', () => { + const api = createMockAdminTargetApi('admin.app.home.render'); + + expect(typeof api.intents.invoke).toBe('function'); + }); +}); diff --git a/packages/ui-extensions-tester/src/tests/admin-factories.test.ts b/packages/ui-extensions-tester/src/tests/admin-factories.test.ts new file mode 100644 index 0000000000..7064916c7c --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/admin-factories.test.ts @@ -0,0 +1,91 @@ +import {createMockAdminTargetApi, gidFromTarget} from '../admin/factories'; + +describe('gidFromTarget', () => { + it.each([ + ['admin.product-details.block.render', 'gid://shopify/Product/1'], + ['admin.order-details.action.render', 'gid://shopify/Order/1'], + ['admin.draft-order-index.action.render', 'gid://shopify/DraftOrder/1'], + [ + 'admin.company-location-details.block.render', + 'gid://shopify/CompanyLocation/1', + ], + ['admin.gift-card-details.block.render', 'gid://shopify/GiftCard/1'], + [ + 'admin.product-variant-details.action.render', + 'gid://shopify/ProductVariant/1', + ], + [ + 'admin.customer-segment-details.action.render', + 'gid://shopify/CustomerSegment/1', + ], + [ + 'admin.abandoned-checkout-details.block.render', + 'gid://shopify/AbandonedCheckout/1', + ], + ['admin.order-fulfilled-card.action.render', 'gid://shopify/Order/1'], + ['admin.collection-index.action.render', 'gid://shopify/Collection/1'], + ['admin.product-purchase-option.action.render', 'gid://shopify/Product/1'], + ] as const)('%s → %s', (target, expectedGid) => { + expect(gidFromTarget(target)).toBe(expectedGid); + }); +}); + +describe('createMockAdminTargetApi', () => { + it('keeps app tools targets on the standard api', () => { + const api = createMockAdminTargetApi('admin.app.tools.data'); + + expect(api.extension.target).toBe('admin.app.tools.data'); + expect(typeof api.query).toBe('function'); + expect(api).not.toHaveProperty('tools'); + expect(api).not.toHaveProperty('resourcePicker'); + }); + + it('creates an app home api with loading controls', () => { + const api = createMockAdminTargetApi('admin.app.home.render'); + + expect(api.extension.target).toBe('admin.app.home.render'); + expect(typeof api.toast.show).toBe('function'); + expect(typeof api.app.extensions).toBe('function'); + expect(typeof api.loading).toBe('function'); + }); + + it('exposes a tools registration api on app home', () => { + const api = createMockAdminTargetApi('admin.app.home.render'); + + expect(typeof api.tools.register).toBe('function'); + expect(typeof api.tools.unregister).toBe('function'); + expect(typeof api.tools.clear).toBe('function'); + + const unregister = api.tools.register('faq.update', async () => ({ + ok: true, + })); + expect(typeof unregister).toBe('function'); + expect(() => unregister()).not.toThrow(); + expect(() => api.tools.unregister('faq.update')).not.toThrow(); + expect(() => api.tools.clear()).not.toThrow(); + }); + + it('exposes a signal-like intents.request on app home', () => { + const api = createMockAdminTargetApi('admin.app.home.render'); + + expect(api.intents.request.value).toBeNull(); + expect(typeof api.intents.request.subscribe).toBe('function'); + + const unsubscribe = api.intents.request.subscribe(() => {}); + expect(typeof unsubscribe).toBe('function'); + expect(() => unsubscribe()).not.toThrow(); + }); + + it('creates a standard rendering api for app intent targets', () => { + const api = createMockAdminTargetApi('admin.app.intent.render'); + + expect(api.extension.target).toBe('admin.app.intent.render'); + expect(typeof api.resourcePicker).toBe('function'); + expect(typeof api.picker).toBe('function'); + expect(api).not.toHaveProperty('tools'); + expect(typeof api.intents.response?.ok).toBe('function'); + expect(typeof api.intents.response?.error).toBe('function'); + expect(typeof api.intents.response?.closed).toBe('function'); + expect(api).not.toHaveProperty('close'); + }); +}); diff --git a/packages/ui-extensions-tester/src/tests/admin-tools.test.ts b/packages/ui-extensions-tester/src/tests/admin-tools.test.ts new file mode 100644 index 0000000000..114a08f209 --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/admin-tools.test.ts @@ -0,0 +1,102 @@ +import type { + AppHomeApi, + Tools, + ToolHandler, + WithGeneratedTools, +} from '@shopify/ui-extensions/admin'; + +import {createMockAdminTargetApi} from '../admin/factories'; +import {assertType, type Equals} from './type-assertions'; + +// --------------------------------------------------------------------------- +// Compile-time assertions +// --------------------------------------------------------------------------- + +interface UpdateFaqInput { + id: string; + body: string; +} + +interface UpdateFaqOutput { + ok: boolean; +} + +interface GeneratedTools { + register( + name: 'update_faq', + handler: (input: UpdateFaqInput) => Promise, + ): () => void; +} + +type AppHome = AppHomeApi<'admin.app.home.render'>; +type AppHomeWithGenerated = WithGeneratedTools; + +// AppHomeApi exposes the base `Tools` API (regression test for the missing +// `tools` property on `admin.app.home.render`). +assertType>(); + +// `WithGeneratedTools` keeps non-`register` members from the base `Tools` API +// (so `unregister` and `clear` stay available) while replacing `register` +// with the generated overloads. +assertType< + Equals +>(); +assertType>(); +assertType< + Equals +>(); + +// Other `AppHomeApi` properties are preserved through the merge. +assertType>(); +assertType>(); +assertType>(); + +// When the base API has no `tools`, `WithGeneratedTools` introduces it. +interface NoToolsBase { + extension: {target: 'noop'}; +} +type NoToolsMerged = WithGeneratedTools; +assertType>(); + +// `ToolHandler` is the generic fallback signature (Record in / Record out). +const handler: ToolHandler = async (input) => { + return {received: Object.keys(input).length}; +}; + +// --------------------------------------------------------------------------- +// Runtime behaviour of the mock factory +// --------------------------------------------------------------------------- + +describe('admin tools api', () => { + it('mocks register/unregister/clear with no-op functions', async () => { + const api = createMockAdminTargetApi('admin.app.home.render'); + + expect(typeof api.tools.register).toBe('function'); + const cleanup = api.tools.register('update_faq', handler); + expect(typeof cleanup).toBe('function'); + + // The generic handler is invokable and returns a plain record. + const result = await handler({id: '1', body: 'hi'}); + expect(result).toStrictEqual({received: 2}); + + expect(() => cleanup()).not.toThrow(); + expect(() => api.tools.unregister('update_faq')).not.toThrow(); + expect(() => api.tools.clear()).not.toThrow(); + }); + + it('narrows the mock api type to the generated overloads when wrapped', () => { + const baseApi = createMockAdminTargetApi('admin.app.home.render'); + // Cast at the boundary the way generated typings would augment it. + const api = baseApi as unknown as AppHomeWithGenerated; + + // Generated overload: name + typed handler must match. + const cleanup = api.tools.register('update_faq', async (input) => { + // `input` is narrowed to `UpdateFaqInput`, so `id` is a string. + return {ok: input.id.length > 0}; + }); + + expect(typeof cleanup).toBe('function'); + expect(typeof api.tools.unregister).toBe('function'); + expect(typeof api.tools.clear).toBe('function'); + }); +}); diff --git a/packages/ui-extensions-tester/src/tests/fetch.test.ts b/packages/ui-extensions-tester/src/tests/fetch.test.ts new file mode 100644 index 0000000000..e3a0a8dd91 --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/fetch.test.ts @@ -0,0 +1,139 @@ +import {getExtension} from '../index'; + +import {createTestSandbox, type TestSandbox} from './helpers'; + +describe('extension.fetch', () => { + let sandbox: TestSandbox; + + beforeEach(() => { + sandbox = createTestSandbox(); + }); + + afterEach(() => { + sandbox.destroy(); + }); + + it('is available on the extension harness for checkout targets', () => { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + expect(extension.fetch).toBeInstanceOf(Function); + expect(globalThis.fetch).toBe(extension.fetch); + }); + + it('restores the previous globalThis.fetch during tearDown', () => { + const previousFetch = async () => new Response(); + (globalThis as any).fetch = previousFetch; + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + expect(globalThis.fetch).not.toBe(previousFetch); + extension.tearDown(); + expect(globalThis.fetch).toBe(previousFetch); + }); + + it('removes globalThis.fetch during tearDown when there was no previous fetch', () => { + delete (globalThis as any).fetch; + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + extension.tearDown(); + expect(globalThis.fetch).toBeUndefined(); + }); + + it('throws when called if network_access is not enabled in the toml', async () => { + sandbox.placeToml(); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + await expect(extension.fetch('https://example.com')).rejects.toThrow( + /network_access.*api_access/, + ); + }); + + it('does not throw when called if api_access is enabled', async () => { + sandbox.placeToml({apiAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + const response = await extension.fetch('https://example.com'); + expect(response.ok).toBe(true); + expect(response.status).toBe(200); + }); + + it('does not throw when called if network_access is enabled', async () => { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + const response = await extension.fetch('https://example.com'); + expect(response.ok).toBe(true); + expect(response.status).toBe(200); + }); + + it('syncs globalThis.fetch when extension.fetch is reassigned', () => { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + const customFetch = async () => new Response(null, {status: 418}); + extension.fetch = customFetch as typeof globalThis.fetch; + expect(globalThis.fetch).toBe(customFetch); + }); + + it('installs fetch for non-checkout targets without capabilities check', async () => { + sandbox.placeToml({target: 'pos.home.tile.render'}); + const extension = getExtension('pos.home.tile.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + expect(extension.fetch).toBeInstanceOf(Function); + expect(globalThis.fetch).toBe(extension.fetch); + const response = await extension.fetch('https://example.com'); + expect(response.ok).toBe(true); + }); + + it('does not remove a pre-existing Response global during tearDown', () => { + const originalResponse = (globalThis as any).Response; + const FakeResponse = function FakeResponse() {} as any; + (globalThis as any).Response = FakeResponse; + try { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + extension.tearDown(); + expect(globalThis.Response).toBe(FakeResponse); + } finally { + (globalThis as any).Response = originalResponse; + } + }); + + it('does not remove a pre-existing Request global during tearDown', () => { + const originalRequest = (globalThis as any).Request; + const FakeRequest = function FakeRequest() {} as any; + (globalThis as any).Request = FakeRequest; + try { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + extension.tearDown(); + expect(globalThis.Request).toBe(FakeRequest); + } finally { + (globalThis as any).Request = originalRequest; + } + }); +}); diff --git a/packages/ui-extensions-tester/src/tests/fixtures/test-module.ts b/packages/ui-extensions-tester/src/tests/fixtures/test-module.ts new file mode 100644 index 0000000000..feab160aa0 --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/fixtures/test-module.ts @@ -0,0 +1 @@ +export default function render() {} diff --git a/packages/ui-extensions-tester/src/tests/getExtension.test.ts b/packages/ui-extensions-tester/src/tests/getExtension.test.ts new file mode 100644 index 0000000000..039cb3356a --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/getExtension.test.ts @@ -0,0 +1,259 @@ +import * as fs from 'fs'; +import * as path from 'path'; + +import {getExtension} from '../index'; + +import {API_VERSION} from '../api-version'; +import {createTestSandbox, makeToml, type TestSandbox} from './helpers'; + +describe('getExtension', () => { + let sandbox: TestSandbox; + + beforeEach(() => { + sandbox = createTestSandbox(); + }); + + afterEach(() => { + sandbox.destroy(); + }); + + it('finds shopify.extension.toml in the given directory', () => { + sandbox.placeToml({inDir: 'root'}); + expect(() => + getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }), + ).not.toThrow(); + }); + + it('finds shopify.extension.toml in a parent directory', () => { + sandbox.placeToml({inDir: 'root'}); + expect(() => + getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tomlDirs.subDir, + }), + ).not.toThrow(); + }); + + it('finds shopify.extension.toml two parents up', () => { + sandbox.placeToml({inDir: 'root'}); + expect(() => + getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tomlDirs.nestedSubDir, + }), + ).not.toThrow(); + }); + + it('throws if shopify.extension.toml cannot be found', () => { + // No toml placed — should throw + expect(() => + getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }), + ).toThrow(/Could not find shopify\.extension\.toml/); + }); + + it('imports and executes the module specified by the toml', async () => { + sandbox.placeToml(); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + expect(await extension.render()).toBeUndefined(); + }); + + it('fails if the module cannot be imported', async () => { + sandbox.placeToml({module: './fixtures/nonexistent-module.js'}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + await expect(extension.render()).rejects.toThrow(/Cannot find module/); + }); + + it('throws if the TOML api_version does not match the library version', () => { + sandbox.placeToml({apiVersion: '2020-01'}); + expect(() => + getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }), + ).toThrow( + new RegExp(`api_version "2020-01" does not match.*"${API_VERSION}"`), + ); + }); + + it('sets extension.apiVersion on the mock shopify global', () => { + sandbox.placeToml(); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + expect(extension.shopify.extension.apiVersion).toBe(API_VERSION); + }); + + describe('extension.shopify proxy', () => { + beforeEach(() => { + sandbox.placeToml(); + }); + + it('throws when accessing shopify before calling setUp', () => { + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + expect(() => { + // eslint-disable-next-line @babel/no-unused-expressions + extension.shopify; + }).toThrow(/setUp\(\)/); + }); + + it('throws when getting a property that does not exist', () => { + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + + expect(() => { + // @ts-expect-error - nonExistentProp does not exist on the API + // eslint-disable-next-line @babel/no-unused-expressions + extension.shopify.nonExistentProp; + }).toThrow(/nonExistentProp.*does not exist/); + }); + + it('throws when setting a property that does not exist', () => { + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + + expect(() => { + // @ts-expect-error - nonExistentProp does not exist on the API + extension.shopify.nonExistentProp = 'value'; + }).toThrow(/nonExistentProp.*does not exist/); + }); + + it('allows getting a property that exists', () => { + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + + expect(() => { + // eslint-disable-next-line @babel/no-unused-expressions + extension.shopify.appMetafields; + }).not.toThrow(); + }); + + it('allows setting a property that exists', () => { + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + + expect(() => { + extension.shopify.appMetafields = { + current: {value: [], subscribe: () => () => {}}, + } as any; + }).not.toThrow(); + }); + + it('throws on nested non-existent property access', () => { + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + + expect(() => { + // @ts-expect-error - bogus does not exist + // eslint-disable-next-line @babel/no-unused-expressions + extension.shopify.appMetafields.bogus; + }).toThrow(/bogus.*does not exist/); + }); + }); + + describe('caching', () => { + it('returns the same instance for the same target and configSearchDir', () => { + sandbox.placeToml(); + const ext1 = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + const ext2 = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + expect(ext1).toBe(ext2); + }); + + it('returns different instances for the same target but different configSearchDir', () => { + sandbox.placeToml({inDir: 'root'}); + sandbox.placeToml({inDir: 'subDir'}); + const ext1 = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + const ext2 = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tomlDirs.subDir, + }); + expect(ext1).not.toBe(ext2); + }); + + it('returns the same instance when configSearchDir resolves to the same path', () => { + sandbox.placeToml(); + const ext1 = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + // Use a path with a redundant segment that resolves to the same directory + const ext2 = getExtension('purchase.checkout.block.render', { + configSearchDir: `${sandbox.tempDir}/sub/..`, + }); + expect(ext1).toBe(ext2); + }); + + it('returns the same instance when configSearchDir is omitted and then explicitly set to the resolved default', () => { + sandbox.placeToml(); + // When configSearchDir is omitted, it defaults to path.dirname(getCallerFile()). + // If we then call with that same directory explicitly, we should get the same instance. + const callerDir = path.dirname(__filename); + + // Place a toml in the caller's directory tree so both calls find it + const tomlPath = path.join(callerDir, 'shopify.extension.toml'); + fs.writeFileSync(tomlPath, makeToml()); + + try { + const ext1 = getExtension('purchase.checkout.block.render'); + const ext2 = getExtension('purchase.checkout.block.render', { + configSearchDir: callerDir, + }); + expect(ext1).toBe(ext2); + } finally { + fs.unlinkSync(tomlPath); + } + }); + + it('returns different instances for different targets', () => { + sandbox.placeToml({ + target: 'purchase.checkout.block.render', + }); + const ext1 = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + + sandbox.placeToml({target: 'pos.home.tile.render'}); + const ext2 = getExtension('pos.home.tile.render', { + configSearchDir: sandbox.tempDir, + }); + + expect(ext1).not.toBe(ext2); + }); + + it('returns a new instance when the config file changes on disk', () => { + sandbox.placeToml(); + const ext1 = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + + // Rewrite the toml — the resolved config file has changed + sandbox.placeToml(); + const ext2 = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + + expect(ext1).not.toBe(ext2); + }); + }); +}); diff --git a/packages/ui-extensions-tester/src/tests/helpers.ts b/packages/ui-extensions-tester/src/tests/helpers.ts new file mode 100644 index 0000000000..a7c2b805f8 --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/helpers.ts @@ -0,0 +1,140 @@ +import * as fs from 'fs'; +import * as path from 'path'; +import * as os from 'os'; + +import {API_VERSION} from '../api-version'; + +export const TOML_NAME = 'shopify.extension.toml'; + +/** + * Creates an isolated temp directory for a single test file. + * Each test file gets its own directory so tests can run in parallel + * without conflicting on the shared shopify.extension.toml file. + * + * The returned object provides `placeToml()` and `tearDown()` scoped + * to the temp directory. + */ +export function createTestSandbox() { + const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'ui-ext-tester-')); + + // Copy the fixtures directory into the temp dir so module paths resolve + const srcFixtures = path.resolve(__dirname, 'fixtures'); + const destFixtures = path.join(tempDir, 'fixtures'); + fs.mkdirSync(destFixtures, {recursive: true}); + for (const entry of fs.readdirSync(srcFixtures)) { + fs.copyFileSync( + path.join(srcFixtures, entry), + path.join(destFixtures, entry), + ); + } + + /** + * Known directories where `placeToml()` may write a toml file, + * scoped to this sandbox's temp directory tree. + */ + const tomlDirs = { + root: tempDir, + subDir: path.join(tempDir, 'sub'), + nestedSubDir: path.join(tempDir, 'sub', 'deep'), + } as const; + + // Pre-create the subdirectories + fs.mkdirSync(tomlDirs.nestedSubDir, {recursive: true}); + + type TomlDirName = keyof typeof tomlDirs; + + function removeAllTomls() { + for (const dir of Object.values(tomlDirs)) { + try { + fs.unlinkSync(path.join(dir, TOML_NAME)); + } catch { + // ignore if file doesn't exist + } + } + } + + function placeToml( + params: MakeTomlOptions & {inDir?: TomlDirName} = {}, + ): void { + const {inDir = 'root', ...options} = params; + // Default module path is relative to the toml location → fixtures/ + if (!options.module) { + const tomlDir = tomlDirs[inDir]; + const relToFixtures = path.relative(tomlDir, destFixtures); + options.module = `./${relToFixtures}/test-module.ts`; + } + fs.writeFileSync(path.join(tomlDirs[inDir], TOML_NAME), makeToml(options)); + } + + function tearDown() { + removeAllTomls(); + delete (globalThis as any).shopify; + delete (globalThis as any).fetch; + } + + function destroy() { + tearDown(); + rmdirRecursive(tempDir); + } + + return {tempDir, tomlDirs, placeToml, tearDown, destroy}; +} + +export type TestSandbox = ReturnType; + +function rmdirRecursive(dir: string) { + for (const entry of fs.readdirSync(dir, {withFileTypes: true})) { + const full = path.join(dir, entry.name); + if (entry.isDirectory()) { + rmdirRecursive(full); + } else { + fs.unlinkSync(full); + } + } + fs.rmdirSync(dir); +} + +export interface MakeTomlOptions { + /** Module path relative to the toml location. */ + module?: string; + /** Extension target. Defaults to `"purchase.checkout.block.render"`. */ + target?: string; + /** Whether to include `network_access = true` under `[extensions.capabilities]`. */ + networkAccess?: boolean; + /** Whether to include `api_access = true` under `[extensions.capabilities]`. */ + apiAccess?: boolean; + /** Override the `api_version` in the TOML. Defaults to the library's API version. */ + apiVersion?: string; +} + +export function makeToml(options: MakeTomlOptions = {}): string { + const { + module: modulePath = './fixtures/test-module.ts', + target = 'purchase.checkout.block.render', + networkAccess, + apiAccess, + apiVersion = API_VERSION, + } = options; + + const capabilityLines: string[] = []; + if (networkAccess) capabilityLines.push('network_access = true'); + if (apiAccess) capabilityLines.push('api_access = true'); + + const capabilities = + capabilityLines.length > 0 + ? `\n[extensions.capabilities]\n${capabilityLines.join('\n')}\n` + : ''; + + return `\ +api_version = "${apiVersion}" + +[[extensions]] +name = "test-extension" +handle = "test-extension" +type = "ui_extension" + +[[extensions.targeting]] +module = "${modulePath}" +target = "${target}" +${capabilities}`; +} diff --git a/packages/ui-extensions-tester/src/tests/navigation.test.ts b/packages/ui-extensions-tester/src/tests/navigation.test.ts new file mode 100644 index 0000000000..94db57450b --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/navigation.test.ts @@ -0,0 +1,130 @@ +import {getExtension, createNavigationHistoryEntry} from '../index'; + +import {createTestSandbox, type TestSandbox} from './helpers'; + +describe('extension.navigation', () => { + let sandbox: TestSandbox; + + beforeEach(() => { + sandbox = createTestSandbox(); + }); + + afterEach(() => { + sandbox.destroy(); + }); + + it('is available on the extension harness after setUp', () => { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + expect(extension.navigation).toBeInstanceOf(Object); + expect((globalThis as any).navigation).toBe(extension.navigation); + }); + + it('restores the previous globalThis.navigation during tearDown', () => { + const previousNavigation = {navigate: () => {}}; + (globalThis as any).navigation = previousNavigation; + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + expect((globalThis as any).navigation).not.toBe(previousNavigation); + extension.tearDown(); + expect((globalThis as any).navigation).toBe(previousNavigation); + }); + + it('removes globalThis.navigation during tearDown when there was no previous navigation', () => { + delete (globalThis as any).navigation; + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + extension.tearDown(); + expect((globalThis as any).navigation).toBeUndefined(); + }); + + it('provides a default navigate() that is a no-op', () => { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + expect(() => extension.navigation.navigate('/some-url')).not.toThrow(); + }); + + it('provides a default currentEntry', () => { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + expect(extension.navigation.currentEntry).toBeDefined(); + expect(extension.navigation.currentEntry.url).toBe(''); + expect(extension.navigation.currentEntry.getState()).toBeUndefined(); + }); + + it('provides addEventListener and removeEventListener', () => { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + const cb = () => {}; + expect(() => + extension.navigation.addEventListener('currententrychange', cb), + ).not.toThrow(); + expect(() => + extension.navigation.removeEventListener('currententrychange', cb), + ).not.toThrow(); + }); + + it('provides updateCurrentEntry', () => { + sandbox.placeToml({networkAccess: true}); + const extension = getExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + expect(() => + extension.navigation.updateCurrentEntry({state: {foo: 1}}), + ).not.toThrow(); + }); +}); + +describe('createNavigationHistoryEntry', () => { + it('creates an entry with defaults', () => { + const entry = createNavigationHistoryEntry(); + expect(entry.url).toBe(''); + expect(entry.key).toBe(''); + expect(entry.getState()).toBeUndefined(); + }); + + it('creates an entry with a custom URL', () => { + const entry = createNavigationHistoryEntry({ + url: 'https://example.com/page', + }); + expect(entry.url).toBe('https://example.com/page'); + }); + + it('creates an entry with a custom key', () => { + const entry = createNavigationHistoryEntry({key: 'my-key'}); + expect(entry.key).toBe('my-key'); + }); + + it('creates an entry with developer-defined state', () => { + const state = {items: ['hat', 'scarf']}; + const entry = createNavigationHistoryEntry({state}); + expect(entry.getState()).toStrictEqual(state); + }); + + it('returns a clone from getState(), not the original reference', () => { + const state = {count: 1}; + const entry = createNavigationHistoryEntry({state}); + const returned = entry.getState(); + expect(returned).toStrictEqual(state); + expect(returned).not.toBe(state); + }); +}); diff --git a/packages/ui-extensions-tester/src/tests/setUpExtension.test.ts b/packages/ui-extensions-tester/src/tests/setUpExtension.test.ts new file mode 100644 index 0000000000..5b49450b28 --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/setUpExtension.test.ts @@ -0,0 +1,52 @@ +import {setUpExtension, SymbolDispose} from '../index'; + +import {createTestSandbox, type TestSandbox} from './helpers'; + +describe('setUpExtension', () => { + let sandbox: TestSandbox; + + beforeEach(() => { + sandbox = createTestSandbox(); + sandbox.placeToml(); + }); + + afterEach(() => { + sandbox.destroy(); + }); + + it('calls setUp and returns a ready extension', () => { + const extension = setUpExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + // shopify global should be available without calling setUp manually + expect(extension.shopify).toBeDefined(); + expect(extension.shopify.extension.apiVersion).toBeDefined(); + }); + + it('tears down when Symbol.dispose is called', () => { + const extension = setUpExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + expect((globalThis as any).shopify).toBeDefined(); + extension[SymbolDispose](); + expect((globalThis as any).shopify).toBeUndefined(); + }); + + it('supports repeated setUp/tearDown cycles via setUpExtension', () => { + // First cycle + const ext1 = setUpExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + expect((globalThis as any).shopify).toBeDefined(); + ext1[SymbolDispose](); + expect((globalThis as any).shopify).toBeUndefined(); + + // Second cycle (reuses cached Extension) + const ext2 = setUpExtension('purchase.checkout.block.render', { + configSearchDir: sandbox.tempDir, + }); + expect((globalThis as any).shopify).toBeDefined(); + ext2[SymbolDispose](); + expect((globalThis as any).shopify).toBeUndefined(); + }); +}); diff --git a/packages/ui-extensions-tester/src/tests/shopify-events.test.ts b/packages/ui-extensions-tester/src/tests/shopify-events.test.ts new file mode 100644 index 0000000000..1748bd934e --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/shopify-events.test.ts @@ -0,0 +1,173 @@ +import type { + CashTrackingSessionStartEvent, + TransactionCompleteEvent, +} from '@shopify/ui-extensions/point-of-sale'; + +import {getExtension} from '../index'; + +import {createTestSandbox, type TestSandbox} from './helpers'; + +function makeTransactionCompleteEvent(): TransactionCompleteEvent { + return { + transactionType: 'Sale' as const, + discounts: [], + taxTotal: {amount: 0, currency: 'USD'}, + subtotal: {amount: 0, currency: 'USD'}, + grandTotal: {amount: 0, currency: 'USD'}, + paymentMethods: [], + balanceDue: {amount: 0, currency: 'USD'}, + shippingLines: [], + taxLines: [], + executedAt: '2024-01-01T00:00:00Z', + lineItems: [], + }; +} + +function makeCashTrackingSessionStartEvent(): CashTrackingSessionStartEvent { + return { + id: 1, + openingTime: '2024-01-01T00:00:00Z', + }; +} + +describe('shopify.addEventListener / extension.dispatch', () => { + let sandbox: TestSandbox; + + beforeEach(() => { + sandbox = createTestSandbox(); + sandbox.placeToml({target: 'pos.app.ready.data'}); + }); + + afterEach(() => { + sandbox.destroy(); + }); + + function setUpExt() { + const extension = getExtension('pos.app.ready.data', { + configSearchDir: sandbox.tempDir, + }); + extension.setUp(); + return extension; + } + + it('exposes addEventListener and removeEventListener on the shopify global', () => { + setUpExt(); + const shopify = (globalThis as any).shopify; + expect(typeof shopify.addEventListener).toBe('function'); + expect(typeof shopify.removeEventListener).toBe('function'); + }); + + it('dispatches a registered listener with the provided event payload', () => { + const extension = setUpExt(); + const shopify = (globalThis as any).shopify; + const listener = jest.fn(); + shopify.addEventListener('transactioncomplete', listener); + + const event = makeTransactionCompleteEvent(); + extension.dispatch('transactioncomplete', event); + + expect(listener).toHaveBeenCalledTimes(1); + expect(listener).toHaveBeenCalledWith(event); + }); + + it('fires all listeners registered for the same event', () => { + const extension = setUpExt(); + const shopify = (globalThis as any).shopify; + const listenerA = jest.fn(); + const listenerB = jest.fn(); + shopify.addEventListener('transactioncomplete', listenerA); + shopify.addEventListener('transactioncomplete', listenerB); + + const event = makeTransactionCompleteEvent(); + extension.dispatch('transactioncomplete', event); + + expect(listenerA).toHaveBeenCalledWith(event); + expect(listenerB).toHaveBeenCalledWith(event); + }); + + it('does not fire other events when dispatching one', () => { + const extension = setUpExt(); + const shopify = (globalThis as any).shopify; + const target = jest.fn(); + const other = jest.fn(); + shopify.addEventListener('transactioncomplete', target); + shopify.addEventListener('cashtrackingsessionstart', other); + + extension.dispatch('transactioncomplete', makeTransactionCompleteEvent()); + + expect(target).toHaveBeenCalledTimes(1); + expect(other).not.toHaveBeenCalled(); + }); + + it('stops calling a listener after removeEventListener', () => { + const extension = setUpExt(); + const shopify = (globalThis as any).shopify; + const listener = jest.fn(); + shopify.addEventListener('transactioncomplete', listener); + shopify.removeEventListener('transactioncomplete', listener); + + extension.dispatch('transactioncomplete', makeTransactionCompleteEvent()); + + expect(listener).not.toHaveBeenCalled(); + }); + + it('only fires once when the same listener is added twice', () => { + const extension = setUpExt(); + const shopify = (globalThis as any).shopify; + const listener = jest.fn(); + shopify.addEventListener('transactioncomplete', listener); + shopify.addEventListener('transactioncomplete', listener); + + extension.dispatch('transactioncomplete', makeTransactionCompleteEvent()); + + expect(listener).toHaveBeenCalledTimes(1); + }); + + it('isolates listener errors so later listeners still run', () => { + const extension = setUpExt(); + const shopify = (globalThis as any).shopify; + const throwing = jest.fn(() => { + throw new Error('boom'); + }); + const follower = jest.fn(); + shopify.addEventListener('transactioncomplete', throwing); + shopify.addEventListener('transactioncomplete', follower); + + expect(() => + extension.dispatch('transactioncomplete', makeTransactionCompleteEvent()), + ).not.toThrow(); + expect(throwing).toHaveBeenCalledTimes(1); + expect(follower).toHaveBeenCalledTimes(1); + }); + + it('is a no-op when dispatching an event with no registered listeners', () => { + const extension = setUpExt(); + expect(() => + extension.dispatch( + 'cashtrackingsessionstart', + makeCashTrackingSessionStartEvent(), + ), + ).not.toThrow(); + }); + + it('clears listeners on tearDown so they do not leak across tests', () => { + const extension = setUpExt(); + const shopify = (globalThis as any).shopify; + const leaked = jest.fn(); + shopify.addEventListener('transactioncomplete', leaked); + extension.tearDown(); + + extension.setUp(); + extension.dispatch('transactioncomplete', makeTransactionCompleteEvent()); + + expect(leaked).not.toHaveBeenCalled(); + }); + + it('removeEventListener on a non-registered listener is a no-op', () => { + setUpExt(); + const shopify = (globalThis as any).shopify; + expect(() => + shopify.removeEventListener('transactioncomplete', () => {}), + ).not.toThrow(); + }); +}); diff --git a/packages/ui-extensions-tester/src/tests/type-assertions.ts b/packages/ui-extensions-tester/src/tests/type-assertions.ts new file mode 100644 index 0000000000..e84d1ccf89 --- /dev/null +++ b/packages/ui-extensions-tester/src/tests/type-assertions.ts @@ -0,0 +1,9 @@ +export type Equals = (() => T extends A ? 1 : 2) extends < + T, +>() => T extends B ? 1 : 2 + ? true + : false; + +export function assertType<_T extends true>(): void { + return undefined; +} diff --git a/packages/ui-extensions-tester/tsconfig.json b/packages/ui-extensions-tester/tsconfig.json new file mode 100644 index 0000000000..80d464610d --- /dev/null +++ b/packages/ui-extensions-tester/tsconfig.json @@ -0,0 +1,27 @@ +{ + "extends": "../../config/typescript/tsconfig.base.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "build/ts", + "stripInternal": true, + "lib": ["es2018", "esnext", "dom"], + "baseUrl": ".", + "paths": { + "@shopify/ui-extensions/checkout": [ + "../ui-extensions/build/ts/surfaces/checkout" + ], + "@shopify/ui-extensions/admin": [ + "../ui-extensions/build/ts/surfaces/admin" + ], + "@shopify/ui-extensions/customer-account": [ + "../ui-extensions/build/ts/surfaces/customer-account" + ], + "@shopify/ui-extensions/point-of-sale": [ + "../ui-extensions/build/ts/surfaces/point-of-sale" + ] + } + }, + "include": ["src/**/*.ts"], + "exclude": ["src/**/tests/**"], + "references": [{"path": "../ui-extensions"}] +} diff --git a/packages/ui-extensions-tester/tsconfig.typecheck.json b/packages/ui-extensions-tester/tsconfig.typecheck.json new file mode 100644 index 0000000000..b954021f9d --- /dev/null +++ b/packages/ui-extensions-tester/tsconfig.typecheck.json @@ -0,0 +1,11 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build/ts-test", + "noEmit": true, + "emitDeclarationOnly": false + }, + "include": ["src/**/*.ts"], + "exclude": [] +} diff --git a/packages/ui-extensions/CHANGELOG.md b/packages/ui-extensions/CHANGELOG.md index e6c9838b79..00423e3035 100644 --- a/packages/ui-extensions/CHANGELOG.md +++ b/packages/ui-extensions/CHANGELOG.md @@ -1,5 +1,180 @@ # @shopify/ui-extensions +## 2026.7.0-rc.7 + +### Patch Changes + +- [#4511](https://github.com/Shopify/ui-extensions/pull/4511) [`f972657`](https://github.com/Shopify/ui-extensions/commit/f972657cc48c1b6a674f55ccb586e56d5be35e80) Thanks [@lsit](https://github.com/lsit)! - Expose the `padding` prop on the checkout and customer account `s-section` components. + +## 2026.7.0-rc.6 + +### Minor Changes + +- [#4489](https://github.com/Shopify/ui-extensions/pull/4489) [`8f27436`](https://github.com/Shopify/ui-extensions/commit/8f274366bdae412475113320e77bf1b6042ee735) Thanks [@akhayoon](https://github.com/akhayoon)! - Add `session.staffMember` for POS UI extensions so extensions can read and subscribe to the currently pinned staff member. + +### Patch Changes + +- [#4491](https://github.com/Shopify/ui-extensions/pull/4491) [`2399687`](https://github.com/Shopify/ui-extensions/commit/23996878ba8d12aa290a14b0f267d28ead3781f7) Thanks [@jasonblickhan](https://github.com/jasonblickhan)! - Add `admin.abandoned-checkout-index.action.render` and `admin.abandoned-checkout-index.action.should-render` extension targets for the abandoned checkout index page. This mirrors the action targets already available on other resource index pages (orders, customers, products, draft orders, etc.) and unblocks `admin.abandoned-checkout-index.action.link` admin link extensions. + +- [#4468](https://github.com/Shopify/ui-extensions/pull/4468) [`84c8acd`](https://github.com/Shopify/ui-extensions/commit/84c8acd397c77dd9f34f75b93f0b3516e66f08a5) Thanks [@JoviDeCroock](https://github.com/JoviDeCroock)! - Narrow `AppHomeApi.intents` to a new `AppHomeIntents` shape that exposes a signal-like `request` so the runtime can stream link intents into a long-lived `admin.app.home.render` extension. `WithGeneratedIntents` continues to narrow `request.value` to the CLI-generated variants. + +- [#4468](https://github.com/Shopify/ui-extensions/pull/4468) [`84c8acd`](https://github.com/Shopify/ui-extensions/commit/84c8acd397c77dd9f34f75b93f0b3516e66f08a5) Thanks [@JoviDeCroock](https://github.com/JoviDeCroock)! - Expose the `Tools` API on `AppHomeApi` so `admin.app.home.render` extensions can call `shopify.tools.register(...)` even before the CLI generates typed overloads. Adds a matching mock to `@shopify/ui-extensions-tester`. + +- [#4476](https://github.com/Shopify/ui-extensions/pull/4476) [`338a696`](https://github.com/Shopify/ui-extensions/commit/338a696739672a058813810771d737d84bee5559) Thanks [@lsit](https://github.com/lsit)! - Update docs for inlineSize prop on customer account Page component + +- [#4477](https://github.com/Shopify/ui-extensions/pull/4477) [`d607e02`](https://github.com/Shopify/ui-extensions/commit/d607e026f6652eafa19a1a3c8352a431b9ecc47b) Thanks [@shivinmisra-shopify](https://github.com/shivinmisra-shopify)! - Add optional `cashRoundingAdjustment` money data to POS transaction-complete payload types. + +- [#4455](https://github.com/Shopify/ui-extensions/pull/4455) [`fe62c86`](https://github.com/Shopify/ui-extensions/commit/fe62c86217956ebf72c6b8e63b81d226f3a97da4) Thanks [@justinhenricks](https://github.com/justinhenricks)! - Add `textAlign` prop to the checkout `Paragraph` component, supporting `'start'`, `'end'`, `'center'`, and `'auto'` values. + +- [#4466](https://github.com/Shopify/ui-extensions/pull/4466) [`cc5f4b3`](https://github.com/Shopify/ui-extensions/commit/cc5f4b3d624bcf12bb0ce4d8dc7d71ee0494ad1e) Thanks [@vctrchu](https://github.com/vctrchu)! - Narrow the `pos.app.ready.data` cart API surface to readonly. The background extension target's `shopify.cart` now only exposes the subscribable `current` signal; cart mutation methods (`addLineItem`, `clearCart`, `applyCartDiscount`, `setCustomer`, etc.) are not typed on this target. Cart mutation remains available to interactive render targets via the unchanged `CartApi`. + + Internally this splits `CartApiContent` into `ReadonlyCartApiContent` + `MutableCartApiContent` (both re-exported), and introduces `ReadonlyCartApi` for use in `DataTargetApi`. + +## 2026.7.0-rc.5 + +### Patch Changes + +- [#4454](https://github.com/Shopify/ui-extensions/pull/4454) [`be8c9e2`](https://github.com/Shopify/ui-extensions/commit/be8c9e206525a41f2544810a328d901e2cdcbb95) Thanks [@lsit](https://github.com/lsit)! - Add inlineSize to the customer account Page component + +## 2026.7.0-rc.4 + +### Patch Changes + +- [#4442](https://github.com/Shopify/ui-extensions/pull/4442) [`060e669`](https://github.com/Shopify/ui-extensions/commit/060e669fb5ff34b30f7e8a8fb1b2696e038a4938) Thanks [@justinhenricks](https://github.com/justinhenricks)! - The `label` prop on the checkout and customer-account `s-checkbox` component now accepts a label as a slot in addition to a plain string, label slots can include only plain text and s-links. + +## 2026.7.0-rc.3 + +### Patch Changes + +- [#4334](https://github.com/Shopify/ui-extensions/pull/4334) [`234aead`](https://github.com/Shopify/ui-extensions/commit/234aead78ce9ac90077a67fbc219897832aafd74) Thanks [@henrytao-me](https://github.com/henrytao-me)! - Add admin.app.home.render extension target + +- [#4346](https://github.com/Shopify/ui-extensions/pull/4346) [`ea1b6f4`](https://github.com/Shopify/ui-extensions/commit/ea1b6f4c725cc61efa03f4d859ba82ea3d50c2d1) Thanks [@JoviDeCroock](https://github.com/JoviDeCroock)! - Match correctly on optional response + +- [#4349](https://github.com/Shopify/ui-extensions/pull/4349) [`f2b2b10`](https://github.com/Shopify/ui-extensions/commit/f2b2b10e99c4672c38b83cc048c2de93abbb7444) Thanks [@vividviolet](https://github.com/vividviolet)! - Publish package with admin.app.home.render target + +## 2026.7.0-rc.2 + +### Patch Changes + +- [#4335](https://github.com/Shopify/ui-extensions/pull/4335) [`bf2184a`](https://github.com/Shopify/ui-extensions/commit/bf2184a8d55a756533c46a60bf022653b7bfc423) Thanks [@JoviDeCroock](https://github.com/JoviDeCroock)! - Add generic helper types for intents + +## 2026.7.0-rc.1 + +### Major Changes + +- [`eb74ecc`](https://github.com/Shopify/ui-extensions/commit/eb74eccd35fdf7b6a780320c6eb3830cee7ea24f) Thanks [@lrsterrett](https://github.com/lrsterrett)! - 2026-07-rc release + +## 2026.4.0 + +### Major Changes + +- [`77d447c`](https://github.com/Shopify/ui-extensions/commit/77d447c7f34151d3af49f6b7c4bc987558eec292) Thanks [@lrsterrett](https://github.com/lrsterrett)! - 2026-04-rc release + +### Minor Changes + +- [#4079](https://github.com/Shopify/ui-extensions/pull/4079) [`db7cec2`](https://github.com/Shopify/ui-extensions/commit/db7cec21f1fd428115d4540158f235a714b585de) Thanks [@avocadomayo](https://github.com/avocadomayo)! - Remove checkout metafields in favour of cart metafields + +- [#4010](https://github.com/Shopify/ui-extensions/pull/4010) [`b60a9a1`](https://github.com/Shopify/ui-extensions/commit/b60a9a18a1da763fe8c9c01ce4911c4754926cce) Thanks [@avocadomayo](https://github.com/avocadomayo)! - - [Customer accounts] Remove checkout metafields in favour of app metafields + + - [Customer accounts] Update component categories + +- [#4178](https://github.com/Shopify/ui-extensions/pull/4178) [`7408712`](https://github.com/Shopify/ui-extensions/commit/7408712b9d85eb4464560bf2078aa2a81a1ff3af) Thanks [@mauriciosierra](https://github.com/mauriciosierra)! - Add optional refundId, returnId, exchangeId, lineItemsAdded, and lineItemsRemoved fields to ReprintReceiptData to support reprinting return and exchange receipts. + +- [#3778](https://github.com/Shopify/ui-extensions/pull/3778) [`d1c35f2`](https://github.com/Shopify/ui-extensions/commit/d1c35f25cc86dfa1dcf8934a7b7cf5fa9856846a) Thanks [@merkoyep](https://github.com/merkoyep)! - add deviceId to SessionApi + +### Patch Changes + +- [#4251](https://github.com/Shopify/ui-extensions/pull/4251) [`a5c2bbf`](https://github.com/Shopify/ui-extensions/commit/a5c2bbf71decdf210d46ad4d6dc814faa6c0912f) Thanks [@JoviDeCroock](https://github.com/JoviDeCroock)! - Add admin.app.intent.render target + +- [#4148](https://github.com/Shopify/ui-extensions/pull/4148) [`3b9614b`](https://github.com/Shopify/ui-extensions/commit/3b9614b572b7eb84715dc7656364ad38c9a4ead2) Thanks [@lrsterrett](https://github.com/lrsterrett)! - Remove types for `ui` from checkout ui extension api as `ui` wasn't supported since 2025.10.0 For reference, closing a modal can be done declaritively on the modal polaris component, instead of the deprecated `ui.overlay.close` + +- [#3970](https://github.com/Shopify/ui-extensions/pull/3970) [`6c3ac55`](https://github.com/Shopify/ui-extensions/commit/6c3ac5559c50553314cdea0993e39fcf853cc3d0) Thanks [@jonathanhamel4](https://github.com/jonathanhamel4)! - Api types for discount classes are incorrect with the admin-web + +- [#3785](https://github.com/Shopify/ui-extensions/pull/3785) [`acd9002`](https://github.com/Shopify/ui-extensions/commit/acd9002d9d8768732bbbf19eccae268ffde9a07b) Thanks [@billfienberg](https://github.com/billfienberg)! - Admin: Expose picker and resource picker APIs for all rendering extensions + +- [#4072](https://github.com/Shopify/ui-extensions/pull/4072) [`12df6f9`](https://github.com/Shopify/ui-extensions/commit/12df6f92b68bca036132b3c54a69e28e15330a65) Thanks [@avocadomayo](https://github.com/avocadomayo)! - [Checkout] Update code examples + +- [#4078](https://github.com/Shopify/ui-extensions/pull/4078) [`21566b3`](https://github.com/Shopify/ui-extensions/commit/21566b391651653c8e3d626811d5b787b26f9fe3) Thanks [@jonathanhamel4](https://github.com/jonathanhamel4)! - Adds discount-index.selection-action extension point + +## 2026.4.0-rc.3 + +### Minor Changes + +- [#4178](https://github.com/Shopify/ui-extensions/pull/4178) [`7408712`](https://github.com/Shopify/ui-extensions/commit/7408712b9d85eb4464560bf2078aa2a81a1ff3af) Thanks [@mauriciosierra](https://github.com/mauriciosierra)! - Add optional refundId, returnId, exchangeId, lineItemsAdded, and lineItemsRemoved fields to ReprintReceiptData to support reprinting return and exchange receipts. + +### Patch Changes + +- [#4148](https://github.com/Shopify/ui-extensions/pull/4148) [`3b9614b`](https://github.com/Shopify/ui-extensions/commit/3b9614b572b7eb84715dc7656364ad38c9a4ead2) Thanks [@lrsterrett](https://github.com/lrsterrett)! - Remove types for `ui` from checkout ui extension api as `ui` wasn't supported since 2025.10.0 For reference, closing a modal can be done declaritively on the modal polaris component, instead of the deprecated `ui.overlay.close` + +## 2026.4.0-rc.2 + +### Minor Changes + +- [#4079](https://github.com/Shopify/ui-extensions/pull/4079) [`db7cec2`](https://github.com/Shopify/ui-extensions/commit/db7cec21f1fd428115d4540158f235a714b585de) Thanks [@avocadomayo](https://github.com/avocadomayo)! - Remove checkout metafields in favour of cart metafields + +- [#4010](https://github.com/Shopify/ui-extensions/pull/4010) [`b60a9a1`](https://github.com/Shopify/ui-extensions/commit/b60a9a18a1da763fe8c9c01ce4911c4754926cce) Thanks [@avocadomayo](https://github.com/avocadomayo)! - - [Customer accounts] Remove checkout metafields in favour of app metafields + - [Customer accounts] Update component categories + +### Patch Changes + +- [#3970](https://github.com/Shopify/ui-extensions/pull/3970) [`6c3ac55`](https://github.com/Shopify/ui-extensions/commit/6c3ac5559c50553314cdea0993e39fcf853cc3d0) Thanks [@jonathanhamel4](https://github.com/jonathanhamel4)! - Api types for discount classes are incorrect with the admin-web + +- [#4072](https://github.com/Shopify/ui-extensions/pull/4072) [`12df6f9`](https://github.com/Shopify/ui-extensions/commit/12df6f92b68bca036132b3c54a69e28e15330a65) Thanks [@avocadomayo](https://github.com/avocadomayo)! - [Checkout] Update code examples + +- [#4078](https://github.com/Shopify/ui-extensions/pull/4078) [`21566b3`](https://github.com/Shopify/ui-extensions/commit/21566b391651653c8e3d626811d5b787b26f9fe3) Thanks [@jonathanhamel4](https://github.com/jonathanhamel4)! - Adds discount-index.selection-action extension point + +## 2026.4.0-rc.1 + +### Minor Changes + +- [#3778](https://github.com/Shopify/ui-extensions/pull/3778) [`d1c35f2`](https://github.com/Shopify/ui-extensions/commit/d1c35f25cc86dfa1dcf8934a7b7cf5fa9856846a) Thanks [@merkoyep](https://github.com/merkoyep)! - add deviceId to SessionApi + +### Patch Changes + +- [#3785](https://github.com/Shopify/ui-extensions/pull/3785) [`acd9002`](https://github.com/Shopify/ui-extensions/commit/acd9002d9d8768732bbbf19eccae268ffde9a07b) Thanks [@billfienberg](https://github.com/billfienberg)! - Admin: Expose picker and resource picker APIs for all rendering extensions + +## 2026.4.0-rc.0 + +### Major Changes + +- [#3761](https://github.com/Shopify/ui-extensions/pull/3761) [`77d447c`](https://github.com/Shopify/ui-extensions/commit/77d447c7f34151d3af49f6b7c4bc987558eec292) Thanks [@shopify-github-actions-access](https://github.com/apps/shopify-github-actions-access)! - 2026-04-rc release + +## 2026.1.0 + +### Minor Changes + +- [#3529](https://github.com/Shopify/ui-extensions/pull/3529) [`afa47f1`](https://github.com/Shopify/ui-extensions/commit/afa47f1e00c86f69ff08606f9770aa513e8529f1) Thanks [@merkoyep](https://github.com/merkoyep)! - implements the cash drawer api to the ui extensions repository + +- [#3603](https://github.com/Shopify/ui-extensions/pull/3603) [`e7892d6`](https://github.com/Shopify/ui-extensions/commit/e7892d6ef3f6b7281f5b22a41b7c8e43b49e68e0) Thanks [@prakashraman](https://github.com/prakashraman)! - Remove accessory slot from TextArea component + +- [#3534](https://github.com/Shopify/ui-extensions/pull/3534) [`8e4bf19`](https://github.com/Shopify/ui-extensions/commit/8e4bf19b2420cb8bf89f0ed20ea0bb7597200bd5) Thanks [@merkoyep](https://github.com/merkoyep)! - Adds register details targets + +- [#3738](https://github.com/Shopify/ui-extensions/pull/3738) [`cf12217`](https://github.com/Shopify/ui-extensions/commit/cf12217ba05f86ecc886a3471c26afbccfce914f) Thanks [@jolenehayes](https://github.com/jolenehayes)! - Add registerName field to the Device Api + +- [#3597](https://github.com/Shopify/ui-extensions/pull/3597) [`6b20b88`](https://github.com/Shopify/ui-extensions/commit/6b20b88010b4c329f654aa7b84a08124e693ec74) Thanks [@fatbattk](https://github.com/fatbattk)! - Add Camera API types + +- [#3536](https://github.com/Shopify/ui-extensions/pull/3536) [`58fef36`](https://github.com/Shopify/ui-extensions/commit/58fef364a8378a824a51e4697d83ae2d28d46f2f) Thanks [@alexgraffeocohen](https://github.com/alexgraffeocohen)! - Adds components to point of sale cart LineItem interface to represent product bundle items. + +- [#3641](https://github.com/Shopify/ui-extensions/pull/3641) [`9440bde`](https://github.com/Shopify/ui-extensions/commit/9440bde5390d2940befc1037370217d16455dff2) Thanks [@jonathanhamel4](https://github.com/jonathanhamel4)! - Added subscribable discounts api. Update the type for `data.id` to string to fix a previously incorrect type. + +### Patch Changes + +- [#3729](https://github.com/Shopify/ui-extensions/pull/3729) [`2920d36`](https://github.com/Shopify/ui-extensions/commit/2920d36f66735f552b6cd9fe3738f934618b7b4f) Thanks [@kbav](https://github.com/kbav)! - Add admin.app.tools.data extension target + +- [#3521](https://github.com/Shopify/ui-extensions/pull/3521) [`9f7afff`](https://github.com/Shopify/ui-extensions/commit/9f7afffcef86bcc8c6a9fef89ada580351082d9c) Thanks [@lrsterrett](https://github.com/lrsterrett)! - 2026.1.0-rc release + +- [#3650](https://github.com/Shopify/ui-extensions/pull/3650) [`01fb914`](https://github.com/Shopify/ui-extensions/commit/01fb914a0ddbe520698607acd780d59787deb769) Thanks [@andy-chhuon](https://github.com/andy-chhuon)! - new oidc deploy workflow + +- [#3695](https://github.com/Shopify/ui-extensions/pull/3695) [`397d749`](https://github.com/Shopify/ui-extensions/commit/397d7496e9cab5634da11dca5b78a3bde1b5ffe1) Thanks [@jonathanhamel4](https://github.com/jonathanhamel4)! - Remove unsupported fields for the Discount API. Those fields will be added in a later API. + +- [#3652](https://github.com/Shopify/ui-extensions/pull/3652) [`54f38ee`](https://github.com/Shopify/ui-extensions/commit/54f38eeb798dee46f29eb146749a99d2634c6b49) Thanks [@andy-chhuon](https://github.com/andy-chhuon)! - Bump node version to v20.19.6 + +- [#3590](https://github.com/Shopify/ui-extensions/pull/3590) [`81c0416`](https://github.com/Shopify/ui-extensions/commit/81c0416e8b5772a2fe74e04d8f8d4263e4d61073) Thanks [@chadcromwell](https://github.com/chadcromwell)! - Add optional tipAmount field to POS transaction data types + +- [#3730](https://github.com/Shopify/ui-extensions/pull/3730) [`280778e`](https://github.com/Shopify/ui-extensions/commit/280778e6a873f70635e2b43e4bc3ec4617cb2520) Thanks [@lrsterrett](https://github.com/lrsterrett)! - recommend merchant friendly warning for enabling checkout extension to block progress + +- [#3574](https://github.com/Shopify/ui-extensions/pull/3574) [`2a6dddb`](https://github.com/Shopify/ui-extensions/commit/2a6dddbbd033c6c082ca513fcb62bc87523fa41e) Thanks [@alexgraffeocohen](https://github.com/alexgraffeocohen)! - Exports LineItemComponent from point-of-sale API so POS can import the type + ## 2026.1.0-rc.5 ### Patch Changes diff --git a/packages/ui-extensions/buildTargetDts.ts b/packages/ui-extensions/buildTargetDts.ts index 6032f8ca9a..5704d68937 100644 --- a/packages/ui-extensions/buildTargetDts.ts +++ b/packages/ui-extensions/buildTargetDts.ts @@ -28,6 +28,7 @@ function copyComponentDefinitions({ if (!existsSync(buildPath)) { mkdirSync(buildPath, {recursive: true}); } + mkdirSync(componentsBuildPath, {recursive: true}); const exists = componentsSrcPaths.every((path) => existsSync(path)); @@ -58,10 +59,12 @@ function createInitialTargetDefinition({ buildPath, name, surface, + isDataTarget, }: { buildPath: string; name: string; surface: string; + isDataTarget: boolean; }) { const parts = name.replaceAll("'", '').split('.'); const fileName = `${parts.join('.')}.d.ts`; @@ -73,6 +76,14 @@ function createInitialTargetDefinition({ surface === 'customer-account' || surface === 'point-of-sale' ? `import '../globals';\n` : '' + }${ + surface === 'point-of-sale' + ? `export type * from '../events';\n${ + isDataTarget + ? `export type {BackgroundShopifyGlobal as ShopifyGlobal} from '../globals';\n` + : '' + }` + : '' } type Target = ExtensionTargets[${name}]; export type Api = Target['api']; @@ -133,10 +144,12 @@ function getTargets(sourceFile: SourceFile) { // Target definitions function extractTargetComponents( sourceFile: SourceFile, -): {name: string; components?: string[]}[] { +): {name: string; components?: string[]; isDataTarget: boolean}[] { const extensionTargetArray = getTargets(sourceFile); return extensionTargetArray .map((extensionTargets) => { + const isDataTarget = + extensionTargets.getName() === 'DataExtensionTargets'; return extensionTargets.getProperties().map((property) => { const componentsType = property .getType() @@ -158,6 +171,7 @@ function extractTargetComponents( return { name: property.getName(), components, + isDataTarget, }; }); }) @@ -169,15 +183,20 @@ function createTargetDefinition({ buildPath, project, surface, - target: {name, components}, + target: {name, components, isDataTarget}, }: { srcPaths: string[]; buildPath: string; project: Project; surface: string; - target: {name: string; components?: string[]}; + target: {name: string; components?: string[]; isDataTarget: boolean}; }) { - const targetPath = createInitialTargetDefinition({name, surface, buildPath}); + const targetPath = createInitialTargetDefinition({ + name, + surface, + buildPath, + isDataTarget, + }); const targetFile = project.addSourceFileAtPath(targetPath); const names = new Set(); diff --git a/packages/ui-extensions/docs/shared/build-docs-type-resolver.mjs b/packages/ui-extensions/docs/shared/build-docs-type-resolver.mjs new file mode 100644 index 0000000000..fbc24988cc --- /dev/null +++ b/packages/ui-extensions/docs/shared/build-docs-type-resolver.mjs @@ -0,0 +1,406 @@ +/* eslint-disable no-console */ +/* eslint-env node */ +/** + * Shared type resolver for build-docs-targets-json scripts + * + * This module provides utilities for parsing TypeScript type definitions + * and resolving component types, including handling of: + * - String literals: 'ComponentName' + * - Type references: TypeName + * - Union types: A | B | C + * - Exclude types: Exclude + * - Array types: (typeof ARRAY)[number] + * - @private JSDoc tags for excluding private components + */ + +import fs from 'fs'; + +/** + * Creates a type resolver instance for a specific surface + * @param {string} sharedTsPath - Path to the shared.ts file for the surface + * @returns {Object} Type resolver with methods for resolving types + */ +export function createTypeResolver(sharedTsPath) { + // Cache for type definitions parsed from shared.ts + let typeDefinitionsCache = null; + const resolvedTypesCache = {}; + // Set of type names that are marked with @private JSDoc tag + let privateTypesCache = null; + + /** + * Parse all type definitions from shared.ts + * Returns a map of type name -> type definition string + * Also detects @private JSDoc tags to identify private types + */ + function parseTypeDefinitions() { + if (typeDefinitionsCache !== null) { + return typeDefinitionsCache; + } + + typeDefinitionsCache = {}; + privateTypesCache = new Set(); + + try { + if (!fs.existsSync(sharedTsPath)) { + return typeDefinitionsCache; + } + + const content = fs.readFileSync(sharedTsPath, 'utf-8'); + + // Parse const arrays (like SUPPORTED_COMPONENTS) - store as resolved arrays + const constArrayRegex = + /export const (\w+)\s*=\s*\[([\s\S]*?)\]\s*as const/g; + let constMatch; + while ((constMatch = constArrayRegex.exec(content)) !== null) { + const constName = constMatch[1]; + const arrayContent = constMatch[2]; + const components = arrayContent.match(/'([^']+)'/g); + if (components) { + typeDefinitionsCache[constName] = components.map((component) => + component.replace(/'/g, ''), + ); + } + } + + // Parse all type definitions: export type TypeName = Definition; + // Also check for @private JSDoc comments preceding the type + const typeRegex = /export type (\w+)(?:<[^>]+>)?\s*=\s*/g; + let match; + + while ((match = typeRegex.exec(content)) !== null) { + const typeName = match[1]; + const startPos = match.index + match[0].length; + + // Check for @private in JSDoc comment before this type definition + // Look backwards from the match to find a preceding JSDoc comment + const beforeMatch = content.substring(0, match.index); + const lastJsDocEnd = beforeMatch.lastIndexOf('*/'); + if (lastJsDocEnd !== -1) { + // Check if there's no other code between the JSDoc and this type + const between = beforeMatch.substring(lastJsDocEnd + 2).trim(); + if (between === '') { + // Find the start of this JSDoc comment + const jsDocStart = beforeMatch.lastIndexOf('/**'); + if (jsDocStart !== -1) { + const jsDocContent = beforeMatch.substring( + jsDocStart, + lastJsDocEnd + 2, + ); + // Check if this JSDoc contains @private tag + if (jsDocContent.includes('@private')) { + privateTypesCache.add(typeName); + } + } + } + } + + // Find the end of the type definition (semicolon at depth 0) + let endPos = startPos; + let depth = 0; + let inString = false; + + for (let i = startPos; i < content.length; i++) { + const char = content[i]; + const prevChar = i > 0 ? content[i - 1] : ''; + + if (char === "'" && prevChar !== '\\') { + inString = !inString; + } + + if (!inString) { + if (char === '<' || char === '(' || char === '{' || char === '[') { + depth++; + } else if ( + char === '>' || + char === ')' || + char === '}' || + char === ']' + ) { + depth--; + } else if (char === ';' && depth === 0) { + endPos = i; + break; + } + } + } + + const definition = content.substring(startPos, endPos).trim(); + typeDefinitionsCache[typeName] = definition; + } + + return typeDefinitionsCache; + } catch (error) { + console.warn('Warning: Failed to parse type definitions:', error.message); + return typeDefinitionsCache; + } + } + + /** + * Check if a type is marked as @private + */ + function isPrivateType(typeName) { + // Ensure type definitions are parsed (which also populates privateTypesCache) + parseTypeDefinitions(); + return privateTypesCache && privateTypesCache.has(typeName); + } + + /** + * Get the components from @private types (to exclude them from other types) + */ + function getPrivateComponents() { + parseTypeDefinitions(); + const privateComponents = []; + if (privateTypesCache) { + for (const typeName of privateTypesCache) { + const resolved = resolveTypeInternal(typeName, false); // Don't filter private when getting private components + privateComponents.push(...resolved); + } + } + return privateComponents; + } + + /** + * Internal type resolver - can optionally skip filtering of @private components + * @param {string} typeExpr - The type expression to resolve + * @param {boolean} filterPrivate - Whether to filter out @private components (default: true) + */ + function resolveTypeInternal(typeExpr, filterPrivate = true) { + if (!typeExpr) return []; + + const trimmedTypeExpr = typeExpr.trim(); + + // Check cache first (but only for filtered results) + const cacheKey = filterPrivate + ? trimmedTypeExpr + : `__unfiltered__${trimmedTypeExpr}`; + if (resolvedTypesCache[cacheKey]) { + return [...resolvedTypesCache[cacheKey]]; + } + + const typeDefs = parseTypeDefinitions(); + let result = []; + + // Handle string literal: 'ComponentName' + const stringLiteralMatch = trimmedTypeExpr.match(/^'([^']+)'$/); + if (stringLiteralMatch) { + result = [stringLiteralMatch[1]]; + resolvedTypesCache[cacheKey] = result; + return [...result]; + } + + // IMPORTANT: Check for unions FIRST before other patterns + // This ensures we don't match partial patterns within a union + if (trimmedTypeExpr.includes('|')) { + const parts = splitByTopLevelPipe(typeExpr); + // Only treat as union if we actually got multiple parts + if (parts.filter((part) => part.trim()).length > 1) { + for (const part of parts) { + const trimmed = part.trim(); + if (trimmed) { + result.push(...resolveTypeInternal(trimmed, filterPrivate)); + } + } + // Deduplicate + result = [...new Set(result)]; + resolvedTypesCache[cacheKey] = result; + return [...result]; + } + } + + // Handle (typeof ARRAY_NAME)[number] - anchored to match entire expression + const typeofMatch = trimmedTypeExpr.match(/^\(typeof (\w+)\)\[number\]$/); + if (typeofMatch) { + const arrayName = typeofMatch[1]; + if (Array.isArray(typeDefs[arrayName])) { + result = [...typeDefs[arrayName]]; + resolvedTypesCache[cacheKey] = result; + return [...result]; + } + } + + // Handle Exclude + const excludeMatch = trimmedTypeExpr.match(/^Exclude<(.+)>$/); + if (excludeMatch) { + const innerContent = excludeMatch[1]; + const parts = splitByTopLevelComma(innerContent); + if (parts.length >= 2) { + const baseType = parts[0].trim(); + const excludedType = parts[1].trim(); + + const baseComponents = resolveTypeInternal(baseType, filterPrivate); + const excludedComponents = resolveTypeInternal( + excludedType, + filterPrivate, + ); + + result = baseComponents.filter( + (component) => !excludedComponents.includes(component), + ); + resolvedTypesCache[cacheKey] = result; + return [...result]; + } + } + + // Handle type reference (look up in definitions and resolve recursively) + if (/^\w+$/.test(trimmedTypeExpr)) { + // If this type itself is marked @private, return empty (unless we're not filtering) + if (filterPrivate && isPrivateType(trimmedTypeExpr)) { + resolvedTypesCache[cacheKey] = []; + return []; + } + + const definition = typeDefs[trimmedTypeExpr]; + if (Array.isArray(definition)) { + // It's a pre-resolved array (like SUPPORTED_COMPONENTS) + result = [...definition]; + } else if (typeof definition === 'string') { + // Recursively resolve the definition + result = resolveTypeInternal(definition, filterPrivate); + } + resolvedTypesCache[cacheKey] = result; + return [...result]; + } + + // If we can't resolve it, return empty + resolvedTypesCache[cacheKey] = result; + return [...result]; + } + + /** + * Resolve a type expression to component strings + * Automatically excludes components from types marked with @private JSDoc tag + * @param {string} typeExpr - The type expression to resolve + * @returns {string[]} Array of component names + */ + function resolveType(typeExpr) { + // Get result with private components filtered out + let result = resolveTypeInternal(typeExpr, true); + + // Also filter out any components that come from @private types + const privateComponents = getPrivateComponents(); + if (privateComponents.length > 0) { + result = result.filter( + (component) => !privateComponents.includes(component), + ); + } + + return result; + } + + /** + * Resolve a type expression WITHOUT filtering @private components + * Use this for AllowedComponents<> which explicitly allows private components + * @param {string} typeExpr - The type expression to resolve + * @returns {string[]} Array of component names + */ + function resolveTypeUnfiltered(typeExpr) { + return resolveTypeInternal(typeExpr, false); + } + + /** + * Get the parsed type definitions (for debugging or advanced use) + */ + function getTypeDefinitions() { + return parseTypeDefinitions(); + } + + /** + * Get the set of private type names + */ + function getPrivateTypeNames() { + parseTypeDefinitions(); + return privateTypesCache ? new Set(privateTypesCache) : new Set(); + } + + return { + resolveType, + resolveTypeUnfiltered, + getTypeDefinitions, + getPrivateTypeNames, + getPrivateComponents, + isPrivateType, + }; +} + +/** + * Split a string by top-level pipe (|) characters, respecting nesting + */ +export function splitByTopLevelPipe(str) { + const parts = []; + let current = ''; + let depth = 0; + + for (let i = 0; i < str.length; i++) { + const char = str[i]; + + if (char === '<' || char === '(' || char === '{' || char === '[') { + depth++; + current += char; + } else if (char === '>' || char === ')' || char === '}' || char === ']') { + depth--; + current += char; + } else if (char === '|' && depth === 0) { + parts.push(current); + current = ''; + } else { + current += char; + } + } + + if (current) { + parts.push(current); + } + + return parts; +} + +/** + * Split a string by top-level comma (,) characters, respecting nesting + */ +export function splitByTopLevelComma(str) { + const parts = []; + let current = ''; + let angleDepth = 0; + let braceDepth = 0; + let parenDepth = 0; + + for (let i = 0; i < str.length; i++) { + const char = str[i]; + + if (char === '<') { + angleDepth++; + current += char; + } else if (char === '>') { + angleDepth--; + current += char; + } else if (char === '{') { + braceDepth++; + current += char; + } else if (char === '}') { + braceDepth--; + current += char; + } else if (char === '(') { + parenDepth++; + current += char; + } else if (char === ')') { + parenDepth--; + current += char; + } else if ( + char === ',' && + angleDepth === 0 && + braceDepth === 0 && + parenDepth === 0 + ) { + parts.push(current); + current = ''; + } else { + current += char; + } + } + + if (current) { + parts.push(current); + } + + return parts; +} diff --git a/packages/ui-extensions/docs/surfaces/admin/README.md b/packages/ui-extensions/docs/surfaces/admin/README.md new file mode 100644 index 0000000000..39d93a8397 --- /dev/null +++ b/packages/ui-extensions/docs/surfaces/admin/README.md @@ -0,0 +1,35 @@ +# Admin UI extensions docs sync workflow + +Admin UI extensions API docs are generated from this repository, usually from the quarterly API branch for the version being published, such as `2026-04`. The generated Admin docs are copied into `shopify-dev` under `db/data/docs/templated_apis/admin_extensions/`. + +## Safe order of operations + +Run the App Bridge docs sync from `Shopify/extensibility` last. This is important because `yarn docs:admin` also writes the App Home docs data at `db/data/docs/templated_apis/app_home/generated_docs_data_v2.json`. The Extensibility sync merges and preserves the App Bridge and Polaris component docs for App Home in that file. If `yarn docs:admin` runs after Extensibility `docs:sync`, it can overwrite the merged App Home data and remove those App Bridge and Polaris component docs. + +Use this order: + +1. Generate Admin UI extensions docs from `Shopify/ui-extensions` for the target API version. +2. Copy or promote the generated Admin docs into `shopify-dev` as needed. +3. From `Shopify/extensibility`, run `pnpm --dir libraries/javascript/app-bridge docs:sync `. +4. If Admin docs generation is rerun afterward for the same version, rerun the Extensibility `docs:sync` command afterward too. + +## Example for `2026-04` + +Run Admin docs generation first: + +```bash +cd /Users/mitch/src/github.com/Shopify/ui-extensions +git checkout 2026-04 +yarn workspace @shopify/ui-extensions docs:admin 2026-04 2026-04 +``` + +Copy or promote the generated Admin docs in `shopify-dev` as needed. The final Admin docs should live under `db/data/docs/templated_apis/admin_extensions/2026-04`. + +Then run the Extensibility App Bridge docs sync last: + +```bash +cd /Users/mitch/src/github.com/Shopify/extensibility +pnpm --dir libraries/javascript/app-bridge docs:sync 2026-04 +``` + +If you run `yarn workspace @shopify/ui-extensions docs:admin 2026-04 2026-04` again later, run `pnpm --dir libraries/javascript/app-bridge docs:sync 2026-04` again afterward so `app_home/generated_docs_data_v2.json` keeps the merged App Bridge and Polaris component docs. diff --git a/packages/ui-extensions/docs/surfaces/admin/ReadMe.md b/packages/ui-extensions/docs/surfaces/admin/ReadMe.md deleted file mode 100644 index a02c699d51..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/ReadMe.md +++ /dev/null @@ -1,62 +0,0 @@ -# create-doc-files.sh - -A utility script to scaffold documentation files for UI components in the ui-extensions package. - -## Usage - -```bash -./create-doc-files.sh [-t type] component_name1 [component_name2 ...] -``` - -### Options - -- `-t`: Specifies the type of documentation to create (optional) - - Valid values: `components` or `api` - - Default: `components` - -### Arguments - -- `component_name1`: Name of the component to document (required) -- `component_name2 ...`: Additional component names (optional) - -### Examples - -#### Create documentation for a single component - -```bash -./create-doc-files.sh Button -``` - -#### Create documentation for multiple components - -```bash -./create-doc-files.sh Button Card -``` - -#### Create API documentation - -```bash -./create-doc-files.sh -t api Toast -``` - -#### Create multiple API docs - -```bash -./create-doc-files.sh -t api Modal Toast -``` - -### Output - -For each component, the script creates: - -1. A component directory at `packages/ui-extensions/src/surfaces/admin/{type}/{componentName}/` -2. An examples directory containing: - - A TypeScript example (`basic-{lowercase-name}.example.ts`) - - A TSX/Preact example (`basic-{lowercase-name}.example.tsx`) -3. A documentation file (`{ComponentName}.doc.ts`) with a basic template including: - - Component metadata - - Description placeholder - - Example code references - - Category and subcategory settings - -The script will skip creating files that already exist to prevent overwriting existing documentation. diff --git a/packages/ui-extensions/docs/surfaces/admin/build-docs-targets-json.mjs b/packages/ui-extensions/docs/surfaces/admin/build-docs-targets-json.mjs new file mode 100644 index 0000000000..565cb69aa4 --- /dev/null +++ b/packages/ui-extensions/docs/surfaces/admin/build-docs-targets-json.mjs @@ -0,0 +1,726 @@ +/* eslint-disable no-console */ +/* eslint-env node */ +import fs from 'fs'; +import path from 'path'; +import {fileURLToPath} from 'url'; +import { + createTypeResolver, + splitByTopLevelComma, +} from '../../shared/build-docs-type-resolver.mjs'; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = path.dirname(__filename); + +// Find the generated_docs_data_v2.json file to determine output location +function findGeneratedDocsPath() { + const generatedDir = path.join(__dirname, 'generated'); + + // Look for generated_docs_data_v2.json recursively + function findFile(dir) { + const files = fs.readdirSync(dir); + for (const file of files) { + const fullPath = path.join(dir, file); + const stat = fs.statSync(fullPath); + if (stat.isDirectory()) { + const result = findFile(fullPath); + if (result) return result; + } else if (file === 'generated_docs_data_v2.json') { + return path.dirname(fullPath); + } + } + return null; + } + + const docsPath = findFile(generatedDir); + return docsPath || generatedDir; // Fallback to generated root if not found +} + +// Configuration for admin surface +const config = { + basePath: path.join(__dirname, '../../../src/surfaces/admin'), + outputPath: path.join(findGeneratedDocsPath(), 'targets.json'), + componentTypesPath: 'components', + hasComponentTypes: true, +}; + +// All components will be populated from StandardComponents +let allComponents = []; + +// Cache for parsed API files to avoid re-reading +const apiDefinitionsCache = {}; + +// Create type resolver for checkout's shared.ts (to resolve AnyComponent, etc.) +const checkoutSharedPath = path.join( + __dirname, + '../../../src/surfaces/checkout/shared.ts', +); +const checkoutTypeResolver = createTypeResolver(checkoutSharedPath); + +// Cache for checkout components (resolved via type resolver, excluding @private) +let checkoutComponentsCache = null; + +/** + * Parse components from checkout's shared.ts file + * Uses the shared type resolver to properly handle @private types + */ +function parseCheckoutComponents() { + // Return cached value if available + if (checkoutComponentsCache !== null) { + return checkoutComponentsCache; + } + + try { + // Use the type resolver to get AnyComponent (which excludes @private) + checkoutComponentsCache = checkoutTypeResolver.resolveType('AnyComponent'); + + if (checkoutComponentsCache.length === 0) { + // Fallback: try to get just SUPPORTED_COMPONENTS + const typeDefs = checkoutTypeResolver.getTypeDefinitions(); + if (Array.isArray(typeDefs.SUPPORTED_COMPONENTS)) { + checkoutComponentsCache = [...typeDefs.SUPPORTED_COMPONENTS]; + } else { + checkoutComponentsCache = ['[CheckoutComponentsNotFound]']; + } + } + + return checkoutComponentsCache; + } catch (error) { + checkoutComponentsCache = ['[CheckoutComponentsError]']; + return checkoutComponentsCache; + } +} + +/** + * Parse a string union type from a component file and resolve type references + * e.g., export type SmartGridComponents = 'Tile'; + * or: export type BlockExtensionComponents = StandardComponents | 'AdminBlock'; + * or: export type StandardComponents = AnyComponent | 'Avatar' | ... (with AnyComponent imported) + */ +function parseStringUnionType(filePath, componentTypesMap = {}) { + try { + const content = fs.readFileSync(filePath, 'utf-8'); + + // Extract all quoted component names from the file (but not from import statements) + // Remove import lines first + const contentWithoutImports = content.replace(/^import.*?;$/gm, ''); + const componentNames = contentWithoutImports.match(/'([^']+)'/g); + const quotedComponents = componentNames + ? componentNames.map((name) => name.replace(/'/g, '')) + : []; + + // Check if the type references other types (like StandardComponents or AnyComponent) + // Look for patterns like: StandardComponents | 'OtherComponent' + const typeRefPattern = /export type \w+ =\s*([\s\S]*?);/; + const typeDefMatch = content.match(typeRefPattern); + + if (typeDefMatch) { + const typeDef = typeDefMatch[1]; + // Find references to other types (capitalized words that aren't in quotes) + const typeRefs = typeDef.match(/\b([A-Z]\w+(?:Components?)?)\b/g); + + if (typeRefs) { + const components = [...quotedComponents]; + + for (const typeRef of typeRefs) { + // Check if this is AnyComponent (imported from checkout) + if (typeRef === 'AnyComponent') { + // Add all checkout components + const checkoutComponents = parseCheckoutComponents(); + components.push(...checkoutComponents); + } + // If this type reference exists in our map, include its components + else if (componentTypesMap[typeRef]) { + components.push(...componentTypesMap[typeRef]); + } + } + + // Remove duplicates + return [...new Set(components)]; + } + } + + return quotedComponents.length > 0 ? quotedComponents : null; + } catch (error) { + console.error(`Error reading component file ${filePath}:`, error.message); + } + return null; +} + +/** + * Parse component types from files in the components directory + * Uses a two-pass approach: + * 1. First pass: Parse all component types that only contain quoted strings + * 2. Second pass: Parse types that reference other types (like StandardComponents) + */ +function parseComponentTypesFromFiles() { + if (!config.hasComponentTypes || !config.componentTypesPath) { + return {}; + } + + const componentsPath = path.join(config.basePath, config.componentTypesPath); + const componentTypesMap = {}; + + try { + // Look for all TypeScript files in the components directory + const files = fs.readdirSync(componentsPath); + const tsFiles = files.filter( + (file) => file.endsWith('.ts') && !file.endsWith('.d.ts'), + ); + + // First pass: Parse files with only quoted strings + for (const file of tsFiles) { + const filePath = path.join(componentsPath, file); + const componentTypeName = file.replace('.ts', ''); + + // Skip certain files + if ( + componentTypeName === 'shared' || + componentTypeName === 'components' + ) { + continue; + } + + const components = parseStringUnionType(filePath, {}); + if (components && components.length > 0) { + componentTypesMap[componentTypeName] = components; + + // If this is StandardComponents, use it as the base + if (componentTypeName === 'StandardComponents') { + allComponents = components.sort(); + } + } + } + + // Second pass: Re-parse files that might reference other types + // This allows types like BlockExtensionComponents = StandardComponents | 'AdminBlock' + for (const file of tsFiles) { + const filePath = path.join(componentsPath, file); + const componentTypeName = file.replace('.ts', ''); + + // Skip certain files + if ( + componentTypeName === 'shared' || + componentTypeName === 'components' + ) { + continue; + } + + const components = parseStringUnionType(filePath, componentTypesMap); + if (components && components.length > 0) { + componentTypesMap[componentTypeName] = components; + } + } + } catch (error) { + console.error('Error parsing component types:', error.message); + } + + return componentTypesMap; +} + +function parseTargetsFile() { + const targetsFilePath = path.join(config.basePath, 'extension-targets.ts'); + + const content = fs.readFileSync(targetsFilePath, 'utf-8'); + + // Parse component type definitions + const componentTypesMap = parseComponentTypesFromFiles(); + + const targets = {}; + + // Look for all interfaces that might contain RenderExtension or RunnableExtension targets + const interfaceNames = [ + 'RenderExtensionTargets', + 'OrderStatusExtensionTargets', + 'CustomerAccountExtensionTargets', + 'ExtensionTargets', + ]; + + for (const interfaceName of interfaceNames) { + // Try to find this interface + const regex = new RegExp( + `export interface ${interfaceName}[^{]*\\{([\\s\\S]+?)\\n\\}`, + ); + const match = content.match(regex); + + if (match) { + // Parse RenderExtension targets (have components) + if (match[1].includes('RenderExtension<')) { + parseTargetsFromInterfaceBody(match[1], targets, componentTypesMap); + } + // Parse RunnableExtension targets (no components, like should-render) + if (match[1].includes('RunnableExtension<')) { + parseRunnableTargetsFromInterfaceBody(match[1], targets); + } + } + } + + if (Object.keys(targets).length === 0) { + throw new Error('Could not find extension targets interface'); + } + + return targets; +} + +function parseTargetsFromInterfaceBody( + interfaceBody, + targets, + componentTypesMap, +) { + // Parse each target definition (handle multi-line) + const targetRegex = /'([^']+)':\s*RenderExtension<([\s\S]*?)>;/g; + + let match; + while ((match = targetRegex.exec(interfaceBody)) !== null) { + const targetName = match[1]; + const matchStartPos = match.index; + + // Check if this target has @private in its JSDoc comment + // Look backwards from the match to find a preceding JSDoc comment + const beforeMatch = interfaceBody.substring(0, matchStartPos); + const lastJsDocEnd = beforeMatch.lastIndexOf('*/'); + + if (lastJsDocEnd !== -1) { + // Check if there's no other target between the JSDoc and this target + const between = beforeMatch.substring(lastJsDocEnd + 2).trim(); + // If the text between JSDoc end and target is empty (or just whitespace), the JSDoc belongs to this target + if (between === '') { + const jsDocStart = beforeMatch.lastIndexOf('/**'); + if (jsDocStart !== -1) { + const jsDocContent = beforeMatch.substring( + jsDocStart, + lastJsDocEnd + 2, + ); + // Skip this target if it's marked @private + if (jsDocContent.includes('@private')) { + continue; + } + } + } + } + + let renderExtensionContent = match[2].trim(); + + // Remove comments before parsing + renderExtensionContent = renderExtensionContent + .replace(/\/\/[^\n]*/g, '') // Remove single-line comments + .replace(/\/\*[\s\S]*?\*\//g, ''); // Remove multi-line comments + + // Split by comma to separate API and Components + const parts = splitByTopLevelComma(renderExtensionContent); + + if (parts.length >= 2) { + const apiString = parts[0].trim(); + const componentString = parts[1].trim(); + + // Parse APIs from the intersection type + const apis = parseApis(apiString); + + // Parse components + const components = parseComponents(componentString, componentTypesMap); + + targets[targetName] = { + components: components.sort(), + apis: apis.sort(), + }; + } + } +} + +/** + * Parse RunnableExtension targets from an interface body + * These targets don't have components (they return data, not UI) + */ +function parseRunnableTargetsFromInterfaceBody(interfaceBody, targets) { + // Parse each RunnableExtension target definition (handle multi-line) + const targetRegex = /'([^']+)':\s*RunnableExtension<([\s\S]*?)>;/g; + + let match; + while ((match = targetRegex.exec(interfaceBody)) !== null) { + const targetName = match[1]; + const matchStartPos = match.index; + + // Check if this target has @private in its JSDoc comment + const beforeMatch = interfaceBody.substring(0, matchStartPos); + const lastJsDocEnd = beforeMatch.lastIndexOf('*/'); + + if (lastJsDocEnd !== -1) { + const between = beforeMatch.substring(lastJsDocEnd + 2).trim(); + if (between === '') { + const jsDocStart = beforeMatch.lastIndexOf('/**'); + if (jsDocStart !== -1) { + const jsDocContent = beforeMatch.substring( + jsDocStart, + lastJsDocEnd + 2, + ); + if (jsDocContent.includes('@private')) { + continue; + } + } + } + } + + let runnableExtensionContent = match[2].trim(); + + // Remove comments before parsing + runnableExtensionContent = runnableExtensionContent + .replace(/\/\/[^\n]*/g, '') + .replace(/\/\*[\s\S]*?\*\//g, ''); + + // Split by comma to separate API and Output type + const parts = splitByTopLevelComma(runnableExtensionContent); + + if (parts.length >= 1) { + const apiString = parts[0].trim(); + + // Parse APIs from the intersection type + const apis = parseApis(apiString); + + // RunnableExtension targets don't have components - they return data + targets[targetName] = { + components: [], + apis: apis.sort(), + }; + } + } +} + +function getNestedApis(apiName) { + // Check if we've already parsed this API + if (Object.prototype.hasOwnProperty.call(apiDefinitionsCache, apiName)) { + return apiDefinitionsCache[apiName]; + } + + // Try to find the API file in the surface's api directory + const apiDir = path.join(config.basePath, 'api'); + + if (!fs.existsSync(apiDir)) { + apiDefinitionsCache[apiName] = []; + return []; + } + + // Convert API name to potential file paths + // e.g., StandardApi -> standard-api, CartApi -> cart-api + const kebabName = apiName + .replace(/Api$/, '') + .replace(/([a-z])([A-Z])/g, '$1-$2') + .toLowerCase(); + + // Try multiple possible locations + const possiblePaths = [ + path.join(apiDir, `${kebabName}.ts`), + path.join(apiDir, `${kebabName}`, `${kebabName}.ts`), + path.join(apiDir, kebabName.replace(/-/g, ''), `${kebabName}.ts`), + path.join(apiDir, `${kebabName}-api`, `${kebabName}-api.ts`), + path.join(apiDir, `${kebabName}-api.ts`), + path.join(apiDir, `standard-api`, `standard-api.ts`), + ]; + + let content = null; + for (const apiFilePath of possiblePaths) { + try { + if (fs.existsSync(apiFilePath)) { + content = fs.readFileSync(apiFilePath, 'utf-8'); + break; + } + } catch (error) { + // Continue to next path + } + } + + if (!content) { + apiDefinitionsCache[apiName] = []; + return []; + } + + try { + // Find the export type definition for this API + const typeDefStartRegex = new RegExp(`export type ${apiName}[^=]*=`, 's'); + const startMatch = content.match(typeDefStartRegex); + + if (!startMatch) { + apiDefinitionsCache[apiName] = []; + return []; + } + + // Find the end position (semicolon at the correct nesting level) + const startPos = startMatch.index + startMatch[0].length; + let endPos = startPos; + let braceDepth = 0; + let angleDepth = 0; + + for (let i = startPos; i < content.length; i++) { + const char = content[i]; + + if (char === '{') braceDepth++; + else if (char === '}') braceDepth--; + else if (char === '<') angleDepth++; + else if (char === '>') angleDepth--; + else if (char === ';' && braceDepth === 0 && angleDepth === 0) { + endPos = i; + break; + } + } + + const typeDef = content.substring(startPos, endPos); + + // Extract all API names from the type definition + const nestedApis = []; + const apiMatches = typeDef.matchAll(/(\w+Api)\b/g); + + for (const apiMatch of apiMatches) { + const nestedApiName = apiMatch[1]; + // Don't include the API itself + if (nestedApiName !== apiName && !nestedApis.includes(nestedApiName)) { + nestedApis.push(nestedApiName); + } + } + + apiDefinitionsCache[apiName] = nestedApis; + return nestedApis; + } catch (error) { + // Error parsing, cache and return empty array + apiDefinitionsCache[apiName] = []; + return []; + } +} + +function parseApis(apiString) { + const apisSet = new Set(); + + // Remove any comments + const trimmedApiString = apiString + .replace(/\/\/[^\n]*/g, '') + .replace(/\/\*[\s\S]*?\*\//g, ''); + + // Split by & and extract API names + const parts = trimmedApiString + .split('&') + .map((part) => part.trim()) + .filter((part) => part); + + for (const part of parts) { + // Match API names (e.g., StandardApi<'...'> or just ApiName) + let apiName = null; + + // Extract just the type name before any generic parameters + const apiMatch = part.match(/^(\w+Api)/); + if (apiMatch) { + apiName = apiMatch[1]; + } else { + // Try to match any capitalized type name ending in Api + const generalMatch = part.match(/(\w+Api)\b/); + if (generalMatch) { + apiName = generalMatch[1]; + } + } + + if (apiName) { + // Add the API itself + apisSet.add(apiName); + + // Get nested APIs from this API (recursively) + const nestedApis = getNestedApis(apiName); + for (const nestedApi of nestedApis) { + apisSet.add(nestedApi); + // Recursively get nested APIs of nested APIs + const deepNestedApis = getNestedApis(nestedApi); + deepNestedApis.forEach((api) => apisSet.add(api)); + } + } + } + + return Array.from(apisSet); +} + +/** + * Parse a TypeScript component type expression + * Handles various patterns: type refs, unions, Exclude, AllowedComponents, etc. + */ +function parseComponents(componentString, componentTypesMap) { + // Normalize whitespace + const trimmedComponentString = componentString.replace(/\s+/g, ' ').trim(); + + // Handle AnyCheckoutComponentExcept<'Component1' | 'Component2'> + const checkoutExceptMatch = trimmedComponentString.match( + /AnyCheckoutComponentExcept<([^>]+)>/, + ); + if (checkoutExceptMatch) { + const excludedUnion = checkoutExceptMatch[1]; + // Get all checkout components + const allCheckoutComponents = parseCheckoutComponents(); + // Parse the union of excluded components + const excludedComponents = parseUnionOfStrings(excludedUnion); + // Filter out the excluded components + return allCheckoutComponents.filter( + (component) => !excludedComponents.includes(component), + ); + } + + // Handle Exclude + const excludeMatch = trimmedComponentString.match( + /Exclude<(\w+),\s*'([^']+)'>/, + ); + if (excludeMatch) { + const baseType = excludeMatch[1]; + const excluded = excludeMatch[2]; + const baseComponents = resolveComponentType(baseType, componentTypesMap); + return baseComponents.filter((component) => component !== excluded); + } + + // Handle AllowedComponents + const allowedMatch = trimmedComponentString.match( + /AllowedComponents<([^>]+)>/, + ); + if (allowedMatch) { + const innerType = allowedMatch[1].trim(); + return resolveComponentType(innerType, componentTypesMap); + } + + // Check if it's a direct type reference + const result = resolveComponentType( + trimmedComponentString, + componentTypesMap, + ); + if (result.length > 0) { + return result; + } + + // Default to all components if we have them + if (allComponents.length > 0) { + return allComponents; + } + + return ['[Unknown]']; +} + +/** + * Parse a union of string literals (e.g., "'Image' | 'Banner'") + * Returns an array of the string values + */ +function parseUnionOfStrings(unionString) { + const components = []; + // Split by | and extract quoted strings + const parts = unionString.split('|'); + for (const part of parts) { + const trimmed = part.trim(); + const match = trimmed.match(/^'([^']+)'$/); + if (match) { + components.push(match[1]); + } + } + return components; +} + +/** + * Resolve a component type name to a list of component names + */ +function resolveComponentType(typeName, componentTypesMap) { + const trimmedTypeName = typeName.trim(); + + // Check if it's in our component types map + if (componentTypesMap[trimmedTypeName]) { + return componentTypesMap[trimmedTypeName]; + } + + // Handle special checkout types + if ( + trimmedTypeName === 'AnyCheckoutComponent' || + trimmedTypeName === 'AnyComponent' || + trimmedTypeName === 'AnyThankYouComponent' + ) { + return parseCheckoutComponents(); + } + + // Check if it's a quoted string literal + const quotedMatch = trimmedTypeName.match(/^'([^']+)'$/); + if (quotedMatch) { + return [quotedMatch[1]]; + } + + return []; +} + +function createCombinedMapping(targetsJson) { + const result = {...targetsJson}; + + // Create reverse mappings for APIs + const apiToTargets = {}; + const componentToTargets = {}; + + // Iterate through all targets + for (const [targetName, targetData] of Object.entries(targetsJson)) { + // Map APIs to targets + for (const api of targetData.apis) { + if (!apiToTargets[api]) { + apiToTargets[api] = []; + } + apiToTargets[api].push(targetName); + } + + // Map Components to targets + for (const component of targetData.components) { + if (!componentToTargets[component]) { + componentToTargets[component] = []; + } + componentToTargets[component].push(targetName); + } + } + + // Add API reverse mappings to result + for (const [api, targets] of Object.entries(apiToTargets)) { + result[api] = { + targets: targets.sort(), + }; + } + + // Add Component reverse mappings to result + for (const [component, targets] of Object.entries(componentToTargets)) { + result[component] = { + targets: targets.sort(), + }; + } + + return result; +} + +// Main execution +try { + console.log('\n🔍 Generating targets JSON for admin surface'); + console.log(`📁 Base path: ${config.basePath}`); + + // Generate the JSON + const targetsJson = parseTargetsFile(); + + // Create the combined JSON with reverse mappings + const combinedJson = createCombinedMapping(targetsJson); + + // Write to output file + const outputDir = path.dirname(config.outputPath); + if (!fs.existsSync(outputDir)) { + fs.mkdirSync(outputDir, {recursive: true}); + } + fs.writeFileSync(config.outputPath, JSON.stringify(combinedJson, null, 2)); + + console.log('✅ Generated combined targets JSON at:', config.outputPath); + + // Count the different types of entries + const targetEntries = Object.keys(targetsJson).length; + const apiEntries = Object.keys(combinedJson).filter( + (key) => + combinedJson[key].targets && !targetsJson[key] && key.endsWith('Api'), + ).length; + const componentEntries = Object.keys(combinedJson).filter( + (key) => + combinedJson[key].targets && !targetsJson[key] && !key.endsWith('Api'), + ).length; + + console.log('\n📋 Summary:'); + console.log(` Extension targets: ${targetEntries}`); + console.log(` API reverse mappings: ${apiEntries}`); + console.log(` Component reverse mappings: ${componentEntries}`); + console.log(` Total entries in JSON: ${Object.keys(combinedJson).length}`); +} catch (error) { + console.error('❌ Error generating targets JSON:', error.message); + console.error(error.stack); + process.exit(1); +} diff --git a/packages/ui-extensions/docs/surfaces/admin/build-docs.mjs b/packages/ui-extensions/docs/surfaces/admin/build-docs.mjs index 659595c780..6a398faf6f 100644 --- a/packages/ui-extensions/docs/surfaces/admin/build-docs.mjs +++ b/packages/ui-extensions/docs/surfaces/admin/build-docs.mjs @@ -1,4 +1,5 @@ /* eslint-disable no-undef, no-console */ +import childProcess from 'child_process'; import fs from 'fs/promises'; import {existsSync} from 'fs'; import path from 'path'; @@ -9,9 +10,12 @@ import { copyGeneratedToShopifyDev, replaceFileContent, } from '../build-doc-shared.mjs'; -import {extractIconList} from './build-doc-extract-icons.mjs'; const EXTENSIONS_API_VERSION = process.argv[2] || 'unstable'; +/** Folder name for admin_extensions when copying to shopify-dev. Defaults to EXTENSIONS_API_VERSION; for 2026-04 we use 2026-04-rc so docs land in the rc folder. */ +const SHOPIFY_DEV_EXTENSIONS_FOLDER = + process.argv[3] ?? + (EXTENSIONS_API_VERSION === '2026-04' ? '2026-04-rc' : null); const __filename = fileURLToPath(import.meta.url); const __dirname = path.dirname(__filename); @@ -23,415 +27,65 @@ const srcRelativePath = 'src/surfaces/admin'; const docsPath = path.join(rootPath, docsRelativePath); const srcPath = path.join(rootPath, srcRelativePath); const generatedDocsPath = path.join(docsPath, 'generated'); -const shopifyDevPath = path.join(rootPath, '../../../shopify-dev'); -const shopifyDevDBPath = path.join( - shopifyDevPath, - 'db/data/docs/templated_apis', +const worldPath = path.join(process.env.HOME, 'world/trees/root/src'); +const worldDBPath = path.join( + worldPath, + 'areas/platforms/shopify-dev/db/data/docs/templated_apis', ); +const worldExists = existsSync(worldPath); + +const shopifyDevPath = worldExists + ? worldPath + : path.join(rootPath, '../../../shopify-dev'); +const shopifyDevDBPath = worldExists + ? worldDBPath + : path.join( + shopifyDevPath, + 'areas/platforms/shopify-dev/db/data/docs/templated_apis', + ); const shopifyDevExists = existsSync(shopifyDevPath); -const generatedDocsDataFile = 'generated_docs_data.json'; -const generatedStaticPagesFile = 'generated_static_pages.json'; +const generatedDocsDataV2File = 'generated_docs_data_v2.json'; const componentDefs = path.join(srcPath, 'components.d.ts'); const tempComponentDefs = path.join(srcPath, 'components.ts'); - -const tsconfigExtensions = 'tsconfig.ext.docs.json'; -const tsconfigAppBridge = 'tsconfig.ab.docs.json'; - -const decodeHTML = (str) => { - return str - .replace(/&/g, '&') - .replace(/</g, '<') - .replace(/>/g, '>') - .replace(/"/g, '"') - .replace(/'/g, "'"); -}; - -const escapeForJSTemplate = (str) => { - return str.replace(/\\/g, '\\\\').replace(/`/g, '\\`').replace(/\$/g, '\\$'); -}; - -const composeStyles = (...styles) => { - return styles - .filter(Boolean) - .map((style) => style.trim()) - .filter((style) => style.length > 0) - .join(' '); -}; - -// Don't allow all CSS properties to be used in the customStyles property -// DO NOT ADD MORE PROPERTIES TO THIS LIST -const allowedProperties = ['minHeight', 'minBlockSize']; - -const stylesToString = (styles) => { - if (!styles) return ''; - return Object.entries(styles) - .filter( - ([property, value]) => - allowedProperties.includes(property) && - value !== undefined && - value !== null, - ) - .map(([property, value]) => { - const kebabProperty = property.replace( - /[A-Z]/g, - (match) => `-${match.toLowerCase()}`, - ); - return `${kebabProperty}: ${value}`; - }) - .join('; '); -}; - -/** - * Renders the JSX template for the icon preview. - * @returns The processed HTML string. - */ -const renderIconPreviewJsxTemplate = async (iconPreviewData) => { - const templatePath = path.join( - docsPath, - 'templates/icon-renderer/jsx-render.html', - ); - const template = await fs.readFile(templatePath, 'utf-8'); - - const jsxFilePath = path.join(docsPath, iconPreviewData.jsxFile); - let jsxCode = await fs.readFile(jsxFilePath, 'utf-8'); - - const iconListString = `[${iconPreviewData.icons - .map((icon) => `'${icon}'`) - .join(',')}]`; - jsxCode = jsxCode.replace(/"__ICON_LIST__"/g, iconListString); - - const escapedJsxCode = escapeForJSTemplate(jsxCode); - - return template - .replace(/\{\{COMPOSED_STYLES\}\}/g, iconPreviewData.customStyles || '') - .replace(/\{\{BODY_CONTENT\}\}/g, iconPreviewData.bodyContent || '') - .replace(/\{\{JSX_CODE\}\}/g, escapedJsxCode); -}; - -const htmlWrapper = (htmlString, layoutStyles = '', customStyles = '') => { - const baseStyles = 'box-sizing: border-box; margin: 0; padding: 0.5rem;'; - const composedStyles = composeStyles(baseStyles, layoutStyles, customStyles); - - return `${decodeHTML( - htmlString, - )}`; -}; - -/* -Using JSX Builder to self-host Preact and Sucrase. -https://github.com/shopify-playground/jsx-builder -*/ -const jsxWrapper = ( - jsxString, - bodyContent, - layoutStyles = '', - customStyles = '', -) => { - const baseStyles = 'box-sizing: border-box; margin: 0; padding: 0.5rem;'; - const composedStyles = composeStyles(baseStyles, layoutStyles, customStyles); - - // Auto-wrap JSX if it doesn't already contain a return statement - // This allows both simple JSX expressions and complete function bodies with hooks - let jsxStringProcessed = jsxString; - // Check if 'return' appears as a statement - // If "return" has words before AND after it (like "for return request"), it's in text - // Otherwise, check if there's a return statement - const hasReturnInText = /\w+\s+return\s+\w+/.test(jsxString); - const hasReturnStatement = !hasReturnInText && /\breturn\b/.test(jsxString); - - if (!hasReturnStatement) { - jsxStringProcessed = `return (${jsxString})`; - } - - return ` - ${ - bodyContent || '' - } - - -`; -}; - -const createTemplate = ({ - layoutStyles, - wrapperElement = null, - wrapperAttributes = '', -}) => { - return (htmlString, customStyles, jsx = false) => { - if (jsx) { - const bodyContent = wrapperElement - ? `<${wrapperElement}${ - wrapperAttributes ? ` ${wrapperAttributes}` : '' - } id="wrapper-element">` - : ''; - - const customStylesString = stylesToString(customStyles); - - return jsxWrapper( - htmlString, - bodyContent, - layoutStyles, - customStylesString, - ); - } else { - const wrappedHtml = wrapperElement - ? `<${wrapperElement}${ - wrapperAttributes ? ` ${wrapperAttributes}` : '' - } id="wrapper-element">${htmlString}` - : `
${htmlString}
`; - - const customStylesString = stylesToString(customStyles); - - return htmlWrapper(wrappedHtml, layoutStyles, customStylesString); +const adminComponentsFilePath = `${srcRelativePath}/components.ts`; + +const hasPublicAdminComponentMembers = (declaration) => + declaration?.filePath === adminComponentsFilePath && + declaration.isPublicDocs === true && + Array.isArray(declaration.members); + +const isPublicAdminComponentClass = (declaration) => + hasPublicAdminComponentMembers(declaration) && + /^\s*declare\s+class\s+\w+\b/.test(declaration.value || ''); + +const isPublicAdminComponentEvents = (entryName, declaration) => + hasPublicAdminComponentMembers(declaration) && + /^\s*export\s+interface\s+\w+Events\b/.test(declaration.value || '') && + entryName.endsWith('Events'); + +const markAdminWebComponentMembersOptional = async (filePaths) => { + for (const filePath of filePaths) { + const docsData = JSON.parse(await fs.readFile(filePath, 'utf8')); + + for (const [entryName, entry] of Object.entries(docsData)) { + const declaration = Object.values(entry)[0]; + if ( + !isPublicAdminComponentClass(declaration) && + !isPublicAdminComponentEvents(entryName, declaration) + ) { + continue; + } + + for (const member of declaration.members) { + member.isOptional = true; + } } - }; -}; - -const templates = { - default: createTemplate({ - layoutStyles: 'display: grid; place-items: center; gap: 0.5rem;', - }), - alignStart: createTemplate({ - layoutStyles: 'display: grid; place-items: start center; gap: 0.5rem;', - wrapperElement: 'div', - }), - wrapped: createTemplate({ - layoutStyles: 'display: grid; place-items: center; gap: 0.5rem;', - wrapperElement: 'div', - wrapperAttributes: 'style="width: 100%;"', - }), - inline: createTemplate({ - layoutStyles: - 'display: flex; justify-content: center; align-items: center; gap: 0.5rem;', - }), - section: createTemplate({ - layoutStyles: 'display: grid; place-items: center; background: #F1F1F1', - wrapperElement: 's-section', - wrapperAttributes: 'padding="none"', - }), - page: createTemplate({ - layoutStyles: 'display: grid; place-items: center; background: #F1F1F1;', - }), - none: createTemplate({ - layoutStyles: 'padding: 0;', - }), - padding: createTemplate({ - layoutStyles: 'padding: 0;', - wrapperElement: 's-box', - wrapperAttributes: 'padding="base"', - }), - fullWidth: createTemplate({ - layoutStyles: 'display: grid; place-items: center;', - wrapperElement: 's-box', - wrapperAttributes: 'padding="base", inlineSize="100%"', - }), - example: createTemplate({ - layoutStyles: 'display: grid; place-items: center; gap: 0.5rem;', - wrapperElement: 's-box', - wrapperAttributes: 'padding="base"', - }), - formWrapper: createTemplate({ - layoutStyles: - 'display: grid; place-items: center; gap: 0.5rem; background: #F1F1F1; padding: 1rem;', - wrapperElement: 's-box', - wrapperAttributes: 'padding="base", inlineSize="300px"', - }), -}; - -const transformJson = async (filePath, isExtensions) => { - let jsonData = JSON.parse((await fs.readFile(filePath, 'utf8')).toString()); - const iconEntry = jsonData.find( - (entry) => entry.name === 'Icon' && entry.subSections, - ); - if (iconEntry) { - const iconDataPath = path.join(srcPath, 'components/Icon/icon-data.json'); - const iconData = JSON.parse(await fs.readFile(iconDataPath, 'utf-8')); - const iconPreviewData = iconData.iconPreviewData; - - iconPreviewData.icons = await extractIconList(); - - const subSection = iconEntry.subSections.find((section) => - section.sectionContent?.includes('{{ICON_PREVIEW_IFRAME}}'), - ); - if (subSection) { - const html = await renderIconPreviewJsxTemplate(iconPreviewData); - // Converting to base64 to avoid having to escape the HTML in the JSX template. - const base64Html = Buffer.from(html, 'utf-8').toString('base64'); - const darkModeListener = await fs.readFile( - path.join(docsPath, 'templates/icon-renderer/dark-mode-listener.jsx'), - 'utf-8', - ); - const base64DarkModeListener = Buffer.from( - darkModeListener, - 'utf-8', - ).toString('base64'); - subSection.sectionContent = subSection.sectionContent.replace( - /\{\{ICON_PREVIEW_IFRAME\}\}/g, - ` - - `, - ); - } + await fs.writeFile(filePath, `${JSON.stringify(docsData, null, 2)}\n`); } - - jsonData.forEach((entry) => { - // Temporary to ensure that isOptional is added to all members - if (entry.definitions && entry.isVisualComponent) { - entry.definitions.forEach((definition) => { - if (definition.typeDefinitions) { - Object.values(definition.typeDefinitions).forEach((typeDef) => { - if (typeDef.members && Array.isArray(typeDef.members)) { - typeDef.members - .sort((first, second) => first.name.localeCompare(second.name)) - .forEach((member) => { - // eslint-disable-next-line no-prototype-builtins - if (member.hasOwnProperty('isOptional')) return; - member.isOptional = true; - }); - } - }); - } - }); - } - - if (entry.defaultExample?.codeblock?.tabs) { - const newTabs = []; - entry.defaultExample.codeblock.tabs.forEach((tab) => { - if (tab.language !== 'preview' && tab.language !== 'preview-jsx') { - newTabs.push({...tab, title: tab.language}); - return; - } - - if (tab.layout && !(tab.layout in templates)) { - console.warn( - `${entry.name} has a layout of ${tab.layout} which is not a valid template.`, - ); - } - - const previewHTML = - tab.layout && tab.layout in templates - ? templates[tab.layout]( - tab.code, - tab.customStyles, - tab.language === 'preview-jsx', - ) - : templates.default( - tab.code, - tab.customStyles, - tab.language === 'preview-jsx', - ); - - newTabs.push( - { - title: tab.language === 'preview-jsx' ? 'jsx' : 'html', - code: tab.code, - language: tab.language === 'preview-jsx' ? 'jsx' : 'html', - editable: - tab.language === 'preview-jsx' ? tab.editable || false : false, - }, - {code: previewHTML, language: 'preview'}, - ); - }); - - entry.defaultExample.codeblock.tabs = newTabs.sort((first, second) => { - if (first.language === 'jsx') return -1; - if (second.language === 'jsx') return 1; - return 0; - }); - } - - if (entry.examples && entry.examples.exampleGroups) { - entry.examples.exampleGroups.forEach((exampleGroup) => { - exampleGroup.examples.forEach((example) => { - if (!example.codeblock?.tabs) { - return; - } - const newTabs = []; - - example.codeblock.tabs.forEach((tab) => { - if (tab.language === 'preview' || tab.language === 'preview-jsx') { - const previewHTML = - tab.layout && tab.layout in templates - ? templates[tab.layout]( - tab.code, - tab.customStyles, - tab.language === 'preview-jsx', - ) - : templates.example( - tab.code, - tab.customStyles, - tab.language === 'preview-jsx', - ); - - newTabs.push( - { - title: tab.language === 'preview-jsx' ? 'jsx' : 'html', - code: tab.code, - language: tab.language === 'preview-jsx' ? 'jsx' : 'html', - }, - { - code: previewHTML, - language: 'preview', - }, - ); - } else { - newTabs.push({ - title: tab.language, - code: tab.code, - language: tab.language, - editable: - tab.language === 'preview-jsx' - ? tab.editable || false - : false, - }); - } - }); - - example.codeblock.tabs = newTabs.sort((first, second) => { - if (first.language === 'jsx') return -1; - if (second.language === 'jsx') return 1; - return 0; - }); - }); - }); - } - }); - - // Merge the App Bridge docs with the Shopify Dev docs - if (!isExtensions && shopifyDevExists) { - const shopifyDevDocs = path.join( - shopifyDevDBPath, - 'app_home/generated_docs_data.json', - ); - const shopifyDevDocsContent = await fs.readFile(shopifyDevDocs, 'utf8'); - const shopifyDevDocsDocsParsed = JSON.parse( - shopifyDevDocsContent.toString(), - ); - - const filteredDocs = shopifyDevDocsDocsParsed.filter( - (entry) => - entry.category !== 'Polaris web components' && - entry.category !== 'Patterns', // Don't include old patterns - ); - - // Combine arrays with shopify dev docs first, followed by new data - jsonData = [...filteredDocs, ...jsonData]; - } - - await fs.writeFile(filePath, JSON.stringify(jsonData, null, 2)); }; const generateExtensionsDocs = async () => { @@ -444,31 +98,39 @@ const generateExtensionsDocs = async () => { "You can add a calver version argument (e.g. 'yarn docs:admin 2023-07') to generate the docs for a stable version.", ); } + if (SHOPIFY_DEV_EXTENSIONS_FOLDER) { + console.log( + `Shopify-dev admin_extensions folder will be: ${SHOPIFY_DEV_EXTENSIONS_FOLDER}`, + ); + } const outputDir = `${docsGeneratedRelativePath}/admin_extensions/${EXTENSIONS_API_VERSION}`; const scripts = [ - `yarn tsc --project ${docsRelativePath}/${tsconfigExtensions} --moduleResolution node --target esNext --module CommonJS`, - `yarn generate-docs --input ./${srcRelativePath} --typesInput ./${srcRelativePath} --output ./${outputDir}`, - `yarn tsc ${docsRelativePath}/staticPages/*.doc.ts --moduleResolution node --target esNext --module CommonJS`, - `yarn generate-docs --isLandingPage --input ./${docsRelativePath}/staticPages --output ./${outputDir}`, + `yarn generate-docs --input ./${srcRelativePath} --output ./${outputDir}`, ]; await generateFiles({ scripts, outputDir, rootPath, - generatedDocsDataFile, - generatedStaticPagesFile, - transformJson: (filePath) => transformJson(filePath, true), + generatedDocsDataV2File, }); // Replace 'unstable' with the exact API version in relative doc links + const generatedDocsPathForVersion = path.join(rootPath, outputDir); await replaceFileContent({ - filePaths: path.join(outputDir, generatedDocsDataFile), + filePaths: path.join(generatedDocsPathForVersion, generatedDocsDataV2File), searchValue: '/docs/api/admin-extensions/unstable/', replaceValue: `/docs/api/admin-extensions/${EXTENSIONS_API_VERSION}`, }); + + // Generate targets.json (extension targets + APIs + components mapping) + const targetsScriptPath = path.join(__dirname, 'build-docs-targets-json.mjs'); + childProcess.execSync(`node ${targetsScriptPath}`, { + stdio: 'inherit', + cwd: rootPath, + }); }; const generateAppBridgeDocs = async () => { @@ -476,16 +138,14 @@ const generateAppBridgeDocs = async () => { const outputDir = `${docsGeneratedRelativePath}/app_home`; const scripts = [ - `yarn tsc --project ${docsRelativePath}/${tsconfigAppBridge} --moduleResolution node --target esNext --module CommonJS`, - `yarn generate-docs --input ./${srcRelativePath} --typesInput ./${srcRelativePath} --output ./${outputDir}`, + `yarn generate-docs --input ./${srcRelativePath} --output ./${outputDir}`, ]; await generateFiles({ scripts, outputDir, rootPath, - generatedDocsDataFile, - transformJson: (filePath) => transformJson(filePath, false), + generatedDocsDataV2File, }); }; @@ -501,20 +161,87 @@ try { }); await generateExtensionsDocs(); await generateAppBridgeDocs(); + + const adminExtensionsOutput = path.join( + rootPath, + docsGeneratedRelativePath, + 'admin_extensions', + EXTENSIONS_API_VERSION, + ); + const appHomeOutput = path.join( + rootPath, + docsGeneratedRelativePath, + 'app_home', + ); + const targetsJsonPath = path.join(adminExtensionsOutput, 'targets.json'); + const generatedDocsDataV2Path = path.join( + adminExtensionsOutput, + generatedDocsDataV2File, + ); + const appHomeGeneratedDocsDataV2Path = path.join( + appHomeOutput, + generatedDocsDataV2File, + ); + + await markAdminWebComponentMembersOptional([ + generatedDocsDataV2Path, + appHomeGeneratedDocsDataV2Path, + ]); + + const appHomeUiExtensionOutput = path.join( + rootPath, + docsGeneratedRelativePath, + 'app_home_ui_extension', + EXTENSIONS_API_VERSION, + ); + if (existsSync(generatedDocsDataV2Path)) { + await fs.mkdir(appHomeUiExtensionOutput, {recursive: true}); + await fs.copyFile( + generatedDocsDataV2Path, + path.join(appHomeUiExtensionOutput, generatedDocsDataV2File), + ); + } + + console.log('\nGenerated docs at:'); + console.log(' Admin extensions:', adminExtensionsOutput); + console.log(' targets.json:', targetsJsonPath); + console.log(' generated_docs_data_v2.json:', generatedDocsDataV2Path); + console.log(' App Home:', appHomeOutput); + console.log(' App Home UI extensions:', appHomeUiExtensionOutput); + await copyGeneratedToShopifyDev({ generatedDocsPath, shopifyDevPath, shopifyDevDBPath, }); - await fs.cp( - path.join(docsPath, 'screenshots'), - path.join( - shopifyDevPath, - 'react-app/public/images/templated-apis-screenshots/admin', - ), - {recursive: true}, - ); + if ( + SHOPIFY_DEV_EXTENSIONS_FOLDER && + SHOPIFY_DEV_EXTENSIONS_FOLDER !== EXTENSIONS_API_VERSION && + shopifyDevExists + ) { + for (const folder of ['admin_extensions', 'app_home_ui_extension']) { + const source = path.join( + shopifyDevDBPath, + folder, + EXTENSIONS_API_VERSION, + ); + const dest = path.join( + shopifyDevDBPath, + folder, + SHOPIFY_DEV_EXTENSIONS_FOLDER, + ); + if (existsSync(source)) { + if (existsSync(dest)) { + await fs.rm(dest, {recursive: true}); + } + await fs.rename(source, dest); + console.log( + ` Renamed ${folder}/${EXTENSIONS_API_VERSION} → ${folder}/${SHOPIFY_DEV_EXTENSIONS_FOLDER} in shopify-dev`, + ); + } + } + } await fs.rm(tempComponentDefs); } catch (error) { diff --git a/packages/ui-extensions/docs/surfaces/admin/create-doc-files.js b/packages/ui-extensions/docs/surfaces/admin/create-doc-files.js deleted file mode 100755 index 83c1d6aa1d..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/create-doc-files.js +++ /dev/null @@ -1,121 +0,0 @@ -/* eslint-disable no-undef, no-console */ -const fs = require('fs'); -const path = require('path'); - -const args = process.argv.slice(2); -const componentNames = []; - -// Process arguments -for (let i = 0; i < args.length; i++) { - componentNames.push(args[i]); -} - -// Check if at least one component name is provided -if (componentNames.length === 0) { - console.error( - 'Usage: node create-doc-files.js component_name1 [component_name2 ...]', - ); - process.exit(1); -} - -console.log(`Scaffolding components docs for admin`); - -const baseDir = './packages/ui-extensions/src/surfaces/admin/components'; - -componentNames.forEach((componentName) => { - const folder = path.join(baseDir, componentName); - fs.mkdirSync(folder, {recursive: true}); - - const examplesDir = path.join(folder, 'examples'); - fs.mkdirSync(examplesDir, {recursive: true}); - - const exDocsFile = path.join(folder, `${componentName}.doc.ts`); - const abDocsFile = path.join(folder, `${componentName}.ab.doc.ts`); - const sharedDocsFile = path.join(folder, 'shared.ts'); - - // Convert camelCase to kebab-case - const lowercaseComponentName = componentName - .replace(/([a-z])([A-Z])/g, '$1-$2') - .toLowerCase(); - - // Create HTML and JSX example file - const examples = [ - path.join(examplesDir, `default.html`), - path.join(examplesDir, `default.jsx`), - ]; - examples.forEach((example) => { - if (fs.existsSync(example)) return; - fs.writeFileSync( - example, - ` \n`, - ); - console.log(`Created example file for ${componentName}`); - }); - - const sharedContent = `const shared = { - name: '${componentName}', - description: '${componentName} is used to ...', - thumbnail: '${lowercaseComponentName}-thumbnail.png', - isVisualComponent: true, - isOneColumnLayout: true, - definitions: [ - { - title: '${componentName}', - description: '', - type: '${componentName}', - }, - ], - subCategory: '', - related: [], - defaultExample: { - codeblock: { - title: '', - tabs: [ - { - code: './examples/default.html', - language: 'preview', - }, - ], - }, - }, -}; - -export default shared;`; - - const appBridgeDocContent = `import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; -import shared from './shared'; - -const data: ReferenceEntityTemplateSchema = { - ...shared, - category: 'Polaris web components', -}; - -export default data; -`; - - const extensionDocContent = `import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; -import shared from './shared'; - -const data: ReferenceEntityTemplateSchema = { - ...shared, - category: 'Polaris web components', -}; - -export default data; -`; - - writeContentToFile(exDocsFile, extensionDocContent); - writeContentToFile(abDocsFile, appBridgeDocContent); - writeContentToFile(sharedDocsFile, sharedContent); -}); - -function writeContentToFile(filePath, content, componentName) { - if (fs.existsSync(filePath)) { - console.log(`Documentation file for ${componentName} already exists`); - return; - } - - fs.writeFileSync(filePath, content); - console.log(`Created documentation file for ${componentName}`); -} -/* eslint-enable no-undef, no-console */ diff --git a/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-07-rc/generated_docs_data_v2.json b/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-07-rc/generated_docs_data_v2.json new file mode 100644 index 0000000000..004e997942 --- /dev/null +++ b/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-07-rc/generated_docs_data_v2.json @@ -0,0 +1,23449 @@ +{ + "GraphQLError": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "GraphQLError", + "description": "An error returned by the Storefront GraphQL API. Contains a human-readable `message` and an `extensions` object with the request ID and error code for debugging.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "extensions", + "value": "{ requestId: string; code: string; }", + "description": "Additional error metadata including the request ID and error code." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A human-readable description of the error." + } + ], + "value": "export interface GraphQLError {\n /**\n * A human-readable description of the error.\n */\n message: string;\n /**\n * Additional error metadata including the request ID and error code.\n */\n extensions: {\n /**\n * The unique identifier for the API request, useful for debugging with Shopify support.\n */\n requestId: string;\n /**\n * A machine-readable error code identifying the type of error.\n */\n code: string;\n };\n}" + } + }, + "Storage": { + "src/surfaces/admin/api/standard/storage.ts": { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "name": "Storage", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "clear", + "value": "() => Promise", + "description": "Clears all data from the storage. Use this to reset your extension's storage, such as when implementing a logout flow, clearing cached data, or resetting to defaults. This operation removes all stored key-value pairs." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "delete", + "value": "(key: Keys) => Promise", + "description": "Deletes a specific key from the storage. Use this to remove individual data items that are no longer needed, freeing up storage space and maintaining data hygiene." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "deleteMany", + "value": "(keys: Keys[]) => Promise>", + "description": "Deletes multiple keys from the storage at once. Use this to efficiently remove several related data items in a single operation, such as clearing expired cache entries or removing a group of related settings." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "entries", + "value": "() => Promise>", + "description": "Gets all the keys and values in the storage. Use this to iterate over all stored data, useful for debugging, data migration, or displaying all stored settings. The returned iterator provides entries as `[key, value]` tuples." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "get", + "value": "(key: Keys) => Promise", + "description": "Gets the value of a key in the storage. Use this to retrieve previously saved data when your extension loads or when you need to access stored values. The value is automatically deserialized from JSON to its original type." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "getMany", + "value": "(keys: Keys[]) => Promise", + "description": "Gets the values of multiple keys in the storage at once. Use this to efficiently retrieve related data in a single operation, reducing overhead when loading multiple stored values. The returned array is in the same order as the provided keys, with `undefined` values for keys that don't exist in storage." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "set", + "value": "(key: Keys, value: StorageTypes[Keys]) => Promise", + "description": "Sets the value of a key in the storage. Use this to save individual data items like user preferences, form state, or cached values. The value is serialized using `JSON.stringify`, so it can be any primitive type, object, or array that JSON supports." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "setMany", + "value": "(entries: Partial) => Promise", + "description": "Sets multiple key-value pairs in the storage at once. Use this for efficient batch operations when you need to save multiple related values together, such as form data or configuration settings." + } + ], + "value": "export interface Storage<\n BaseStorageTypes extends Record = Record,\n> {\n /**\n * Sets the value of a key in the storage. Use this to save individual data items like user preferences, form state, or cached values. The value is serialized using `JSON.stringify`, so it can be any primitive type, object, or array that JSON supports.\n *\n * @param key - The key to set the value for. Use descriptive keys to organize your stored data.\n * @param value - The value to set for the key. Can be any primitive type supported by `JSON.stringify`.\n *\n * @throws {StorageExceededError} Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.\n */\n set<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n key: Keys,\n value: StorageTypes[Keys],\n ): Promise;\n\n /**\n * Sets multiple key-value pairs in the storage at once. Use this for efficient batch operations when you need to save multiple related values together, such as form data or configuration settings.\n *\n * @param entries - An object containing key-value pairs to store. Values can be any primitive type supported by `JSON.stringify`.\n *\n * @throws {StorageExceededError} Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.\n */\n setMany(\n entries: Partial,\n ): Promise;\n\n /**\n * Gets the value of a key in the storage. Use this to retrieve previously saved data when your extension loads or when you need to access stored values. The value is automatically deserialized from JSON to its original type.\n *\n * @param key - The key to get the value for.\n * @returns The value of the key, or `undefined` if no value exists for the key.\n */\n get<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n key: Keys,\n ): Promise;\n\n /**\n * Gets the values of multiple keys in the storage at once. Use this to efficiently retrieve related data in a single operation, reducing overhead when loading multiple stored values. The returned array is in the same order as the provided keys, with `undefined` values for keys that don't exist in storage.\n *\n * @param keys - An array of keys to get the values for.\n * @returns An array containing values for the requested keys, in the same order as the input keys.\n */\n getMany<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n keys: Keys[],\n ): Promise<(StorageTypes[Keys] | undefined)[]>;\n\n /**\n * Clears all data from the storage. Use this to reset your extension's storage, such as when implementing a logout flow, clearing cached data, or resetting to defaults. This operation removes all stored key-value pairs.\n */\n clear(): Promise;\n\n /**\n * Deletes a specific key from the storage. Use this to remove individual data items that are no longer needed, freeing up storage space and maintaining data hygiene.\n *\n * @param key - The key to delete.\n * @returns A promise that resolves to `true` if the key existed and was deleted, or `false` if the key did not exist.\n */\n delete<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n key: Keys,\n ): Promise;\n\n /**\n * Deletes multiple keys from the storage at once. Use this to efficiently remove several related data items in a single operation, such as clearing expired cache entries or removing a group of related settings.\n *\n * @param keys - An array of keys to delete.\n * @returns A promise that resolves to an object mapping each key to a boolean value: `true` if the key existed and was deleted, or `false` if the key did not exist.\n */\n deleteMany<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n keys: Keys[],\n ): Promise>;\n\n /**\n * Gets all the keys and values in the storage. Use this to iterate over all stored data, useful for debugging, data migration, or displaying all stored settings. The returned iterator provides entries as `[key, value]` tuples.\n *\n * @returns A promise that resolves to an iterator containing all key-value pairs in the storage.\n */\n entries<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(): Promise>;\n}" + } + }, + "StorageExceededError": { + "src/surfaces/admin/api/standard/storage.ts": { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "name": "StorageExceededError", + "description": "Error thrown when storage operations exceed the available storage quota. This can occur during `set()` or `setMany()` operations when the total stored data size exceeds the limit allocated to your extension.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "'StorageExceededError'", + "description": "" + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "PropertySignature", + "name": "stack", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface StorageExceededError extends Error {\n name: 'StorageExceededError';\n}" + } + }, + "Data": { + "src/surfaces/admin/api/shared.ts": { + "filePath": "src/surfaces/admin/api/shared.ts", + "name": "Data", + "description": "The `Data` object provides access to currently viewed or selected resources in the admin context.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "{ id: string; }[]", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions." + } + ], + "value": "export interface Data {\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.\n */\n selected: {id: string}[];\n}" + } + }, + "SupportedDefinitionType": { + "src/surfaces/admin/api/shared.ts": { + "filePath": "src/surfaces/admin/api/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SupportedDefinitionType", + "value": "'boolean' | 'collection_reference' | 'color' | 'date' | 'date_time' | 'dimension' | 'file_reference' | 'json' | 'metaobject_reference' | 'mixed_reference' | 'money' | 'multi_line_text_field' | 'number_decimal' | 'number_integer' | 'page_reference' | 'product_reference' | 'rating' | 'rich_text_field' | 'single_line_text_field' | 'product_taxonomy_value_reference' | 'url' | 'variant_reference' | 'volume' | 'weight' | 'list.collection_reference' | 'list.color' | 'list.date' | 'list.date_time' | 'list.dimension' | 'list.file_reference' | 'list.metaobject_reference' | 'list.mixed_reference' | 'list.number_decimal' | 'list.number_integer' | 'list.page_reference' | 'list.product_reference' | 'list.rating' | 'list.single_line_text_field' | 'list.url' | 'list.variant_reference' | 'list.volume' | 'list.weight'", + "description": "The supported [metafield definition types](/docs/apps/build/metafields/list-of-data-types) for storing extension configuration data. Use these types to specify how metafield values should be formatted, validated, and displayed. Types prefixed with `list.` store arrays of values, while other types store single values. Choose a type that matches your data format (for example, use `'number_integer'` for whole numbers, `'single_line_text_field'` for short text, or `'json'` for complex structured data).", + "isPublicDocs": true + } + }, + "ExtensionTargets": { + "src/surfaces/admin/extension-targets.ts": { + "filePath": "src/surfaces/admin/extension-targets.ts", + "name": "ExtensionTargets", + "description": "Maps extension target identifiers to their corresponding extension types. Each target represents a specific location or context in the Shopify admin where extensions can render or execute. Use these targets to define where your extension appears and what capabilities it has access to.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the abandoned checkout details page. Use this to create workflows for cart recovery, customer engagement, or checkout analysis." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the abandoned checkout details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on checkout properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.abandoned-checkout-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the abandoned checkout details page. Use this to show cart recovery tools, abandonment analysis, or customer re-engagement options." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the abandoned checkout index page. Use this to create workflows for cart recovery, bulk customer engagement, or checkout analysis across multiple abandoned carts." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the abandoned checkout index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.app.home.render", + "value": "RenderExtension<\n AppHomeApi<'admin.app.home.render'>,\n FormExtensionComponents | 'Modal' | 'Page' | 'AppNav'\n >", + "description": "Renders an admin extension on the app home page." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.app.intent.render", + "value": "RenderExtension<\n IntentRenderApi<'admin.app.intent.render'>,\n FormExtensionComponents\n >", + "description": "Renders an admin extension for handling app intents." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.app.tools.data", + "value": "RunnableExtension<\n StandardApi<'admin.app.tools.data'>,\n undefined\n >", + "description": "A runnable target that enables your app to expose data to [Sidekick](/docs/apps/build/sidekick/build-app-data). Use this target to register tools that Sidekick can invoke to search your app's data and answer merchant questions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.catalog-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.catalog-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the catalog details page. Use this to create workflows for catalog management, market synchronization, or data exports." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.catalog-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.catalog-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the catalog details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on catalog properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.catalog-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.catalog-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the catalog details page. Use this to show catalog-specific settings, market information, or synchronization tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.collection-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the collection details page. Use this to create workflows for collection management, product operations, or merchandising tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.collection-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the collection details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on collection properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.collection-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the collection details page. Use this to show collection analytics, bulk product operations, or collection-specific tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.collection-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the collection index page. Use this to create workflows for collection management, bulk operations, or catalog organization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.collection-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the collection index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.company-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the company details page. Use this to create workflows for B2B customer management, credit operations, or company data synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.company-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the company details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on company properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.company-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the company details page. Use this to show B2B customer information, credit limits, or company-specific data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-location-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.company-location-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the company location details page. Use this to show location-specific information, shipping preferences, or location management tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the customer details page. Use this to create workflows for customer data management, loyalty operations, or CRM integrations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on customer properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.customer-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the customer details page. Use this to show customer-specific information, loyalty data, or custom customer actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the customer index page. Use this to create workflows for customer management, marketing operations, or bulk data processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the customer index page when multiple customers are selected. Use this to create workflows for bulk customer operations, mass email campaigns, or batch data updates." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-segment-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-segment-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears from the **Use segment** button on the customer segment details page. Use this to create workflows for marketing campaigns, email operations, or segment-based actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-segment-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-segment-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer segment details action appears from the **Use segment** button. Use this to conditionally show or hide your action based on segment properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customers.segmentation-templates.data", + "value": "RunnableExtension<\n CustomerSegmentTemplateApi<'admin.customers.segmentation-templates.data'>,\n {templates: CustomerSegmentTemplate[]}\n >", + "description": "A runnable target that provides [customer segment templates](/docs/apps/build/marketing-analytics/customer-segments/build-a-template-extension) in the [customer segment editor](https://help.shopify.com/manual/customers/customer-segmentation/create-customer-segments). Use this target to provide pre-built segment templates that merchants can use as starting points for creating targeted customer groups based on custom criteria." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.discount-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the discount details page. Use this to create workflows for discount management, promotion analysis, or discount synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.discount-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the discount details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on discount properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-details.function-settings.render", + "value": "RenderExtension<\n DiscountFunctionSettingsApi<'admin.discount-details.function-settings.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that appears when merchants create or edit a discount powered by your discount function, allowing them to configure function-specific settings. Use this to build custom configuration interfaces for discount function parameters." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.discount-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the discount index page. Use this to create workflows for discount management, promotional operations, or bulk discount updates." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.discount-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the discount index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.discount-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the discount index page when multiple discounts are selected. Use this to create workflows for bulk discount operations or batch data updates." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.discount-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the discount index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.draft-order-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the draft order details page. Use this to create workflows for draft order processing, custom pricing, or order preparation tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.draft-order-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the draft order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on draft order properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.draft-order-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the draft order details page. Use this to show custom pricing calculations, special order handling tools, or order-specific information." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the draft order index page. Use this to create workflows for draft order management, bulk operations, or order conversion tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the draft order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the draft order index page when multiple draft orders are selected. Use this to create workflows for bulk draft order operations, batch conversions, or mass order processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the draft order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.gift-card-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.gift-card-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the gift card details page. Use this to create workflows for gift card processing, balance adjustments, or custom gift card operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.gift-card-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.gift-card-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the gift card details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on gift card properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.gift-card-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.gift-card-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the gift card details page. Use this to show gift card balance tracking, usage history, or custom gift card metadata." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the order details page. Use this to create workflows for order processing, fulfillment operations, or external system integrations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on order properties, fulfillment status, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.order-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the order details page. Use this to show order-specific information, fulfillment tools, or custom order actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.order-details.print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the order details page. Use this to generate custom documents such as packing slips, shipping labels, or invoices." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-details.print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on order properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-fulfilled-card.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-fulfilled-card.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the actions menu inside the order fulfilled card, visible only on orders fulfilled by your app. Use this to create workflows for fulfillment operations, tracking updates, or post-fulfillment actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-fulfilled-card.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-fulfilled-card.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order fulfilled card action appears in the actions menu. Use this to conditionally show or hide your action based on fulfillment properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the order index page. Use this to create workflows for order management, reporting, or fulfillment operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the order index page when multiple orders are selected. Use this to create workflows for bulk order operations, batch fulfillment, or mass order processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.order-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the order index page when multiple orders are selected. Use this to generate batch documents such as combined packing slips, shipping manifests, or bulk invoices." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the product details page. Use this to create workflows for processing products, syncing data, or integrating with external systems." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on product properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.product-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the product details page. Use this to show product-specific information, tools, or actions directly on the product page." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.configuration.render", + "value": "RenderExtension<\n ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>,\n BlockExtensionComponents\n >", + "description": "A configuration target that renders product configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product details page. Use this to define bundle component selections, customization options, or product configuration rules." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.product-details.print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the product details page. Use this to generate custom documents such as product labels, barcode sheets, or specification sheets." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-details.print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on product properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.reorder.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.product-details.reorder.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that provides custom reordering functionality on the product details page. Use this to help merchants rearrange product data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the product index page. Use this to create workflows for product management, catalog operations, or inventory synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the product index page when multiple products are selected. Use this to create workflows for bulk product operations, batch updates, or mass data processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.product-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the product index page when multiple products are selected. Use this to generate batch documents such as combined product labels, barcode sheets, or catalog pages." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-purchase-option.action.render", + "value": "RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-purchase-option.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **Purchase Options** card on the product details page when a selling plan group is present. Use this to create workflows for subscription management, selling plan configuration, or purchase option operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-variant-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the product variant details page. Use this to create workflows for variant management, inventory operations, or data synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-variant-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product variant details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on variant properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.product-variant-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the product variant details page. Use this to show variant-specific data, inventory tools, or variant configuration options." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.configuration.render", + "value": "RenderExtension<\n ProductVariantDetailsConfigurationApi<'admin.product-variant-details.configuration.render'>,\n BlockExtensionComponents\n >", + "description": "A configuration target that renders product variant configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product variant details page. Use this to define variant-specific bundle components, customization options, or configuration rules." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-purchase-option.action.render", + "value": "RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-variant-purchase-option.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **Purchase Options** card on the product variant details page when a selling plan group is present. Use this to create workflows for variant-specific subscription management, selling plan configuration, or purchase option operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.settings.internal-order-routing-rule.render", + "value": "RenderExtension<\n OrderRoutingRuleApi<'admin.settings.internal-order-routing-rule.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.settings.order-routing-rule.render", + "value": "RenderExtension<\n OrderRoutingRuleApi<'admin.settings.order-routing-rule.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions. Use this to build custom configuration interfaces for order routing function parameters." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.settings.validation.render", + "value": "RenderExtension<\n ValidationSettingsApi<'admin.settings.validation.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that renders within a validation's add and edit views, allowing merchants to configure validation function settings. Use this to build custom configuration interfaces for validation function parameters and rules." + } + ], + "value": "export interface ExtensionTargets {\n /**\n * A runnable target that provides [customer segment templates](/docs/apps/build/marketing-analytics/customer-segments/build-a-template-extension) in the [customer segment editor](https://help.shopify.com/manual/customers/customer-segmentation/create-customer-segments). Use this target to provide pre-built segment templates that merchants can use as starting points for creating targeted customer groups based on custom criteria.\n */\n 'admin.customers.segmentation-templates.data': RunnableExtension<\n CustomerSegmentTemplateApi<'admin.customers.segmentation-templates.data'>,\n {templates: CustomerSegmentTemplate[]}\n >;\n\n // Blocks\n /**\n * A block target that displays inline content within the product details page. Use this to show product-specific information, tools, or actions directly on the product page.\n */\n 'admin.product-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.product-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the order details page. Use this to show order-specific information, fulfillment tools, or custom order actions.\n */\n 'admin.order-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.order-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A function settings target that appears when merchants create or edit a discount powered by your discount function, allowing them to configure function-specific settings. Use this to build custom configuration interfaces for discount function parameters.\n */\n 'admin.discount-details.function-settings.render': RenderExtension<\n DiscountFunctionSettingsApi<'admin.discount-details.function-settings.render'>,\n FunctionSettingsComponents\n >;\n\n /**\n * A block target that displays inline content within the customer details page. Use this to show customer-specific information, loyalty data, or custom customer actions.\n */\n 'admin.customer-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.customer-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the collection details page. Use this to show collection analytics, bulk product operations, or collection-specific tools.\n */\n 'admin.collection-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.collection-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the draft order details page. Use this to show custom pricing calculations, special order handling tools, or order-specific information.\n */\n 'admin.draft-order-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.draft-order-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the abandoned checkout details page. Use this to show cart recovery tools, abandonment analysis, or customer re-engagement options.\n */\n 'admin.abandoned-checkout-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.abandoned-checkout-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the catalog details page. Use this to show catalog-specific settings, market information, or synchronization tools.\n */\n 'admin.catalog-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.catalog-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the company details page. Use this to show B2B customer information, credit limits, or company-specific data.\n */\n 'admin.company-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.company-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the company location details page. Use this to show location-specific information, shipping preferences, or location management tools.\n */\n 'admin.company-location-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.company-location-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the gift card details page. Use this to show gift card balance tracking, usage history, or custom gift card metadata.\n */\n 'admin.gift-card-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.gift-card-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the product variant details page. Use this to show variant-specific data, inventory tools, or variant configuration options.\n */\n 'admin.product-variant-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.product-variant-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that provides custom reordering functionality on the product details page. Use this to help merchants rearrange product data.\n */\n 'admin.product-details.reorder.render': RenderExtension<\n BlockExtensionApi<'admin.product-details.reorder.render'>,\n BlockExtensionComponents\n >;\n\n // Actions\n /**\n * An action target that appears in the **More actions** menu on the product details page. Use this to create workflows for processing products, syncing data, or integrating with external systems.\n */\n 'admin.product-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.product-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the catalog details page. Use this to create workflows for catalog management, market synchronization, or data exports.\n */\n 'admin.catalog-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.catalog-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the company details page. Use this to create workflows for B2B customer management, credit operations, or company data synchronization.\n */\n 'admin.company-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.company-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the gift card details page. Use this to create workflows for gift card processing, balance adjustments, or custom gift card operations.\n */\n 'admin.gift-card-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.gift-card-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the order details page. Use this to create workflows for order processing, fulfillment operations, or external system integrations.\n */\n 'admin.order-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.order-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the customer details page. Use this to create workflows for customer data management, loyalty operations, or CRM integrations.\n */\n 'admin.customer-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears from the **Use segment** button on the customer segment details page. Use this to create workflows for marketing campaigns, email operations, or segment-based actions.\n */\n 'admin.customer-segment-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-segment-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the product index page. Use this to create workflows for product management, catalog operations, or inventory synchronization.\n */\n 'admin.product-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.product-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the order index page. Use this to create workflows for order management, reporting, or fulfillment operations.\n */\n 'admin.order-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.order-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the customer index page. Use this to create workflows for customer management, marketing operations, or bulk data processing.\n */\n 'admin.customer-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the discount index page. Use this to create workflows for discount management, promotional operations, or bulk discount updates.\n */\n 'admin.discount-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.discount-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the collection details page. Use this to create workflows for collection management, product operations, or merchandising tools.\n */\n 'admin.collection-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.collection-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the collection index page. Use this to create workflows for collection management, bulk operations, or catalog organization.\n */\n 'admin.collection-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.collection-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the abandoned checkout details page. Use this to create workflows for cart recovery, customer engagement, or checkout analysis.\n */\n 'admin.abandoned-checkout-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the abandoned checkout index page. Use this to create workflows for cart recovery, bulk customer engagement, or checkout analysis across multiple abandoned carts.\n */\n 'admin.abandoned-checkout-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the product variant details page. Use this to create workflows for variant management, inventory operations, or data synchronization.\n */\n 'admin.product-variant-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.product-variant-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the draft order details page. Use this to create workflows for draft order processing, custom pricing, or order preparation tools.\n */\n 'admin.draft-order-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.draft-order-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the draft order index page. Use this to create workflows for draft order management, bulk operations, or order conversion tools.\n */\n 'admin.draft-order-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the discount details page. Use this to create workflows for discount management, promotion analysis, or discount synchronization.\n */\n 'admin.discount-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.discount-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the actions menu inside the order fulfilled card, visible only on orders fulfilled by your app. Use this to create workflows for fulfillment operations, tracking updates, or post-fulfillment actions.\n */\n 'admin.order-fulfilled-card.action.render': RenderExtension<\n ActionExtensionApi<'admin.order-fulfilled-card.action.render'>,\n ActionExtensionComponents\n >;\n\n // Bulk Actions\n\n /**\n * A selection action target that appears in the **More actions** menu on the product index page when multiple products are selected. Use this to create workflows for bulk product operations, batch updates, or mass data processing.\n */\n 'admin.product-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.product-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * A selection action target that appears in the **More actions** menu on the order index page when multiple orders are selected. Use this to create workflows for bulk order operations, batch fulfillment, or mass order processing.\n */\n 'admin.order-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.order-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * A selection action target that appears in the **More actions** menu on the customer index page when multiple customers are selected. Use this to create workflows for bulk customer operations, mass email campaigns, or batch data updates.\n */\n 'admin.customer-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the discount index page when multiple discounts are selected. Use this to create workflows for bulk discount operations or batch data updates.\n */\n 'admin.discount-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.discount-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * A selection action target that appears in the **More actions** menu on the draft order index page when multiple draft orders are selected. Use this to create workflows for bulk draft order operations, batch conversions, or mass order processing.\n */\n 'admin.draft-order-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **Purchase Options** card on the product details page when a selling plan group is present. Use this to create workflows for subscription management, selling plan configuration, or purchase option operations.\n */\n 'admin.product-purchase-option.action.render': RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-purchase-option.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **Purchase Options** card on the product variant details page when a selling plan group is present. Use this to create workflows for variant-specific subscription management, selling plan configuration, or purchase option operations.\n */\n 'admin.product-variant-purchase-option.action.render': RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-variant-purchase-option.action.render'>,\n ActionExtensionComponents\n >;\n\n // Print actions and bulk print actions\n\n /**\n * A print action target that appears in the **Print** menu on the order details page. Use this to generate custom documents such as packing slips, shipping labels, or invoices.\n */\n 'admin.order-details.print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.order-details.print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n /**\n * A print action target that appears in the **Print** menu on the product details page. Use this to generate custom documents such as product labels, barcode sheets, or specification sheets.\n */\n 'admin.product-details.print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.product-details.print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n /**\n * A print action target that appears in the **Print** menu on the order index page when multiple orders are selected. Use this to generate batch documents such as combined packing slips, shipping manifests, or bulk invoices.\n */\n 'admin.order-index.selection-print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.order-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n /**\n * A print action target that appears in the **Print** menu on the product index page when multiple products are selected. Use this to generate batch documents such as combined product labels, barcode sheets, or catalog pages.\n */\n 'admin.product-index.selection-print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.product-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n // Other\n\n /**\n * A configuration target that renders product configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product details page. Use this to define bundle component selections, customization options, or product configuration rules.\n */\n 'admin.product-details.configuration.render': RenderExtension<\n ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A configuration target that renders product variant configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product variant details page. Use this to define variant-specific bundle components, customization options, or configuration rules.\n */\n 'admin.product-variant-details.configuration.render': RenderExtension<\n ProductVariantDetailsConfigurationApi<'admin.product-variant-details.configuration.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions.\n * @private\n */\n 'admin.settings.internal-order-routing-rule.render': RenderExtension<\n OrderRoutingRuleApi<'admin.settings.internal-order-routing-rule.render'>,\n FunctionSettingsComponents\n >;\n /**\n * A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions. Use this to build custom configuration interfaces for order routing function parameters.\n */\n 'admin.settings.order-routing-rule.render': RenderExtension<\n OrderRoutingRuleApi<'admin.settings.order-routing-rule.render'>,\n FunctionSettingsComponents\n >;\n\n /**\n * A function settings target that renders within a validation's add and edit views, allowing merchants to configure validation function settings. Use this to build custom configuration interfaces for validation function parameters and rules.\n */\n 'admin.settings.validation.render': RenderExtension<\n ValidationSettingsApi<'admin.settings.validation.render'>,\n FunctionSettingsComponents\n >;\n\n // Admin action shouldRender targets\n /**\n * A non-rendering target that controls whether the product details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on product properties, user permissions, or external data.\n */\n 'admin.product-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the catalog details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on catalog properties, user permissions, or external data.\n */\n 'admin.catalog-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.catalog-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the company details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on company properties, user permissions, or external data.\n */\n 'admin.company-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.company-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the gift card details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on gift card properties, user permissions, or external data.\n */\n 'admin.gift-card-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.gift-card-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on order properties, fulfillment status, or external data.\n */\n 'admin.order-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on customer properties, user permissions, or external data.\n */\n 'admin.customer-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer segment details action appears from the **Use segment** button. Use this to conditionally show or hide your action based on segment properties, user permissions, or external data.\n */\n 'admin.customer-segment-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-segment-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.product-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.order-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.customer-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the discount index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.discount-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.discount-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the collection details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on collection properties, user permissions, or external data.\n */\n 'admin.collection-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.collection-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the collection index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.collection-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.collection-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the abandoned checkout details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on checkout properties, user permissions, or external data.\n */\n 'admin.abandoned-checkout-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the abandoned checkout index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.abandoned-checkout-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product variant details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on variant properties, user permissions, or external data.\n */\n 'admin.product-variant-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-variant-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the draft order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on draft order properties, user permissions, or external data.\n */\n 'admin.draft-order-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.draft-order-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the draft order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.draft-order-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the discount details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on discount properties, user permissions, or external data.\n */\n 'admin.discount-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.discount-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order fulfilled card action appears in the actions menu. Use this to conditionally show or hide your action based on fulfillment properties, user permissions, or external data.\n */\n 'admin.order-fulfilled-card.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-fulfilled-card.action.should-render'>,\n ShouldRenderOutput\n >;\n\n // Admin bulk action shouldRender targets\n\n /**\n * A non-rendering target that controls whether the product index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.product-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.order-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.customer-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the discount index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.discount-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.discount-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the draft order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.draft-order-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n // Admin print action and bulk print action shouldRender targets\n\n /**\n * A non-rendering target that controls whether the order details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on order properties, user permissions, or external data.\n */\n 'admin.order-details.print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-details.print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on product properties, user permissions, or external data.\n */\n 'admin.product-details.print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-details.print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data.\n */\n 'admin.order-index.selection-print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data.\n */\n 'admin.product-index.selection-print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A runnable target that enables your app to expose data to [Sidekick](/docs/apps/build/sidekick/build-app-data). Use this target to register tools that Sidekick can invoke to search your app's data and answer merchant questions.\n */\n 'admin.app.tools.data': RunnableExtension<\n StandardApi<'admin.app.tools.data'>,\n undefined\n >;\n\n /**\n * Renders an admin extension for handling app intents.\n */\n 'admin.app.intent.render': RenderExtension<\n IntentRenderApi<'admin.app.intent.render'>,\n FormExtensionComponents\n >;\n\n /**\n * Renders an admin extension on the app home page.\n */\n 'admin.app.home.render': RenderExtension<\n AppHomeApi<'admin.app.home.render'>,\n FormExtensionComponents | 'Modal' | 'Page' | 'AppNav'\n >;\n}" + } + }, + "RenderExtension": { + "src/extension.ts": { + "filePath": "src/extension.ts", + "name": "RenderExtension", + "description": "Defines the structure of a render extension, which displays UI in the Shopify admin.", + "members": [ + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "api", + "value": "Api", + "description": "The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "components", + "value": "ComponentsSet", + "description": "The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "output", + "value": "void | Promise", + "description": "The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads." + } + ], + "value": "export interface RenderExtension {\n /**\n * The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying.\n */\n api: Api;\n /**\n * The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target.\n */\n components: ComponentsSet;\n /**\n * The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads.\n */\n output: void | Promise;\n}" + } + }, + "ActionExtensionApi": { + "src/surfaces/admin/api/action/action.ts": { + "filePath": "src/surfaces/admin/api/action/action.ts", + "name": "ActionExtensionApi", + "description": "The `ActionExtensionApi` object provides methods for action extensions that render in modal overlays. Access the following properties on the `ActionExtensionApi` object to interact with the current context, control the modal, and display picker dialogs.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "close", + "value": "() => void", + "description": "Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ActionExtensionApi\n extends StandardRenderingExtensionApi {\n /**\n * Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner.\n */\n close: () => void;\n\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.\n */\n data: Data;\n}" + } + }, + "Auth": { + "src/surfaces/admin/api/standard/standard.ts": { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "name": "Auth", + "description": "The `Auth` object provides authentication methods for secure communication with your app backend.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "idToken", + "value": "() => Promise", + "description": "Retrieves a [Shopify OpenID Connect ID token](/docs/api/app-home/apis/id-token) for the current user. Use this token to authenticate requests to your app backend and verify the user's identity. The token is a signed JWT that contains user information and can be validated using Shopify's public keys. Returns `null` if the token can't be retrieved." + } + ], + "value": "export interface Auth {\n /**\n * Retrieves a [Shopify OpenID Connect ID token](/docs/api/app-home/apis/id-token) for the current user. Use this token to authenticate requests to your app backend and verify the user's identity. The token is a signed JWT that contains user information and can be validated using Shopify's public keys. Returns `null` if the token can't be retrieved.\n */\n idToken: () => Promise;\n}" + } + }, + "ExtensionTarget": { + "src/surfaces/admin/extension-targets.ts": { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionTarget", + "value": "keyof ExtensionTargets", + "description": "A string literal union of all valid extension target identifiers. Use this type to specify where your admin UI extension should render, such as `admin.product-details.block.render` for a block on product details pages or `admin.order-details.action.render` for an action on order details pages. The target determines the extension's location, available APIs, and UI components." + } + }, + "I18n": { + "src/api.ts": { + "filePath": "src/api.ts", + "name": "I18n", + "description": "Internationalization utilities for formatting and translating content according to the user's locale. Use these methods to display numbers, currency, dates, and translated strings that match the merchant's language and regional preferences.", + "members": [ + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "formatCurrency", + "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", + "description": "Returns a localized currency value formatted according to the user's locale and currency conventions. Use this to display prices, totals, or financial amounts in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. Uses the current user's locale by default." + }, + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "formatDate", + "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", + "description": "Returns a localized date value formatted according to the user's locale and date conventions. Use this to display dates and times in the appropriate format for the merchant's region, such as order dates, timestamps, or schedule information. This function behaves like the standard `Intl.DateTimeFormat()` and uses the current user's locale by default. Formatting options can be passed to customize the date display style." + }, + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "formatNumber", + "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", + "description": "Returns a localized number formatted according to the user's locale. Use this to display numbers like quantities, percentages, or measurements in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. Uses the current user's locale by default." + }, + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "I18nTranslate", + "description": "Returns translated content in the user's locale, as supported by the extension. Use this to display localized strings from your extension's locale files. The special `options.count` property enables pluralization. Other option keys and values are treated as replacements for interpolation in your translation strings. Returns a single string when replacements are primitives, or an array when replacements contain UI components." + } + ], + "value": "export interface I18n {\n /**\n * Returns a localized number formatted according to the user's locale. Use this to display numbers like quantities, percentages, or measurements in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. Uses the current user's locale by default.\n *\n * @param number - The number to format\n * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale\n * @param options - Additional Intl.NumberFormatOptions for customizing the number format\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value formatted according to the user's locale and currency conventions. Use this to display prices, totals, or financial amounts in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. Uses the current user's locale by default.\n *\n * @param number - The currency amount to format\n * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale\n * @param options - Additional Intl.NumberFormatOptions for customizing the currency format, such as the currency code\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value formatted according to the user's locale and date conventions. Use this to display dates and times in the appropriate format for the merchant's region, such as order dates, timestamps, or schedule information. This function behaves like the standard `Intl.DateTimeFormat()` and uses the current user's locale by default. Formatting options can be passed to customize the date display style.\n *\n * @param date - The Date object to format\n * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale\n * @param options - Additional Intl.DateTimeFormatOptions for customizing the date format\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the user's locale, as supported by the extension. Use this to display localized strings from your extension's locale files. The special `options.count` property enables pluralization. Other option keys and values are treated as replacements for interpolation in your translation strings. Returns a single string when replacements are primitives, or an array when replacements contain UI components.\n */\n translate: I18nTranslate;\n}" + } + }, + "I18nTranslate": { + "src/api.ts": { + "filePath": "src/api.ts", + "name": "I18nTranslate", + "description": "The translation function signature for internationalization. Use this to translate string keys defined in your locale files into localized content for the current user's language.", + "members": [], + "value": "export interface I18nTranslate {\n /**\n * Returns a translated string matching a key in a locale file. Use this to display localized text in your extension based on the merchant's language preferences. Supports interpolation with replacement values and pluralization with the `count` option. Returns a string when replacements are primitives, or an array when replacements include UI components.\n *\n * @param key - The translation key from your locale file (for example, \"banner.title\")\n * @param options - Optional replacement values for interpolation or the special `count` property for pluralization\n *\n * @example translate(\"banner.title\")\n * @example translate(\"items.count\", { count: 5 })\n */\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" + } + }, + "Intents": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "Intents", + "description": "The `Intents` object provides methods for launching standardized Shopify workflows to create or edit resources. Intents enable your extension to trigger native admin interfaces for products, customers, discounts, and other resources, then receive the results when merchants complete the workflow.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "invoke", + "value": "IntentInvokeApi", + "description": "Launches an intent workflow for creating or editing Shopify resources. Returns a handle that resolves when the merchant completes, cancels, or encounters an error in the workflow. Use this to initiate resource creation or editing without building custom forms.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "launchUrl", + "value": "string | URL", + "description": "The URL that launched the current intent workflow, if your extension was opened through an intent. Use this to determine how your extension was invoked and access any parameters passed in the URL.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "response", + "value": "IntentResponseApi", + "description": "Resolves the current intent from within an invoked extension. This property is only present when your extension is running inside an intent workflow.", + "isOptional": true + } + ], + "value": "export interface Intents {\n /**\n * Resolves the current intent from within an invoked extension. This property is only present when your extension is running inside an intent workflow.\n */\n response?: IntentResponseApi;\n\n /**\n * The URL that launched the current intent workflow, if your extension was opened through an intent. Use this to determine how your extension was invoked and access any parameters passed in the URL.\n */\n launchUrl?: string | URL;\n /**\n * Launches an intent workflow for creating or editing Shopify resources. Returns a handle that resolves when the merchant completes, cancels, or encounters an error in the workflow. Use this to initiate resource creation or editing without building custom forms.\n */\n invoke?: IntentInvokeApi;\n}" + } + }, + "IntentInvokeApi": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentInvokeApi", + "description": "The [`invoke` method](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/intents-api#invoke-method) in the Intents API launches a Shopify admin workflow for creating, editing, or picking resources, such as products, customers, or files. It opens a native admin interface, waits for the merchant to complete the workflow, and returns the result including any created, updated, or selected resource data.", + "isPublicDocs": true, + "members": [], + "value": "export interface IntentInvokeApi {\n (query: IntentQuery): Promise;\n (intentURL: string, options?: IntentQueryOptions): Promise;\n}" + } + }, + "IntentResponseApi": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentResponseApi", + "description": "The `IntentResponseApi` object provides methods for resolving the current intent from within an invoked extension. This API is only present when your extension is running inside an intent workflow.", + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "MethodSignature", + "name": "closed", + "value": "() => Promise", + "description": "Resolves the current intent as closed without completing the workflow." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "MethodSignature", + "name": "error", + "value": "(message: string, issues?: Issue[]) => Promise", + "description": "Resolves the current intent with an error. Use `issues` to provide field-specific validation details when available." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "MethodSignature", + "name": "ok", + "value": "(data?: { [key: string]: unknown; }) => Promise", + "description": "Resolves the current intent successfully. Pass output data when your intent defines a response schema." + } + ], + "value": "export interface IntentResponseApi {\n /**\n * Resolves the current intent successfully. Pass output data when your intent defines a response schema.\n */\n ok(data?: SuccessIntentResponse['data']): Promise;\n\n /**\n * Resolves the current intent with an error. Use `issues` to provide field-specific validation details when available.\n */\n error(message: string, issues?: Issue[]): Promise;\n\n /**\n * Resolves the current intent as closed without completing the workflow.\n */\n closed(): Promise;\n}" + } + }, + "Issue": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "Issue", + "description": "A structured issue describing a validation or workflow error.", + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A machine-readable error code for this issue. Use this for programmatic error handling or logging.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A description of what's wrong with this field. Display this to help merchants understand how to fix the error.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "path", + "value": "string[]", + "description": "The path to the field that has an error (for example, `['product', 'title']`). Use this to identify which field caused the validation failure.", + "isOptional": true + } + ], + "value": "export interface Issue {\n /** The path to the field that has an error (for example, `['product', 'title']`). Use this to identify which field caused the validation failure. */\n path?: string[];\n /** A description of what's wrong with this field. Display this to help merchants understand how to fix the error. */\n message?: string;\n /** A machine-readable error code for this issue. Use this for programmatic error handling or logging. */\n code?: string;\n}" + } + }, + "PickerApi": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "PickerApi", + "description": "The `picker` function opens a custom selection dialog with your app-specific data. It accepts configuration options to define the picker's heading, items, headers, and selection behavior. It returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.", + "isPublicDocs": true, + "params": [ + { + "name": "options", + "description": "", + "value": "PickerOptions", + "filePath": "src/surfaces/admin/api/picker/picker.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "description": "", + "name": "Promise", + "value": "Promise" + }, + "value": "(options: PickerOptions) => Promise" + } + }, + "PickerOptions": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "PickerOptions", + "description": "The configuration options for the custom picker dialog. Define the picker's appearance, selection behavior, and data structure.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "headers", + "value": "Header[]", + "description": "The column headers for the picker table. Define headers to label and organize the data columns displayed for each item. The header order determines the column layout.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading displayed at the top of the picker modal. Use a clear, descriptive title that tells merchants what they're selecting." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "Item[]", + "description": "The list of items that merchants can select from. Each item appears as a row in the picker table." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean | number", + "description": "The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `3` allows up to three items).", + "isOptional": true + } + ], + "value": "export interface PickerOptions {\n /**\n * The heading displayed at the top of the picker modal. Use a clear, descriptive title that tells merchants what they're selecting.\n */\n heading: string;\n /**\n * The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `3` allows up to three items).\n */\n multiple?: boolean | number;\n /**\n * The list of items that merchants can select from. Each item appears as a row in the picker table.\n */\n items: Item[];\n /**\n * The column headers for the picker table. Define headers to label and organize the data columns displayed for each item. The header order determines the column layout.\n */\n headers?: Header[];\n}" + } + }, + "Header": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "Header", + "description": "The configuration for a table column header in the picker. Each header creates a labeled column that displays corresponding data from items.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The label text displayed at the top of the table column. Use clear, concise labels that describe the data in that column (for example, \"Price\", \"Status\", \"Last Updated\").", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'string' | 'number'", + "description": "The data type that controls column formatting and text alignment. Use `'number'` for currency, prices, or numeric values (displays right-aligned), or `'string'` for text content (displays left-aligned).", + "isOptional": true, + "defaultValue": "'string'" + } + ], + "value": "export interface Header {\n /**\n * The label text displayed at the top of the table column. Use clear, concise labels that describe the data in that column (for example, \"Price\", \"Status\", \"Last Updated\").\n */\n content?: string;\n /**\n * The data type that controls column formatting and text alignment. Use `'number'` for currency, prices, or numeric values (displays right-aligned), or `'string'` for text content (displays left-aligned).\n * @defaultValue 'string'\n */\n type?: 'string' | 'number';\n}" + } + }, + "Item": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "Item", + "description": "An individual item that merchants can select in the picker. Each item appears as a row in the picker table.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "badges", + "value": "PickerBadge[]", + "description": "Status or context badges displayed next to the heading in the first column. Use badges to highlight item state, completion status, or other important attributes (for example, \"Draft\", \"Published\", \"Incomplete\").", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "DataPoint[]", + "description": "Additional data displayed in subsequent columns after the heading. Each value appears in its own column, and the order must match the `headers` array. For example, if headers are `[\"Price\", \"Status\"]`, then data would be `[19.99, \"Active\"]`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the item can be selected. When `true`, the item is disabled and can't be selected. Disabled items appear grayed out and merchants can't choose them. Use this for items that are unavailable or don't meet selection criteria.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The primary text displayed in the first column. This is typically the item's name or title and is the most prominent text in the row." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique identifier for this item. This ID is returned in the selection array when the merchant selects this item. Use an ID that helps you identify the item in your system (for example, template IDs, review IDs, or custom option keys)." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the item is preselected when the picker opens. When `true`, the item appears selected by default. Merchants can still deselect preselected items. Use this to show current selections or suggest default choices.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "thumbnail", + "value": "{ url: string; }", + "description": "A small preview image or icon displayed at the start of the row. Thumbnails help merchants visually identify items at a glance. Provide a URL to the image file.", + "isOptional": true + } + ], + "value": "export interface Item {\n /**\n * The unique identifier for this item. This ID is returned in the selection array when the merchant selects this item. Use an ID that helps you identify the item in your system (for example, template IDs, review IDs, or custom option keys).\n */\n id: string;\n /**\n * The primary text displayed in the first column. This is typically the item's name or title and is the most prominent text in the row.\n */\n heading: string;\n /**\n * Additional data displayed in subsequent columns after the heading. Each value appears in its own column, and the order must match the `headers` array. For example, if headers are `[\"Price\", \"Status\"]`, then data would be `[19.99, \"Active\"]`.\n */\n data?: DataPoint[];\n /**\n * Whether the item can be selected. When `true`, the item is disabled and can't be selected. Disabled items appear grayed out and merchants can't choose them. Use this for items that are unavailable or don't meet selection criteria.\n * @defaultValue false\n */\n disabled?: boolean;\n /**\n * Whether the item is preselected when the picker opens. When `true`, the item appears selected by default. Merchants can still deselect preselected items. Use this to show current selections or suggest default choices.\n */\n selected?: boolean;\n /**\n * Status or context badges displayed next to the heading in the first column. Use badges to highlight item state, completion status, or other important attributes (for example, \"Draft\", \"Published\", \"Incomplete\").\n */\n badges?: PickerBadge[];\n /**\n * A small preview image or icon displayed at the start of the row. Thumbnails help merchants visually identify items at a glance. Provide a URL to the image file.\n */\n thumbnail?: {url: string};\n}" + } + }, + "PickerBadge": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "PickerBadge", + "description": "A badge displayed next to an item in the picker to show status or progress. Use badges to highlight important item attributes or states that affect selection decisions.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The text content of the badge. Keep this short and descriptive (for example, \"Draft\", \"Active\", \"Incomplete\")." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "progress", + "value": "Progress", + "description": "The progress indicator for the badge. Use this to show completion status for items that have progress states.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "Tone", + "description": "The visual tone indicating status or importance. Choose a tone that matches the badge's meaning.", + "isOptional": true + } + ], + "value": "export interface PickerBadge {\n /** The text content of the badge. Keep this short and descriptive (for example, \"Draft\", \"Active\", \"Incomplete\"). */\n content: string;\n /** The visual tone indicating status or importance. Choose a tone that matches the badge's meaning. */\n tone?: Tone;\n /** The progress indicator for the badge. Use this to show completion status for items that have progress states. */\n progress?: Progress;\n}" + } + }, + "Progress": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Progress", + "value": "'incomplete' | 'partiallyComplete' | 'complete'", + "description": "The progress state for picker badges showing completion status. Use this to indicate how complete an item is: `'incomplete'` for not started, `'partiallyComplete'` for in progress, or `'complete'` for finished.", + "isPublicDocs": true + } + }, + "Tone": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Tone", + "value": "'info' | 'success' | 'warning' | 'critical'", + "description": "The visual tone for picker badges indicating status or importance. Use different tones to communicate urgency or state: `'info'` for neutral information, `'success'` for positive states, `'warning'` for caution, or `'critical'` for urgent issues.", + "isPublicDocs": true + } + }, + "DataPoint": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DataPoint", + "value": "string | number | undefined", + "description": "A single data point that can appear in a picker table cell. Can be text, a number, or undefined if the cell should be empty.", + "isPublicDocs": true + } + }, + "Picker": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "Picker", + "description": "A handle returned when opening a picker dialog. Use this to access the merchant's selection after they confirm or cancel the picker.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "Promise", + "description": "A Promise that resolves with an array of selected item IDs when the merchant presses the **Select** button, or `undefined` if they cancel. Await this Promise to handle the selection result." + } + ], + "value": "export interface Picker {\n /**\n * A Promise that resolves with an array of selected item IDs when the merchant presses the **Select** button, or `undefined` if they cancel. Await this Promise to handle the selection result.\n */\n selected: Promise;\n}" + } + }, + "ApiVersion": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ApiVersion", + "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04' | '2026-07'", + "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." + } + }, + "ResourcePickerApi": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ResourcePickerApi", + "description": "Opens the resource picker modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel.", + "isPublicDocs": true, + "params": [ + { + "name": "options", + "description": "", + "value": "ResourcePickerOptions", + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "description": "", + "name": "Promise | undefined>", + "value": "Promise | undefined>" + }, + "value": "(\n options: ResourcePickerOptions,\n) => Promise | undefined>" + } + }, + "ResourcePickerOptions": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ResourcePickerOptions", + "description": "The `ResourcePickerOptions` object defines how the resource picker behaves, including which resource type to display, selection limits, filters, and preselected items. Access the following properties on the `ResourcePickerOptions` object to configure the resource picker's appearance and functionality.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "'add' | 'select'", + "description": "The action verb that appears in the picker's title and primary button. Use `'add'` for actions that add new items (for example, \"Add products\") or `'select'` for choosing existing items (for example, \"Select products\"). This helps merchants understand the picker's purpose.", + "isOptional": true, + "defaultValue": "'add'" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "filter", + "value": "Filters", + "description": "Filtering options that control which resources appear in the picker. Use filters to restrict resources by publication status, include or exclude variants, or apply custom search criteria. This helps merchants find relevant items faster.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean | number", + "description": "The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `5` allows up to five items). When `type` is `'product'`, merchants can still select multiple variants from a single product even if `multiple` is `false`.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "string", + "description": "An initial search query that appears in the picker's search bar when it opens. Merchants can see and edit this query. See [search syntax](/docs/api/usage/search-syntax) for the query format. For most use cases, use `filter.query` instead, which filters results without exposing the query to merchants.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "selectionIds", + "value": "BaseResource[]", + "description": "Resources that should be preselected when the picker opens. Pass an array of resource objects with IDs (and optional variant IDs) to show which items are already selected. Merchants can deselect these preselected items. Use this to show current selections or default choices.", + "isOptional": true, + "defaultValue": "[]" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'product' | 'variant' | 'collection'", + "description": "The type of Shopify resource to select: `'product'` for products, `'variant'` for specific product variants, or `'collection'` for collections. This determines what appears in the picker and what data structure is returned." + } + ], + "value": "export interface ResourcePickerOptions {\n /**\n * The type of Shopify resource to select: `'product'` for products, `'variant'` for specific product variants, or `'collection'` for collections. This determines what appears in the picker and what data structure is returned.\n */\n type: 'product' | 'variant' | 'collection';\n /**\n * The action verb that appears in the picker's title and primary button. Use `'add'` for actions that add new items (for example, \"Add products\") or `'select'` for choosing existing items (for example, \"Select products\"). This helps merchants understand the picker's purpose.\n * @defaultValue 'add'\n */\n action?: 'add' | 'select';\n /**\n * Filtering options that control which resources appear in the picker. Use filters to restrict resources by publication status, include or exclude variants, or apply custom search criteria. This helps merchants find relevant items faster.\n */\n filter?: Filters;\n /**\n * The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `5` allows up to five items). When `type` is `'product'`, merchants can still select multiple variants from a single product even if `multiple` is `false`.\n * @defaultValue false\n */\n multiple?: boolean | number;\n /**\n * An initial search query that appears in the picker's search bar when it opens. Merchants can see and edit this query. See [search syntax](/docs/api/usage/search-syntax) for the query format. For most use cases, use `filter.query` instead, which filters results without exposing the query to merchants.\n * @defaultValue ''\n */\n query?: string;\n /**\n * Resources that should be preselected when the picker opens. Pass an array of resource objects with IDs (and optional variant IDs) to show which items are already selected. Merchants can deselect these preselected items. Use this to show current selections or default choices.\n * @defaultValue []\n */\n selectionIds?: BaseResource[];\n}" + } + }, + "Filters": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Filters", + "description": "Filter options that control which resources appear in the resource picker. Use filters to restrict the available resources based on publication status, resource type, or custom search criteria.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "archived", + "value": "boolean | undefined", + "description": "Whether to include archived products in the picker. When `false`, archived products are hidden. When `undefined`, archived products appear with an archived badge. Only applies when `type` is `'product'`. Use this to prevent selecting discontinued products.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "draft", + "value": "boolean | undefined", + "description": "Whether to include draft products in the picker. When `false`, draft products are hidden. When `undefined`, draft products appear with a draft badge. Only applies when `type` is `'product'`. Use this to prevent selecting products that aren't ready for use.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Whether to include products that aren't published on any sales channels. When `false`, only products published to at least one sales channel appear in the picker. Use this to ensure merchants only select products that customers can purchase.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "string", + "description": "A GraphQL search query that filters the available resources without showing the query in the picker's search bar. Merchants won't see or edit this filter. See [search syntax](/docs/api/usage/search-syntax) for the query format. Use this to programmatically restrict resources based on attributes like tags, vendor, or product type (for example, `\"tag:featured\"` or `\"vendor:Acme\"`).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "variants", + "value": "boolean", + "description": "Whether to show product variants in the picker. When `false`, merchants can only select products, not individual variants. Only applies when `type` is `'product'`. Use this to simplify selection when you only need product-level data.", + "isOptional": true, + "defaultValue": "true" + } + ], + "value": "export interface Filters {\n /**\n * Whether to include products that aren't published on any sales channels. When `false`, only products published to at least one sales channel appear in the picker. Use this to ensure merchants only select products that customers can purchase.\n * @defaultValue true\n */\n hidden?: boolean;\n /**\n * Whether to show product variants in the picker. When `false`, merchants can only select products, not individual variants. Only applies when `type` is `'product'`. Use this to simplify selection when you only need product-level data.\n * @defaultValue true\n */\n variants?: boolean;\n /**\n * Whether to include draft products in the picker. When `false`, draft products are hidden. When `undefined`, draft products appear with a draft badge. Only applies when `type` is `'product'`. Use this to prevent selecting products that aren't ready for use.\n * @defaultValue true\n */\n draft?: boolean | undefined;\n /**\n * Whether to include archived products in the picker. When `false`, archived products are hidden. When `undefined`, archived products appear with an archived badge. Only applies when `type` is `'product'`. Use this to prevent selecting discontinued products.\n * @defaultValue true\n */\n archived?: boolean | undefined;\n /**\n * A GraphQL search query that filters the available resources without showing the query in the picker's search bar. Merchants won't see or edit this filter. See [search syntax](/docs/api/usage/search-syntax) for the query format. Use this to programmatically restrict resources based on attributes like tags, vendor, or product type (for example, `\"tag:featured\"` or `\"vendor:Acme\"`).\n */\n query?: string;\n}" + } + }, + "BaseResource": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "BaseResource", + "description": "A resource structure that can optionally include associated variants. Use this type for specifying preselected items in the resource picker when you need to include variant selections.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The resource identifier in GraphQL global ID format (for example, `gid://shopify/Product/123`)." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "variants", + "value": "Resource[]", + "description": "An array of variant resources to preselect along with the main resource. Only applicable when the main resource is a product that has variants you want to preselect.", + "isOptional": true + } + ], + "value": "export interface BaseResource extends Resource {\n /** An array of variant resources to preselect along with the main resource. Only applicable when the main resource is a product that has variants you want to preselect. */\n variants?: Resource[];\n}" + } + }, + "Resource": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Resource", + "description": "The base resource structure with a unique identifier.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The resource identifier in GraphQL global ID format (for example, `gid://shopify/Product/123`)." + } + ], + "value": "export interface Resource {\n /** The resource identifier in GraphQL global ID format (for example, `gid://shopify/Product/123`). */\n id: string;\n}" + } + }, + "SelectPayload": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SelectPayload", + "value": "SelectPayload", + "description": "The payload returned when resources are selected from the picker.", + "isPublicDocs": true + } + }, + "ActionExtensionComponents": { + "src/surfaces/admin/components/ActionExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/ActionExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionExtensionComponents", + "value": "StandardComponents | 'AdminAction'", + "description": "The components available for building action extensions. Includes all standard components plus the admin action component required for action extension setup." + } + }, + "StandardComponents": { + "src/surfaces/admin/components/StandardComponents.ts": { + "filePath": "src/surfaces/admin/components/StandardComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "StandardComponents", + "value": "'Avatar' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'ButtonGroup' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ColorField' | 'ColorPicker' | 'DateField' | 'DatePicker' | 'DropZone' | 'Divider' | 'EmailField' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Menu' | 'MoneyField' | 'NumberField' | 'Option' | 'OptionGroup' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'QueryContainer' | 'SearchField' | 'Section' | 'Select' | 'Spinner' | 'Stack' | 'Switch' | 'Table' | 'TableBody' | 'TableCell' | 'TableHeader' | 'TableHeaderRow' | 'TableRow' | 'Text' | 'TextArea' | 'TextField' | 'Thumbnail' | 'Tooltip' | 'UnorderedList' | 'URLField'", + "description": "The standard set of UI components available in most admin extensions. These components provide the building blocks for creating extension interfaces including layout elements, form inputs, data display, navigation, and interactive controls. Use these components to build consistent, accessible UIs that match the Shopify admin design system." + } + }, + "Avatar": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Avatar", + "description": "Configure the following properties on the avatar component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "initials", + "value": "string", + "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The URL or path to the avatar image. When provided, the image takes priority over `initials`. If the image fails to load or loads slowly, `initials` will be rendered as a fallback.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"small-200\" | \"base\" | \"large\" | \"large-200\"", + "description": "The size of the avatar image.\n\n- `small-200`: Extra small avatar, suitable for compact displays or lists with many items.\n- `small`: Small avatar, good for secondary contexts or tight layouts.\n- `base`: Default size that works well in most contexts.\n- `large`: Large avatar for emphasis or when the avatar is a focal point.\n- `large-200`: Extra large avatar for prominent display.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the avatar for accessibility.\n\nProvides a text description of the avatar for users with assistive technology and serves as a fallback when the avatar fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an avatar, it reads this description aloud. When an avatar fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Avatar extends PreactCustomElement implements AvatarProps {\n accessor initials: AvatarProps['initials'];\n accessor src: AvatarProps['src'];\n accessor size: AvatarProps['size'];\n accessor alt: AvatarProps['alt'];\n constructor();\n}" + } + }, + "ClickOptions": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickOptions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "sourceEvent", + "value": "ActivationEventEsque", + "description": "The event you want to influence the synthetic click.", + "isOptional": true + } + ], + "value": "export interface ClickOptions {\n /**\n * The event you want to influence the synthetic click.\n */\n sourceEvent?: ActivationEventEsque;\n}" + } + }, + "ActivationEventEsque": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ActivationEventEsque", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "button", + "value": "number", + "description": "The button number that was pressed on the mouse. 0 for left button, 1 for middle button, 2 for right button." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ctrlKey", + "value": "boolean", + "description": "Whether the Ctrl key was pressed when the event occurred." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "metaKey", + "value": "boolean", + "description": "Whether the Meta/Command key (Mac) or Windows key was pressed when the event occurred." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "shiftKey", + "value": "boolean", + "description": "Whether the Shift key was pressed when the event occurred." + } + ], + "value": "export interface ActivationEventEsque {\n /**\n * Whether the Shift key was pressed when the event occurred.\n */\n shiftKey: boolean;\n /**\n * Whether the Meta/Command key (Mac) or Windows key was pressed when the event occurred.\n */\n metaKey: boolean;\n /**\n * Whether the Ctrl key was pressed when the event occurred.\n */\n ctrlKey: boolean;\n /**\n * The button number that was pressed on the mouse. 0 for left button, 1 for middle button, 2 for right button.\n */\n button: number;\n}" + } + }, + "Badge": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Badge", + "description": "Configure the following properties on the badge component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"strong\"", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `strong`: Increased visual weight for higher emphasis and prominence.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"base\" | \"large\" | \"large-100\"", + "description": "The size of the badge.\n\n- `base`: Default size suitable for most badge use cases.\n- `large`: Larger badge for increased visibility and prominence.\n- `large-100`: Extra large badge for maximum visibility in emphasized contexts.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\" | \"neutral\" | \"caution\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `caution`: Advisory notices that need attention.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Badge extends PreactCustomElement implements BadgeProps {\n accessor color: BadgeProps['color'];\n accessor icon: BadgeProps['icon'];\n accessor size: BadgeProps['size'];\n accessor tone: BadgeProps['tone'];\n constructor();\n}" + } + }, + "Banner": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Banner", + "description": "Configure the following properties on the banner component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the banner.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hidden", + "value": "boolean", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "dismissible", + "value": "boolean", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event fires, then `hidden` is set to `true`, any animation completes, and the `afterhide` event fires.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Banner extends PreactCustomElement implements BannerProps {\n accessor heading: BannerProps['heading'];\n accessor tone: BannerProps['tone'];\n accessor hidden: BannerProps['hidden'];\n accessor dismissible: BannerProps['dismissible'];\n constructor();\n}" + } + }, + "Box": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Box", + "description": "Configure the following properties on the box component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Box extends BoxElement implements BoxProps {\n constructor();\n}" + } + }, + "AccessibilityRole": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AccessibilityRole", + "value": "'main' | 'header' | 'footer' | 'section' | 'aside' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'status' | 'alert' | 'generic' | 'presentation' | 'none'", + "description": "Defines the semantic role of a component for assistive technologies like screen readers.\n\nAccessibility roles help users with disabilities understand the purpose and structure of content. These roles map to HTML elements and ARIA roles, providing semantic meaning beyond visual presentation.\n\nUse these roles to:\n- Improve navigation for screen reader users\n- Provide semantic structure to your UI\n- Ensure proper interpretation by assistive technologies\n\nLearn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles) in the MDN web docs.\n\n- `main`: Indicates the primary content area of the page.\n- `header`: Marks a component as a header containing introductory content or navigation.\n- `footer`: Designates content containing information like copyright, navigation links, or privacy statements.\n- `section`: Defines a generic thematic grouping of content that should have a heading or accessible label.\n- `aside`: Marks supporting content that relates to but is separate from the main content.\n- `navigation`: Identifies major groups of navigation links for moving around the site or page.\n- `ordered-list`: Represents a list where the order of items is meaningful.\n- `list-item`: Identifies an individual item within a list.\n- `list-item-separator`: Acts as a visual and semantic divider between items in a list.\n- `unordered-list`: Represents a list where the order of items is not meaningful.\n- `separator`: Creates a divider that separates and distinguishes sections of content.\n- `status`: Defines a live region for advisory information that is not urgent enough to be an alert.\n- `alert`: Marks important, time-sensitive information that requires the user's immediate attention.\n- `generic`: Creates a semantically neutral container element with no inherent meaning.\n- `presentation`: Removes semantic meaning from an element while preserving its visual appearance.\n- `none`: Synonym for `presentation`, removes semantic meaning while keeping visual styling.", + "isPublicDocs": true + } + }, + "BackgroundColorKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BackgroundColorKeyword", + "value": "'transparent' | ColorKeyword", + "description": "Defines the background color intensity or emphasis level for UI elements.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isPublicDocs": true + } + }, + "ColorKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColorKeyword", + "value": "'subdued' | 'base' | 'strong'", + "description": "Defines the color intensity or emphasis level for text and UI elements.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", + "isPublicDocs": true + } + }, + "SizeUnitsOrAuto": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnitsOrAuto", + "value": "SizeUnits | 'auto'", + "description": "Represents size values that can also be set to `auto` for automatic sizing.\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isPublicDocs": true + } + }, + "SizeUnits": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnits", + "value": "`${number}px` | `${number}%` | `0`", + "description": "Represents size values in pixels, percentages, or zero.\n\n- `${number}px`: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`).\n- `${number}%`: Relative size as a percentage of the parent container (such as `50%`, `100%`).\n- `0`: Zero size, equivalent to no dimension.", + "isPublicDocs": true + } + }, + "SizeUnitsOrNone": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnitsOrNone", + "value": "SizeUnits | 'none'", + "description": "Represents size values that can also be set to `none` to remove the size constraint.\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `none`: No size constraint, allowing unlimited growth.", + "isPublicDocs": true + } + }, + "MaybeResponsive": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeResponsive", + "value": "T | `@container${string}`", + "description": "Makes a property responsive by allowing it to be set conditionally based on container query conditions. The value can be either a base value or a container query string.\n\n- `T`: Base value that applies in all conditions.\n- `@container${string}`: Container query string for conditional responsive styling based on container size.", + "isPublicDocs": true + } + }, + "MaybeAllValuesShorthandProperty": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeAllValuesShorthandProperty", + "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", + "description": "Represents CSS shorthand properties that accept one to four values. Supports specifying values for all four sides: top, right, bottom, and left.\n\n- `T`: Single value that applies to all four sides.\n- `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right).\n- `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom).\n- `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left).", + "isPublicDocs": true + } + }, + "PaddingKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PaddingKeyword", + "value": "SizeKeyword | 'none'", + "description": "Defines the padding size for elements, using the standard size scale or `none` for no padding.\n\n- `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing.\n- `none`: No padding.", + "isPublicDocs": true + } + }, + "SizeKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeKeyword", + "value": "'small-500' | 'small-400' | 'small-300' | 'small-200' | 'small-100' | 'small' | 'base' | 'large' | 'large-100' | 'large-200' | 'large-300' | 'large-400' | 'large-500'", + "description": "Defines component sizes using a consistent scale from extra small to extra large.\n\n- `small-500` through `small-100`: Extra small to small sizes, progressively increasing.\n- `small`: Standard small size.\n- `base`: Default medium size that works well in most contexts.\n- `large`: Standard large size.\n- `large-100` through `large-500`: Large to extra large sizes, progressively increasing.", + "isPublicDocs": true + } + }, + "MaybeTwoValuesShorthandProperty": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeTwoValuesShorthandProperty", + "value": "T | `${T} ${T}`", + "description": "Represents CSS shorthand properties that accept one or two values. Supports specifying the same value for both dimensions or different values.\n\n- `T`: Single value that applies to both dimensions.\n- `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal).", + "isPublicDocs": true + } + }, + "BorderShorthand": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderShorthand", + "value": "BorderSizeKeyword | `${BorderSizeKeyword} ${ColorKeyword}` | `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`", + "description": "Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style.", + "isPublicDocs": true + } + }, + "BorderSizeKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderSizeKeyword", + "value": "SizeKeyword | 'none'", + "description": "Defines the width of borders, using the standard size scale or `none` for no border.\n\n- `SizeKeyword`: Standard border widths from the size scale for consistent thickness.\n- `none`: No border width (removes the border).", + "isPublicDocs": true + } + }, + "BorderStyleKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderStyleKeyword", + "value": "'none' | 'solid' | 'dashed' | 'dotted' | 'auto'", + "description": "Defines the visual style of borders.\n\n- `none`: No border is displayed.\n- `solid`: A single solid line.\n- `dashed`: A series of short dashes.\n- `dotted`: A series of dots.\n- `auto`: Automatically determined based on context.", + "isPublicDocs": true + } + }, + "BoxBorderStyles": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BoxBorderStyles", + "value": "'auto' | 'none' | 'solid' | 'dashed'", + "description": "Represents the subset of border style values supported by the box component.\n\n- `auto`: Default border style determined by the system.\n- `none`: No border style (removes the border).\n- `solid`: Continuous line border.\n- `dashed`: Border made up of dashes.", + "isPublicDocs": true + } + }, + "BoxBorderRadii": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BoxBorderRadii", + "value": "'small' | 'small-200' | 'small-100' | 'base' | 'large' | 'large-100' | 'large-200' | 'none'", + "description": "Represents the subset of border radius values supported by the component.\n\n- `small-200`: Extra small radius for subtle rounding.\n- `small-100`: Small radius for minimal corner rounding.\n- `small`: Standard small radius.\n- `base`: Medium radius for moderate corner rounding.\n- `large`: Standard large radius for pronounced rounding.\n- `large-100`: Large radius for more prominent corner rounding.\n- `large-200`: Extra large radius for maximum rounding.\n- `none`: No border radius (sharp corners).", + "isPublicDocs": true + } + }, + "Button": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Button", + "description": "Configure the following properties on the button component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "An icon displayed inside the button, typically positioned before the button text. Use icons to help users quickly identify the button's action or to improve scannability. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "variant", + "value": "\"auto\" | \"primary\" | \"secondary\" | \"tertiary\"", + "description": "The visual appearance of the button component.\n\n- `auto`: The variant is automatically determined by the button component's context.\n- `primary`: High emphasis button for the primary action on the page. Should be used sparingly.\n- `secondary`: Medium emphasis button for secondary actions.\n- `tertiary`: Low emphasis button for less important actions.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"critical\" | \"auto\" | \"neutral\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "target", + "value": "\"auto\" | AnyString | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"button\" | \"reset\" | \"submit\"", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "defaultValue": "'button'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class Button extends Button_base implements ButtonProps {\n accessor disabled: ButtonProps['disabled'];\n accessor icon: ButtonProps['icon'];\n accessor loading: ButtonProps['loading'];\n accessor variant: ButtonProps['variant'];\n accessor tone: ButtonProps['tone'];\n accessor target: ButtonProps['target'];\n accessor href: ButtonProps['href'];\n accessor download: ButtonProps['download'];\n accessor type: ButtonProps['type'];\n accessor accessibilityLabel: ButtonProps['accessibilityLabel'];\n constructor();\n}" + } + }, + "AnyString": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyString", + "value": "string & {}", + "description": "A utility type that enables autocomplete for specific string literals while still accepting any string value. By intersecting `string` with an empty object type, this prevents TypeScript from widening literal types, preserving IDE suggestions for known values while maintaining flexibility for custom strings.", + "isPublicDocs": true + } + }, + "ButtonGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonGroup", + "description": "Configure the following properties on the button group component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gap", + "value": "\"base\" | \"none\"", + "description": "The spacing between buttons in the group.\n\n- `base`: Standard spacing that provides clear visual separation between buttons.\n- `none`: No spacing, creating a connected button group.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ButtonGroup\n extends PreactCustomElement\n implements ButtonGroupProps\n{\n accessor gap: ButtonGroupProps['gap'];\n accessor accessibilityLabel: ButtonGroupProps['accessibilityLabel'];\n constructor();\n}" + } + }, + "Checkbox": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Checkbox", + "description": "Configure the following properties on the checkbox component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "indeterminate", + "value": "boolean", + "description": "Whether the checkbox displays in an indeterminate state (neither checked nor unchecked), typically used to indicate partial selection in hierarchical lists.\n\nThis visual state takes priority over the `checked` prop in appearance only. The form submission value is still determined by the `checked` prop.\n\nIf `indeterminate` has not been explicitly set and hasn't been modified by user interaction, it returns the value of `defaultIndeterminate`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultIndeterminate", + "value": "boolean", + "description": "The initial indeterminate state for uncontrolled components. Use this when you want the checkbox to start in an indeterminate state but don't need to control it afterward.\n\nThis value applies until `indeterminate` is explicitly set or the user changes the checkbox state by clicking.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked. Use this for controlled components where you manage the checked state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The value used in form data when the checkbox is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultChecked", + "value": "boolean", + "description": "The initial checked state for uncontrolled components. Use this when you want the control to start checked but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "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.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Checkbox extends PreactCheckboxElement implements CheckboxProps {\n get indeterminate(): CheckboxProps['indeterminate'];\n set indeterminate(indeterminate: CheckboxProps['indeterminate']);\n accessor defaultIndeterminate: CheckboxProps['defaultIndeterminate'];\n constructor();\n}" + } + }, + "Chip": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Chip", + "description": "Configure the following properties on the chip component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Chip extends PreactCustomElement implements ChipProps {\n accessor color: ChipProps['color'];\n accessor accessibilityLabel: ChipProps['accessibilityLabel'];\n constructor();\n}" + } + }, + "Choice": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Choice", + "description": "The choice component creates individual selectable options within a choice list. Use choice to define each option that merchants can select, supporting both single selection (radio buttons) and multiple selection (checkboxes) modes.\n\nChoice components support labels, help text, and custom content through slots, providing flexible option presentation within choice lists.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "selected", + "value": "boolean", + "description": "Whether the option is currently selected. Use this for controlled components where you manage the selection state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultSelected", + "value": "boolean", + "description": "The initial selected state for uncontrolled components. Use this when you want the option to start selected but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Choice extends PreactCustomElement implements ChoiceProps {\n accessor disabled: ChoiceProps['disabled'];\n get selected(): boolean;\n set selected(selected: ChoiceProps['selected']);\n accessor value: ChoiceProps['value'];\n accessor accessibilityLabel: ChoiceProps['accessibilityLabel'];\n accessor defaultSelected: ChoiceProps['defaultSelected'];\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "ChoiceList": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceList", + "description": "Configure the following properties on the choice list component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction. When `true`, the `disabled` property on any child choices is ignored.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple choices can be selected.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "values", + "value": "string[]", + "description": "An array of `value` attributes for the currently selected options. When provided, this property automatically sets the `selected` state on child option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$3@2409", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ChoiceList extends BaseClass$3 implements ChoiceListProps {\n accessor disabled: ChoiceListProps['disabled'];\n accessor name: ChoiceListProps['name'];\n accessor error: ChoiceListProps['error'];\n accessor details: ChoiceListProps['details'];\n accessor multiple: ChoiceListProps['multiple'];\n accessor label: ChoiceListProps['label'];\n accessor labelAccessibilityVisibility: ChoiceListProps['labelAccessibilityVisibility'];\n get values(): ChoiceListProps['values'];\n set values(values: ChoiceListProps['values']);\n /** @private */\n formResetCallback(): void;\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "Clickable": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Clickable", + "description": "Configure the following properties on the clickable component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the component is disabled, preventing clicks and focus. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You shouldapply disabled styling as needed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether the component is in a loading state, which indicates to assistive technology that an action is in progress and prevents interaction.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "target", + "value": "\"auto\" | AnyString | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"button\" | \"reset\" | \"submit\"", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "defaultValue": "'button'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class Clickable extends Clickable_base implements ClickableProps {\n accessor disabled: ClickableProps['disabled'];\n accessor loading: ClickableProps['loading'];\n accessor target: ClickableProps['target'];\n accessor href: ClickableProps['href'];\n accessor download: ClickableProps['download'];\n accessor type: ClickableProps['type'];\n constructor();\n}" + } + }, + "ClickableChip": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableChip", + "description": "Configure the following properties on the clickable chip component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "removable", + "value": "boolean", + "description": "Whether the chip displays a remove button for dismissal. When clicked, the `remove` callback fires.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hidden", + "value": "boolean", + "description": "Whether the chip is hidden from view. When using controlled component pattern with `removable` chips, update this property when the `remove` event fires. For non-removable chips, manually toggle this property to show or hide the chip.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the chip is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class ClickableChip\n extends ClickableChip_base\n implements ClickableChipProps\n{\n accessor color: ClickableChipProps['color'];\n accessor accessibilityLabel: ClickableChipProps['accessibilityLabel'];\n accessor removable: ClickableChipProps['removable'];\n accessor hidden: ClickableChipProps['hidden'];\n accessor disabled: ClickableChipProps['disabled'];\n accessor href: ClickableChipProps['href'];\n constructor();\n}" + } + }, + "ColorField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorField", + "description": "Configure the following properties on the color field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alpha", + "value": "boolean", + "description": "Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected color value. Accepts multiple input formats:\n\n- Hex: `#RGB`, `#RRGGBB`, `#RRGGBBAA` (3, 6, or 8 digits)\n- RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)\n- HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`\n\nReturns an empty string if the value is invalid. The `change` event always emits values in hex format.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setInternalValue", + "value": "(value: string, normalize: boolean) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\"", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ColorField\n extends PreactFieldElement\n implements ColorFieldProps\n{\n accessor alpha: ColorFieldProps['alpha'];\n get value(): string;\n set value(value: string);\n /** @private */\n formResetCallback(): void;\n constructor();\n /** @private */\n setInternalValue(value: string, normalize: boolean): void;\n}" + } + }, + "ColorPicker": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorPicker", + "description": "Configure the following properties on the color picker component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alpha", + "value": "boolean", + "description": "Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial color value when the field first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts interacting, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected color value. Accepts multiple input formats:\n\n- Hex: `#RGB`, `#RRGGBB`, `#RRGGBBAA` (3, 6, or 8 digits)\n- RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)\n- HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`\n\nReturns an empty string if the value is invalid. The `change` event always emits values in hex format.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "A callback that fires when the containing form is reset (using the form's `reset()` method or a reset button). When triggered, the component's `value` reverts to its `defaultValue`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$2@2510", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ColorPicker extends BaseClass$2 implements ColorPickerProps {\n accessor alpha: boolean;\n accessor name: string;\n accessor defaultValue: string;\n get value(): string;\n set value(value: string);\n /**\n * A callback that fires when the containing form is reset (using the form's `reset()` method or a reset button). When triggered, the component's `value` reverts to its `defaultValue`.\n */\n formResetCallback(): void;\n constructor();\n}" + } + }, + "DateField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DateField", + "description": "Configure the following properties on the date field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allow", + "value": "string", + "description": "Specifies which dates can be selected as a comma-separated list. An empty string (default) allows all dates.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `2024-02--2025`: February 2024 through end of 2025\n- `2024-05-09, 2024-05-11`: Only May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallow", + "value": "string", + "description": "Specifies which dates can't be selected as a comma-separated list. These dates are excluded from those specified in `allow`. An empty string (default) has no effect.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `--2024-02`: All dates before February 2024\n- `2024-05-09, 2024-05-11`: May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allowDays", + "value": "string", + "description": "Specifies which days of the week can be selected as a comma-separated list. Further restricts dates from `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (only weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallowDays", + "value": "string", + "description": "Specifies which days of the week can't be selected as a comma-separated list. Excludes days from `allowDays` and intersects with `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (no weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "SetAccessor", + "name": "view", + "value": "string", + "description": "The currently displayed month in `YYYY-MM` format. When changed, the `viewchange` callback is triggered. Defaults to `defaultView`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultView", + "value": "string", + "description": "The default month to display in `YYYY-MM` format. Used until the `view` callback is set by user interaction or programmatically. Defaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "DateAutocompleteField", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected date in `YYYY-MM-DD` format. An empty string means no date is selected.", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class DateField\n extends PreactFieldElement\n implements DateFieldProps\n{\n accessor allow: DateFieldProps['allow'];\n accessor disallow: DateFieldProps['disallow'];\n accessor allowDays: DateFieldProps['allowDays'];\n accessor disallowDays: DateFieldProps['disallowDays'];\n set view(view: string);\n get view(): string;\n accessor defaultView: DateFieldProps['defaultView'];\n constructor();\n}" + } + }, + "DateAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DateAutocompleteField", + "value": "'bday-day' | 'bday-month' | 'bday-year' | 'bday' | 'cc-expiry-month' | 'cc-expiry-year' | 'cc-expiry'", + "description": "Represents autocomplete values that are valid for date input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for date-based inputs.\n\nAvailable values:\n- `bday` - Complete birthday date\n- `bday-day` - Day component of a birthday (1-31)\n- `bday-month` - Month component of a birthday (1-12)\n- `bday-year` - Year component of a birthday (1990)\n- `cc-expiry` - Complete credit card expiration date\n- `cc-expiry-month` - Month component of a credit card expiration date (1-12)\n- `cc-expiry-year` - Year component of a credit card expiration date (2025)", + "isPublicDocs": true + } + }, + "DatePicker": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DatePicker", + "description": "Configure the following properties on the date picker component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultView", + "value": "string", + "description": "The default month to display in `YYYY-MM` format. Used until the `view` callback is set by user interaction or programmatically. Defaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "SetAccessor", + "name": "view", + "value": "string", + "description": "The currently displayed month in `YYYY-MM` format. When changed, the `viewchange` callback is triggered. Defaults to `defaultView`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allow", + "value": "string", + "description": "Specifies which dates can be selected as a comma-separated list. An empty string (default) allows all dates.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `2024-02--2025`: February 2024 through end of 2025\n- `2024-05-09, 2024-05-11`: Only May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallow", + "value": "string", + "description": "Specifies which dates can't be selected as a comma-separated list. These dates are excluded from those specified in `allow`. An empty string (default) has no effect.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `--2024-02`: All dates before February 2024\n- `2024-05-09, 2024-05-11`: May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allowDays", + "value": "string", + "description": "Specifies which days of the week can be selected as a comma-separated list. Further restricts dates from `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (only weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallowDays", + "value": "string", + "description": "Specifies which days of the week can't be selected as a comma-separated list. Excludes days from `allowDays` and intersects with `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (no weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"single\" | \"range\"", + "description": "The type of date selection allowed.\n\n- `single`: Select a single date\n- `range`: Select a date range", + "defaultValue": "\"single\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initially selected date(s) when the component first renders. An empty string means no date is initially selected.\n\n- Single date in `YYYY-MM-DD` format when `type` is set to `\"single\"`\n- Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `\"range\"`", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "SetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected date(s). An empty string means no date is selected.\n\n- Single date in `YYYY-MM-DD` format when `type` is set to `\"single\"`\n- Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `\"range\"`", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@dirtyStateSymbol@2554", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$1@2553", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class DatePicker extends BaseClass$1 implements DatePickerProps {\n accessor defaultView: string;\n set view(view: string);\n get view(): string;\n accessor allow: DatePickerProps['allow'];\n accessor disallow: DatePickerProps['disallow'];\n accessor allowDays: DatePickerProps['allowDays'];\n accessor disallowDays: DatePickerProps['disallowDays'];\n accessor type: DatePickerProps['type'];\n accessor defaultValue: DatePickerProps['defaultValue'];\n accessor name: DatePickerProps['name'];\n set value(value: string);\n get value(): string;\n /** @private */\n [dirtyStateSymbol]: boolean;\n /** @private */\n formResetCallback(): void;\n constructor();\n}" + } + }, + "DropZone": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DropZone", + "description": "Configure the following properties on the drop zone component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accept", + "value": "string", + "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:\n- A file extension starting with a period (\".\") character (e.g. .jpg, .pdf, .doc)\n- A valid MIME type string with no extensions\n\nIf omitted, all file types are accepted.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple files can be selected or dropped at once.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "This sets the input value for a file type, which cannot be set programatically, so it can only be reset.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "files", + "value": "File[]", + "description": "An array of File objects representing the files currently selected by the user.\n\nThis property is read-only and cannot be directly modified. To clear the selected files, set the `value` prop to an empty string or null.", + "defaultValue": "[]", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@setFiles@2589", + "value": "(files: File[]) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@getFileInput@2591", + "value": "() => HTMLInputElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals@2590", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class DropZone extends BaseClass implements DropZoneProps {\n accessor accept: DropZoneProps['accept'];\n accessor accessibilityLabel: DropZoneProps['accessibilityLabel'];\n accessor disabled: DropZoneProps['disabled'];\n accessor error: DropZoneProps['error'];\n accessor label: DropZoneProps['label'];\n accessor labelAccessibilityVisibility: DropZoneProps['labelAccessibilityVisibility'];\n accessor multiple: DropZoneProps['multiple'];\n accessor name: DropZoneProps['name'];\n accessor required: DropZoneProps['required'];\n get value(): string;\n /** This sets the input value for a file type, which cannot be set programatically, so it can only be reset. */\n set value(value: '' | null);\n get files(): File[];\n set files(files: File[]);\n /** @private */\n [setFiles](files: File[]): void;\n /** @private */\n [getFileInput](): ReplaceType<\n Element | null | undefined,\n Element,\n HTMLInputElement\n >;\n\n /** @private */\n formResetCallback(): void;\n constructor();\n}" + } + }, + "Divider": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Divider", + "description": "Configure the following properties on the divider component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "direction", + "value": "\"inline\" | \"block\"", + "description": "The orientation of the divider line, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `inline`: Horizontal divider for separating vertically stacked content\n- `block`: Vertical divider for separating horizontally arranged content", + "defaultValue": "'inline'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"strong\"", + "description": "The visual prominence of the divider line.\n\n- `base`: Standard divider for most separations (default)\n- `strong`: More prominent divider for major section breaks", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Divider extends PreactCustomElement implements DividerProps {\n accessor direction: DividerProps['direction'];\n accessor color: DividerProps['color'];\n constructor();\n}" + } + }, + "EmailField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "EmailField", + "description": "Configure the following properties on the email field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | EmailAutocompleteField | `section-${string} email` | `section-${string} home email` | `section-${string} mobile email` | `section-${string} fax email` | `section-${string} pager email` | \"shipping email\" | \"shipping home email\" | \"shipping mobile email\" | ... 16 more ... | `section-${string} billing p...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current email address value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as an email address format when the user finishes editing.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class EmailField\n extends PreactFieldElement\n implements EmailFieldProps\n{\n accessor autocomplete: EmailFieldProps['autocomplete'];\n accessor maxLength: EmailFieldProps['maxLength'];\n accessor minLength: EmailFieldProps['minLength'];\n /**\n * The current email address value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as an email address format when the user finishes editing.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "EmailAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "EmailAutocompleteField", + "value": "'email' | 'home email' | 'mobile email' | 'fax email' | 'pager email'", + "description": "Represents autocomplete values that are valid for email input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for email inputs.\n\nAvailable values:\n- `email` - Primary email address\n- `home email` - Home email address\n- `mobile email` - Mobile device email address\n- `fax email` - Fax machine email address\n- `pager email` - Pager device email address", + "isPublicDocs": true + } + }, + "Grid": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Grid", + "description": "Configure the following properties on the grid component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridTemplateColumns", + "value": "string", + "description": "The columns in the grid and their sizes.\n\nAccepts:\n- [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), such as `1fr auto`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported track sizing values as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridTemplateRows", + "value": "string", + "description": "The rows in the grid and their sizes.\n\nAccepts:\n- [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), such as `1fr auto`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported track sizing values as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "justifyItems", + "value": "\"\" | JustifyItemsKeyword", + "description": "Aligns the grid items along the inline axis.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignItems", + "value": "\"\" | AlignItemsKeyword", + "description": "Aligns the grid items along the block axis.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeItems", + "value": "AlignItemsKeyword | \"normal normal\" | \"normal stretch\" | \"normal baseline\" | \"normal first baseline\" | \"normal last baseline\" | \"normal start\" | \"normal end\" | ... 188 more ... | \"safe center safe center\"", + "description": "A shorthand property for `justify-items` and `align-items`.", + "defaultValue": "'normal normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "justifyContent", + "value": "\"\" | JustifyContentKeyword", + "description": "Aligns the grid along the inline axis. This overrides the inline value of `placeContent`.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignContent", + "value": "\"\" | AlignContentKeyword", + "description": "Aligns the grid along the block axis. This overrides the block value of `placeContent`.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeContent", + "value": "\"normal normal\" | \"normal stretch\" | \"normal start\" | \"normal end\" | \"normal center\" | \"normal unsafe start\" | \"normal unsafe end\" | \"normal unsafe center\" | \"normal safe start\" | ... 229 more ... | \"space-evenly space-evenly\"", + "description": "A shorthand property for `justify-content` and `align-content`.", + "defaultValue": "'normal normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gap", + "value": "MaybeResponsive>", + "description": "Adjusts spacing between elements.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value applied to both axes, such as `large-100`\n- A pair of values, such as `large-100 large-500`, to set the inline and block axes respectively\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "rowGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "s spacing between elements in the block axis. This overrides the row value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "columnGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "Adjusts spacing between elements in the inline axis. This overrides the column value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Grid extends BoxElement implements GridProps {\n constructor();\n accessor gridTemplateColumns: GridProps['gridTemplateColumns'];\n accessor gridTemplateRows: GridProps['gridTemplateRows'];\n accessor justifyItems: GridProps['justifyItems'];\n accessor alignItems: GridProps['alignItems'];\n accessor placeItems: GridProps['placeItems'];\n accessor justifyContent: GridProps['justifyContent'];\n accessor alignContent: GridProps['alignContent'];\n accessor placeContent: GridProps['placeContent'];\n accessor gap: GridProps['gap'];\n accessor rowGap: GridProps['rowGap'];\n accessor columnGap: GridProps['columnGap'];\n}" + } + }, + "JustifyItemsKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "JustifyItemsKeyword", + "value": "'normal' | 'stretch' | BaselinePosition | OverflowPosition | ContentPosition", + "description": "Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis.\n\nLearn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).", + "isPublicDocs": true + } + }, + "BaselinePosition": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BaselinePosition", + "value": "'baseline' | 'first baseline' | 'last baseline'", + "description": "Represents baseline alignment positions used to align items relative to their baselines.\n- `baseline`: Aligns to the baseline of the parent.\n- `first baseline`: Aligns to the first baseline of the parent.\n- `last baseline`: Aligns to the last baseline of the parent.", + "isPublicDocs": true + } + }, + "OverflowPosition": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "OverflowPosition", + "value": "`unsafe ${ContentPosition}` | `safe ${ContentPosition}`", + "description": "Represents content positioning with overflow behavior control. Use `safe` to prevent content from becoming inaccessible when it overflows, or `unsafe` to allow overflow regardless of accessibility.", + "isPublicDocs": true + } + }, + "ContentPosition": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ContentPosition", + "value": "'center' | 'start' | 'end'", + "description": "Defines the position of content along an axis.\n- `center`: Centers the content.\n- `start`: Aligns content to the start.\n- `end`: Aligns content to the end.", + "isPublicDocs": true + } + }, + "AlignItemsKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AlignItemsKeyword", + "value": "'normal' | 'stretch' | BaselinePosition | OverflowPosition | ContentPosition", + "description": "Align items sets the align-self value on all direct children as a group.\n\nLearn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).", + "isPublicDocs": true + } + }, + "JustifyContentKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "JustifyContentKeyword", + "value": "'normal' | ContentDistribution | OverflowPosition | ContentPosition", + "description": "Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container.\n\nLearn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).", + "isPublicDocs": true + } + }, + "ContentDistribution": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ContentDistribution", + "value": "'space-between' | 'space-around' | 'space-evenly' | 'stretch'", + "description": "Defines how space is distributed between and around content items in flex and grid layouts.\n- `space-between`: Distributes items evenly with the first item at the start and last at the end.\n- `space-around`: Distributes items evenly with equal space around each item.\n- `space-evenly`: Distributes items evenly with equal space between them.\n- `stretch`: Stretches items to fill the container.", + "isPublicDocs": true + } + }, + "AlignContentKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AlignContentKeyword", + "value": "'normal' | BaselinePosition | ContentDistribution | OverflowPosition | ContentPosition", + "description": "Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis.\n\nLearn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).", + "isPublicDocs": true + } + }, + "SpacingKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingKeyword", + "value": "SizeKeyword | 'none'", + "description": "Defines the spacing size between elements, using the standard size scale or `none` for no spacing.", + "isPublicDocs": true + } + }, + "GridItem": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "GridItem", + "description": "The grid item component represents a single cell within a grid layout, allowing you to control how content is positioned and sized within the grid. Use grid item as a child of grid to specify column span, row span, and positioning for individual content areas.\n\nGrid item supports precise placement control through column and row properties, enabling you to create complex layouts where different items occupy varying amounts of space or appear in specific grid positions.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridColumn", + "value": "\"auto\" | `span ${number}`", + "description": "The number of columns the item will span across.\n\nLearn more about the [grid-column property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridRow", + "value": "\"auto\" | `span ${number}`", + "description": "The number of rows the item will span across.\n\nLearn more about the [grid-row property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class GridItem extends BoxElement implements GridItemProps {\n accessor gridColumn: GridItemProps['gridColumn'];\n accessor gridRow: GridItemProps['gridRow'];\n constructor();\n}" + } + }, + "Heading": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Heading", + "description": "Configure the following properties on the heading component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "\"none\" | \"presentation\" | \"heading\"", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `none`: Completely hides the element and its content from assistive technologies\n- `presentation`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.\n- `img`: Identifies the element as an image that conveys meaningful information to users.", + "defaultValue": "'heading'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "lineClamp", + "value": "number", + "description": "The maximum number of lines to display before truncating the text content.\n\nLearn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).", + "defaultValue": "Infinity - no truncation is applied", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Heading extends PreactCustomElement implements HeadingProps {\n accessor accessibilityRole: HeadingProps['accessibilityRole'];\n accessor lineClamp: HeadingProps['lineClamp'];\n accessor accessibilityVisibility: HeadingProps['accessibilityVisibility'];\n constructor();\n}" + } + }, + "Icon": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Icon", + "description": "Configure the following properties on the icon component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"subdued\"", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\" | \"neutral\" | \"caution\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `caution`: Advisory notices that need attention.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "The icon to display from the icon library.\n\nSet to a valid icon name to display that icon. To hide the icon completely, use an empty string `''`. To reserve the icon's space without displaying an icon, use `'empty'`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"base\"", + "description": "The size of the icon.\n\n- `small`: Smaller icon suitable for inline use within text or compact UI elements.\n- `base`: Default size that works well for standalone icons and standard use cases.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Icon extends PreactCustomElement implements IconProps {\n accessor color: IconProps['color'];\n accessor tone: IconProps['tone'];\n accessor type: IconProps['type'];\n accessor size: IconProps['size'];\n accessor interestFor: string;\n constructor();\n}" + } + }, + "Image": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Image", + "description": "Configure the following properties on the image component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. This overrides the `src` property.\n\nLearn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes.\n\nLearn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "defaultValue": "``", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "aspectRatio", + "value": "`${number}` | `${number}/${number}` | `${number}/ ${number}` | `${number} /${number}` | `${number} / ${number}`", + "description": "The aspect ratio of the image.\n\nThe rendering of the image will depend on the `inlineSize` value:\n\n- `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space.\n- `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored.\n\nFor 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`.\n\nLearn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).", + "defaultValue": "'1/1'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "objectFit", + "value": "\"contain\" | \"cover\"", + "description": "The image resizing behavior to fit within its container.\n\n- `contain`: Scales the image to fit within the container while maintaining its aspect ratio. The entire image is visible, but might leave empty space.\n- `cover`: Scales the image to fill the entire container while maintaining its aspect ratio. The image might be cropped to fit.\n\nThe image is always positioned in the center of the container.\n\nLearn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).", + "defaultValue": "'contain'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "\"eager\" | \"lazy\"", + "description": "The loading strategy for the image.\n\n- `eager`: Immediately loads the image, irrespective of its position within the visible viewport.\n- `lazy`: Delays loading the image until it approaches a specified distance from the viewport.\n\nLearn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).", + "defaultValue": "'eager'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "\"none\" | \"presentation\" | \"img\"", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `none`: Completely hides the element and its content from assistive technologies\n- `presentation`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.\n- `img`: Identifies the element as an image that conveys meaningful information to users.", + "defaultValue": "'img'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "\"auto\" | \"fill\"", + "description": "The displayed inline width of the image.\n\n- `fill`: the image will takes up 100% of the available inline size.\n- `auto`: the image will be displayed at its natural size.\n\nLearn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).", + "defaultValue": "'fill'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied around the image using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border around the image. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border around the image, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border around the image using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the image's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Image extends PreactCustomElement implements ImageProps {\n accessor src: ImageProps['src'];\n accessor srcSet: ImageProps['srcSet'];\n accessor sizes: ImageProps['sizes'];\n accessor alt: ImageProps['alt'];\n accessor aspectRatio: ImageProps['aspectRatio'];\n accessor objectFit: ImageProps['objectFit'];\n accessor loading: ImageProps['loading'];\n accessor accessibilityRole: ImageProps['accessibilityRole'];\n accessor inlineSize: ImageProps['inlineSize'];\n /**\n * A border applied around the image using shorthand syntax to specify width, color, and style in a single property.\n */\n accessor border: ImageProps['border'];\n /**\n * The thickness of the border around the image. When set, this overrides the width value specified in the `border` property.\n */\n accessor borderWidth: ImageProps['borderWidth'];\n /**\n * The visual style of the border around the image, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.\n */\n accessor borderStyle: ImageProps['borderStyle'];\n /**\n * The color of the border around the image using the design system's color scale. When set, this overrides the color value specified in the `border` property.\n */\n accessor borderColor: ImageProps['borderColor'];\n /**\n * The roundedness of the image's corners using the design system's radius scale.\n */\n accessor borderRadius: ImageProps['borderRadius'];\n constructor();\n}" + } + }, + "Link": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Link", + "description": "Configure the following properties on the link component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"critical\" | \"auto\" | \"neutral\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "target", + "value": "\"auto\" | AnyString | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class Link extends Link_base implements LinkProps {\n accessor tone: LinkProps['tone'];\n accessor accessibilityLabel: LinkProps['accessibilityLabel'];\n accessor href: LinkProps['href'];\n accessor target: LinkProps['target'];\n accessor download: LinkProps['download'];\n accessor lang: LinkProps['lang'];\n constructor();\n}" + } + }, + "ListItem": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ListItem", + "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ListItem extends PreactCustomElement implements ListItemProps {\n constructor();\n}" + } + }, + "Menu": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Menu", + "description": "Configure the following properties on the menu component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Menu extends PreactOverlayElement implements MenuProps {\n accessor accessibilityLabel: string;\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "MoneyField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MoneyField", + "description": "Configure the following properties on the money field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "-Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current monetary value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string representing the amount in the store's currency.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "string", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class MoneyField\n extends PreactFieldElement\n implements MoneyFieldProps\n{\n accessor max: MoneyFieldProps['max'];\n accessor min: MoneyFieldProps['min'];\n /**\n * The current monetary value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string representing the amount in the store's currency.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "NumberField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "NumberField", + "description": "Configure the following properties on the number field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current numeric value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string (decimal or integer).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inputMode", + "value": "\"decimal\" | \"numeric\"", + "description": "The type of virtual keyboard to display on mobile devices.\n\n- `decimal`: Shows a numeric keyboard with a decimal point, suitable for prices or measurements.\n- `numeric`: Shows a numeric keyboard without a decimal point, suitable for whole numbers like quantities.\n\nLearn more about the [inputmode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).", + "defaultValue": "'decimal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "step", + "value": "number", + "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.", + "defaultValue": "1", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "-Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "prefix", + "value": "string", + "description": "A non-editable text value 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`.\n\nThis text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "suffix", + "value": "string", + "description": "A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n\nThis text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | NumberAutocompleteField | `section-${string} one-time-code` | `section-${string} cc-number` | `section-${string} cc-csc` | \"shipping one-time-code\" | \"shipping cc-number\" | \"shipping cc-csc\" | \"billing one-time-code\" | ... 7 more ... | `section-${string} billing cc-csc`", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class NumberField\n extends PreactFieldElement\n implements NumberFieldProps\n{\n /**\n * The current numeric value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string (decimal or integer).\n */\n get value(): string;\n set value(value: string);\n accessor inputMode: NumberFieldProps['inputMode'];\n accessor step: NumberFieldProps['step'];\n accessor max: NumberFieldProps['max'];\n accessor min: NumberFieldProps['min'];\n accessor prefix: NumberFieldProps['prefix'];\n accessor suffix: NumberFieldProps['suffix'];\n constructor();\n}" + } + }, + "NumberAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "NumberAutocompleteField", + "value": "'one-time-code' | 'cc-number' | 'cc-csc'", + "description": "Represents autocomplete values that are valid for number input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for numeric inputs.\n\nAvailable values:\n- `one-time-code` - One-time codes for authentication (OTP, 2FA codes)\n- `cc-number` - Credit card number\n- `cc-csc` - Credit card security code (CVV/CVC)", + "isPublicDocs": true + } + }, + "Option": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Option", + "description": "Represents a single option within a select component. Use only as a child of s-select components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "selected", + "value": "boolean", + "description": "Whether the option is currently selected. Use this for controlled components where you manage the selection state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultSelected", + "value": "boolean", + "description": "The initial selected state for uncontrolled components. Use this when you want the option to start selected but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Option extends PreactCustomElement implements OptionProps {\n accessor selected: OptionProps['selected'];\n accessor defaultSelected: OptionProps['defaultSelected'];\n accessor value: OptionProps['value'];\n accessor disabled: OptionProps['disabled'];\n constructor();\n}" + } + }, + "OptionGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OptionGroup", + "description": "Represents a group of options within a select component. Use only as a child of `s-select` components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the options within this group can be selected or not.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The user-facing label for this group of options.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class OptionGroup\n extends PreactCustomElement\n implements OptionGroupProps\n{\n accessor disabled: OptionGroupProps['disabled'];\n accessor label: OptionGroupProps['label'];\n constructor();\n}" + } + }, + "OrderedList": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OrderedList", + "description": "Configure the following properties on the ordered list component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class OrderedList\n extends PreactCustomElement\n implements OrderedListProps\n{\n constructor();\n}" + } + }, + "Paragraph": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Paragraph", + "description": "Configure the following properties on the paragraph component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "fontVariantNumeric", + "value": "\"auto\" | \"normal\" | \"tabular-nums\"", + "description": "The rendering style for numbers in the font.\n\n- `auto`: Inherits the setting from the parent element.\n- `normal`: Uses the font's default numeric glyphs.\n- `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n\nLearn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "lineClamp", + "value": "number", + "description": "The maximum number of lines to display before truncating the text content.\n\nLearn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).", + "defaultValue": "Infinity - no truncation is applied", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"caution\"", + "description": "The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.\n\n- `info`: Informational content or helpful tips (blue).\n- `success`: Positive outcomes or successful states (green).\n- `warning`: Important warnings about potential issues (orange).\n- `critical`: Urgent problems or destructive actions (red).\n- `caution`: Advisory notices that need attention (yellow).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"subdued\"", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "dir", + "value": "\"\" | \"auto\" | \"ltr\" | \"rtl\"", + "description": "Indicates the directionality of the element’s text.\n\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n- `auto`: The user agent determines the direction based on the content.\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Paragraph extends PreactCustomElement implements ParagraphProps {\n accessor fontVariantNumeric: ParagraphProps['fontVariantNumeric'];\n accessor lineClamp: ParagraphProps['lineClamp'];\n /**\n * The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.\n *\n * - `info`: Informational content or helpful tips (blue).\n * - `success`: Positive outcomes or successful states (green).\n * - `warning`: Important warnings about potential issues (orange).\n * - `critical`: Urgent problems or destructive actions (red).\n * - `caution`: Advisory notices that need attention (yellow).\n */\n accessor tone: ParagraphProps['tone'];\n\n accessor color: ParagraphProps['color'];\n accessor dir: ParagraphProps['dir'];\n accessor accessibilityVisibility: ParagraphProps['accessibilityVisibility'];\n constructor();\n}" + } + }, + "PasswordField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PasswordField", + "description": "Configure the following properties on the password field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current password value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value is masked in the UI for security.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | PasswordAutocompleteField | `section-${string} current-password` | `section-${string} new-password` | \"shipping current-password\" | \"shipping new-password\" | \"billing current-password\" | \"billing new-password\" | `section-${string} shipping current-password` | `section-${string} shipping new-password` | `section-${string} billing current-password` | `section-${string} billing new-password`", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class PasswordField\n extends PreactFieldElement\n implements PasswordFieldProps\n{\n accessor maxLength: PasswordFieldProps['maxLength'];\n accessor minLength: PasswordFieldProps['minLength'];\n /**\n * The current password value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value is masked in the UI for security.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "PasswordAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PasswordAutocompleteField", + "value": "'current-password' | 'new-password'", + "description": "Represents autocomplete values that are valid for password input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for password inputs.\n\nAvailable values:\n- `current-password` - Existing password for login or authentication\n- `new-password` - New password when creating an account or changing password", + "isPublicDocs": true + } + }, + "QueryContainer": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "QueryContainer", + "description": "Configure the following properties on the query container component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "containerName", + "value": "string", + "description": "An identifier for this container that you can reference in CSS container queries to apply styles based on this specific container's size.\n\nAll query container components automatically receive a container name of `s-default`. You can omit the container name in your queries, so `@container (inline-size <= 300px)` is equivalent to `@container s-default (inline-size <= 300px)`.\n\nWhen you provide a custom `containerName`, it's added alongside `s-default`. For example, `containerName=\"product-card\"` results in `s-default product-card` being set on the `container-name` CSS property, allowing you to target this container with `@container product-card (inline-size <= 300px)`.\n\nLearn more about the [container-name property](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name).", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class QueryContainer\n extends PreactCustomElement\n implements QueryContainerProps\n{\n accessor containerName: QueryContainerProps['containerName'];\n /** @private */\n static globalStylesApplied: boolean;\n constructor();\n}" + } + }, + "SearchField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SearchField", + "description": "Configure the following properties on the search field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current search query value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | TextAutocompleteField | `section-${string} one-time-code` | \"shipping one-time-code\" | \"billing one-time-code\" | `section-${string} shipping one-time-code` | `section-${string} billing one-time-code` | `section-${string} language` | `section-${string} organization` | `section-${string} name` | ... 141...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class SearchField\n extends PreactFieldElement\n implements SearchFieldProps\n{\n accessor maxLength: SearchFieldProps['maxLength'];\n accessor minLength: SearchFieldProps['minLength'];\n /**\n * The current search query value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "TextAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextAutocompleteField", + "value": "'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'", + "description": "Represents autocomplete values that are valid for text input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for text-based inputs.\n\nAvailable values:\n- `name` - Full name\n- `given-name` - First name\n- `additional-name` - Middle name\n- `family-name` - Last name\n- `nickname` - Nickname or handle\n- `username` - Username for login\n- `honorific-prefix` - Name prefix (Mr., Mrs., Dr.)\n- `honorific-suffix` - Name suffix (Jr., Sr., III)\n- `organization` - Company or organization name\n- `organization-title` - Job title or position\n- `address-line1` - Street address (first line)\n- `address-line2` - Street address (second line)\n- `address-line3` - Street address (third line)\n- `address-level1` - State or province\n- `address-level2` - City or town\n- `address-level3` - District or locality\n- `address-level4` - Neighborhood or suburb\n- `street-address` - Complete street address (multi-line)\n- `postal-code` - Postal or ZIP code\n- `country` - Country code (US, CA, GB)\n- `country-name` - Country name (United States, Canada)\n- `language` - Preferred language\n- `sex` - Gender or sex\n- `one-time-code` - One-time codes for authentication\n- `transaction-currency` - Currency code (USD, EUR, GBP)\n- `cc-name` - Name on credit card\n- `cc-given-name` - First name on credit card\n- `cc-additional-name` - Middle name on credit card\n- `cc-family-name` - Last name on credit card\n- `cc-type` - Credit card type (Visa, Mastercard)", + "isPublicDocs": true + } + }, + "Section": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Section", + "description": "Configure the following properties on the section component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "\"base\" | \"none\"", + "description": "The padding applied to all edges of the element.\n\n- `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context.\n- `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.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Section extends PreactCustomElement implements SectionProps {\n constructor();\n /** @private */\n connectedCallback(): void;\n accessor accessibilityLabel: SectionProps['accessibilityLabel'];\n accessor heading: SectionProps['heading'];\n accessor padding: SectionProps['padding'];\n}" + } + }, + "Select": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Select", + "description": "Configure the following properties on the select component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "An icon displayed inside the field to provide visual context about the expected input or field purpose. Commonly used for search fields, currency inputs, or to indicate field type. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "A lifecycle callback that fires when the component is removed from the DOM. Performs cleanup operations.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The value of the currently selected option. When setting this property programmatically, it updates which option appears selected in the dropdown. When reading it, you get the `value` attribute of the currently selected option component.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@usedFirstOptionSymbol@3004", + "value": "boolean", + "description": "A flag used to determine if no value or defaultValue was set, in which case the first non-disabled option was used.\n\nThis is important because we need to use the placeholder in these situations, even though the first value will be submitted as part of the form.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@hasInitialValueSymbol@3005", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Select extends PreactInputElement implements SelectProps {\n accessor icon: SelectProps['icon'];\n accessor details: SelectProps['details'];\n accessor error: SelectProps['error'];\n accessor label: SelectProps['label'];\n accessor placeholder: SelectProps['placeholder'];\n accessor required: SelectProps['required'];\n accessor labelAccessibilityVisibility: SelectProps['labelAccessibilityVisibility'];\n /** @private */\n connectedCallback(): void;\n /**\n * A lifecycle callback that fires when the component is removed from the DOM. Performs cleanup operations.\n * @private\n */\n disconnectedCallback(): void;\n constructor();\n /**\n * A flag used to determine if no value or defaultValue was set, in which case the first non-disabled option was used.\n *\n * This is important because we need to use the placeholder in these situations, even though the first value will be submitted as part of the form.\n * @private\n */\n [usedFirstOptionSymbol]: boolean;\n /**\n * @private\n */\n [hasInitialValueSymbol]: boolean;\n /**\n * The value of the currently selected option. When setting this property programmatically, it updates which option appears selected in the dropdown. When reading it, you get the `value` attribute of the currently selected option component.\n */\n get value(): string;\n set value(value: string);\n /** @private */\n formResetCallback(): void;\n}" + } + }, + "Spinner": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Spinner", + "description": "Configure the following properties on the spinner component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"base\" | \"large\" | \"large-100\"", + "description": "The size of the loading spinner.\n\n- `base`: Default size suitable for inline loading indicators or standard UI contexts.\n- `large`: Larger spinner for more prominent loading states.\n- `large-100`: Extra large spinner for full-page or emphasized loading states.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Spinner extends PreactCustomElement implements SpinnerProps {\n accessor accessibilityLabel: string;\n accessor size: SpinnerProps['size'];\n constructor();\n}" + } + }, + "Stack": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Stack", + "description": "Configure the following properties on the stack component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "direction", + "value": "MaybeResponsive<\"inline\" | \"block\">", + "description": "The direction in which the stack's children are placed within the stack.\n\nAccepts:\n- A single value, either `inline` or `block`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported direction values as a query value", + "defaultValue": "'block'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "justifyContent", + "value": "JustifyContentKeyword", + "description": "Controls the distribution of children along the inline axis (horizontally in horizontal writing modes).\n\nUse this to position items along the primary axis of the stack - horizontally for inline stacks or vertically for block stacks when wrapped into multiple lines.", + "defaultValue": "'normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignItems", + "value": "AlignItemsKeyword", + "description": "Controls the alignment of children along the block axis (vertically in horizontal writing modes).\n\nUse this to align items perpendicular to the stack direction - vertically for inline stacks or horizontally for block stacks.", + "defaultValue": "'normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignContent", + "value": "AlignContentKeyword", + "description": "Controls the distribution of lines along the block axis when content wraps into multiple lines.\n\nThis property only affects stacks with wrapping content. For single-line stacks, use `alignItems` instead.", + "defaultValue": "'normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gap", + "value": "MaybeResponsive>", + "description": "Adjusts spacing between elements.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value applied to both axes, such as `large-100`\n- A pair of values, such as `large-100 large-500`, to set the inline and block axes respectively\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "rowGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "Adjusts spacing between elements in the block axis. This overrides the row value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "columnGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "Adjusts spacing between elements in the inline axis. This overrides the column value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Stack extends BoxElement implements StackProps {\n constructor();\n accessor direction: StackProps['direction'];\n accessor justifyContent: StackProps['justifyContent'];\n accessor alignItems: StackProps['alignItems'];\n accessor alignContent: StackProps['alignContent'];\n accessor gap: StackProps['gap'];\n accessor rowGap: StackProps['rowGap'];\n accessor columnGap: StackProps['columnGap'];\n}" + } + }, + "Switch": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Switch", + "description": "Configure the following properties on the switch component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked. Use this for controlled components where you manage the checked state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The value used in form data when the checkbox is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultChecked", + "value": "boolean", + "description": "The initial checked state for uncontrolled components. Use this when you want the control to start checked but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "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.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Switch extends PreactCheckboxElement implements SwitchProps {\n accessor labelAccessibilityVisibility: SwitchProps['labelAccessibilityVisibility'];\n constructor();\n}" + } + }, + "Table": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Table", + "description": "Configure the following properties on the table component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "variant", + "value": "\"auto\" | \"list\"", + "description": "The layout variant of the table component.\n\n- `list`: Always displays as a list layout.\n- `table`: Always displays as a traditional table layout.\n- `auto`: Automatically displays as a table on wide screens and as a list on narrow screens.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table. When `true`, the table might be in an inert state that prevents user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paginate", + "value": "boolean", + "description": "Whether to use pagination controls.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hasPreviousPage", + "value": "boolean", + "description": "Whether there's a previous page of data.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hasNextPage", + "value": "boolean", + "description": "Whether there's an additional page of data.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@actualTableVariantSymbol@3080", + "value": "AddedContext", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@tableHeadersSharedDataSymbol@3081", + "value": "AddedContext<{ listSlot: ListSlotType; textContent: string; format: HeaderFormat; }[]>", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Table extends PreactCustomElement implements TableProps {\n accessor variant: TableProps['variant'];\n accessor loading: TableProps['loading'];\n accessor paginate: TableProps['paginate'];\n accessor hasPreviousPage: TableProps['hasPreviousPage'];\n accessor hasNextPage: TableProps['hasNextPage'];\n /**\n * @private\n * The actual table variant, which is either 'table' or 'list'.\n */\n [actualTableVariantSymbol]: AddedContext;\n /** @private */\n [tableHeadersSharedDataSymbol]: AddedContext<\n {\n listSlot: TableHeaderProps['listSlot'];\n textContent: string;\n format: HeaderFormat;\n }[]\n >;\n\n constructor();\n}" + } + }, + "AddedContext": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AddedContext", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "T", + "description": "The current context value.\n\nThe new context value to set, which will notify all consumers." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "(type: string, callback: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions) => void", + "description": "The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "(type: string, callback: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions) => void", + "description": "The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + } + ], + "value": "declare class AddedContext extends EventTarget {\n constructor(defaultValue: T);\n /**\n * The current context value.\n */\n get value(): T;\n /**\n * The new context value to set, which will notify all consumers.\n */\n set value(value: T);\n}" + } + }, + "ActualTableVariant": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActualTableVariant", + "value": "'table' | 'list'", + "description": "Represents the actual rendered variant of a table component.\n- `table`: Displays as a traditional table layout.\n- `list`: Displays as a list layout.", + "isPublicDocs": true + } + }, + "ListSlotType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ListSlotType", + "value": "'primary' | 'secondary' | 'kicker' | 'inline' | 'labeled'", + "description": "Represents the semantic type of content slots within list items.\n\n- `primary`: The main content or title of the list item.\n- `secondary`: Supporting or descriptive content below the primary content.\n- `kicker`: A small label or tag displayed above the primary content.\n- `inline`: Content displayed inline with the primary content.\n- `labeled`: Content with an associated label.", + "isPublicDocs": true + } + }, + "HeaderFormat": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "HeaderFormat", + "value": "'base' | 'numeric' | 'currency'", + "description": "Represents the format options for table headers that control styling and alignment of column content.\n\nAvailable values:\n- `base`: Standard format for text columns\n- `currency`: Right-aligned format for monetary values\n- `numeric`: Right-aligned format for numeric values", + "isPublicDocs": true + } + }, + "TableBody": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableBody", + "description": "The table body component represents the main content area of a table, containing the data rows. Use table body as a child of table to structure your table data, with each table row within the body representing a single record or entry.\n\nTable body must contain table row components, which in turn contain table cell components for the actual data values.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableBody extends PreactCustomElement implements TableBodyProps {\n constructor();\n}" + } + }, + "TableCell": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableCell", + "description": "The table cell component represents a single data cell within a table row. Use table cell as a child of table row to display individual data values, with each cell corresponding to a column in the table.\n\nTable cell automatically inherits styling and alignment from its parent table structure and supports text content or other inline components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "__@headerFormatSymbol@3103", + "value": "HeaderFormat", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableCell extends PreactCustomElement implements TableCellProps {\n constructor();\n /** @private */\n get [headerFormatSymbol](): HeaderFormat;\n /** @private */\n set [headerFormatSymbol](format: HeaderFormat);\n}" + } + }, + "TableHeader": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeader", + "description": "The table header component represents a single column header within a table header row. Use table header as a child of table header row to define column headings and optionally enable column sorting.\n\nTable header provides semantic meaning for screen readers and can include sorting controls when configured. Each header corresponds to a column in the table body.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "listSlot", + "value": "ListSlotType", + "description": "The content designation for this column when the table displays in list variant on mobile devices.", + "defaultValue": "'labeled'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "format", + "value": "HeaderFormat", + "description": "The format of the column that controls styling and alignment of cell content.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableHeader\n extends PreactCustomElement\n implements TableHeaderProps\n{\n accessor listSlot: TableHeaderProps['listSlot'];\n accessor format: TableHeaderProps['format'];\n constructor();\n}" + } + }, + "TableHeaderRow": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeaderRow", + "description": "The table header row component represents the header row of a table, containing column headings. Use table header row as the first child of table (before table body) to define the table structure and provide column labels.\n\nTable header row must contain table header components for each column. These headers provide context for the data columns and can support sorting functionality.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableHeaderRow\n extends PreactCustomElement\n implements TableHeaderRowProps\n{\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "TableRow": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableRow", + "description": "The table row component represents a single row of data within a table body. Use table row as a child of table body to structure individual records or entries in the table.\n\nTable row must contain table cell components, with each cell representing a data value for the corresponding column. The number of cells should match the number of headers in the table.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "clickDelegate", + "value": "string", + "description": "The ID of an interactive element, such as `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.\n\nThis 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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableRow extends PreactCustomElement implements TableRowProps {\n constructor();\n accessor clickDelegate: string;\n}" + } + }, + "Text": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Text", + "description": "Configure the following properties on the text component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "fontVariantNumeric", + "value": "\"auto\" | \"normal\" | \"tabular-nums\"", + "description": "The rendering style for numbers in the font.\n\n- `auto`: Inherits the setting from the parent element.\n- `normal`: Uses the font's default numeric glyphs.\n- `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n\nLearn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"subdued\"", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\" | \"neutral\" | \"caution\"", + "description": "The semantic tone that's applied to the text, which changes its color to convey meaning.\n\n- `info`: Informational content or helpful tips (blue).\n- `success`: Positive outcomes or successful states (green).\n- `warning`: Important warnings about potential issues (orange).\n- `critical`: Urgent problems or destructive actions (red).\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent (gray).\n- `caution`: Advisory notices that need attention (yellow).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"strong\" | \"generic\" | \"address\" | \"redundant\"", + "description": "The semantic type and styling treatment for the text content.\n\n- `strong`: Emphasizes the text with strong importance, typically displayed in bold.\n- `generic`: Standard text with no special semantic meaning or styling.\n- `address`: Marks the text as contact information, such as a physical or email address.\n- `redundant`: Indicates the text is redundant or duplicated information for screen reader context.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "dir", + "value": "\"\" | \"auto\" | \"ltr\" | \"rtl\"", + "description": "Indicates the directionality of the element’s text.\n\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n- `auto`: The user agent determines the direction based on the content.\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Text extends PreactCustomElement implements TextProps {\n accessor fontVariantNumeric: TextProps['fontVariantNumeric'];\n accessor color: TextProps['color'];\n /**\n * The semantic tone that's applied to the text, which changes its color to convey meaning.\n *\n * - `info`: Informational content or helpful tips (blue).\n * - `success`: Positive outcomes or successful states (green).\n * - `warning`: Important warnings about potential issues (orange).\n * - `critical`: Urgent problems or destructive actions (red).\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent (gray).\n * - `caution`: Advisory notices that need attention (yellow).\n */\n accessor tone: TextProps['tone'];\n /**\n * The semantic type and styling treatment for the text content.\n *\n * - `strong`: Emphasizes the text with strong importance, typically displayed in bold.\n * - `generic`: Standard text with no special semantic meaning or styling.\n * - `address`: Marks the text as contact information, such as a physical or email address.\n * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context.\n */\n accessor type: TextProps['type'];\n accessor dir: TextProps['dir'];\n accessor accessibilityVisibility: TextProps['accessibilityVisibility'];\n accessor interestFor: string;\n constructor();\n}" + } + }, + "TextArea": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextArea", + "description": "Configure the following properties on the text area component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "rows", + "value": "number", + "description": "A number of visible text lines.", + "defaultValue": "2", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | TextAutocompleteField | `section-${string} one-time-code` | \"shipping one-time-code\" | \"billing one-time-code\" | `section-${string} shipping one-time-code` | `section-${string} billing one-time-code` | `section-${string} language` | `section-${string} organization` | `section-${string} name` | ... 141...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TextArea\n extends PreactFieldElement\n implements TextAreaProps\n{\n accessor maxLength: TextAreaProps['maxLength'];\n accessor minLength: TextAreaProps['minLength'];\n accessor rows: TextAreaProps['rows'];\n /**\n * The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "TextField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextField", + "description": "Configure the following properties on the text field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 542 more ... | AnyString", + "description": "An icon displayed inside the field to provide visual context about the expected input or field purpose. Commonly used for search fields, currency inputs, or to indicate field type. Accepts any icon name from the icon library or a custom string identifier.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "prefix", + "value": "string", + "description": "A non-editable text value 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`.\n\nThis text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "suffix", + "value": "string", + "description": "A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n\nThis text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | TextAutocompleteField | `section-${string} one-time-code` | \"shipping one-time-code\" | \"billing one-time-code\" | `section-${string} shipping one-time-code` | `section-${string} billing one-time-code` | `section-${string} language` | `section-${string} organization` | `section-${string} name` | ... 141...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TextField\n extends PreactFieldElement\n implements TextFieldProps\n{\n accessor icon: TextFieldProps['icon'];\n accessor maxLength: TextFieldProps['maxLength'];\n accessor minLength: TextFieldProps['minLength'];\n accessor prefix: TextFieldProps['prefix'];\n accessor suffix: TextFieldProps['suffix'];\n /**\n * The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "Thumbnail": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Thumbnail", + "description": "Configure the following properties on the thumbnail component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "defaultValue": "``", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"small-200\" | \"small-100\" | \"base\" | \"large\" | \"large-100\"", + "description": "The size of the product thumbnail image.\n\n- `small-200`: Smallest thumbnail size, ideal for compact product lists or tables.\n- `small-100`: Very small thumbnail, suitable for dense layouts.\n- `small`: Small thumbnail for space-constrained contexts.\n- `base`: Default size that balances visibility and space efficiency.\n- `large`: Larger thumbnail for featured products or detailed views.\n- `large-100`: Extra large thumbnail for prominent product display.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Thumbnail extends PreactCustomElement implements ThumbnailProps {\n accessor src: ThumbnailProps['src'];\n accessor alt: ThumbnailProps['alt'];\n accessor size: ThumbnailProps['size'];\n constructor();\n}" + } + }, + "Tooltip": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Tooltip", + "description": "Configure the following properties on the tooltip component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Tooltip extends PreactOverlayElement implements TooltipProps {\n constructor();\n}" + } + }, + "UnorderedList": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "UnorderedList", + "description": "Configure the following properties on the unordered list component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class UnorderedList\n extends PreactCustomElement\n implements UnorderedListProps\n{\n constructor();\n}" + } + }, + "URLField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "URLField", + "description": "Configure the following properties on the URL field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | `section-${string} url` | `section-${string} photo` | `section-${string} impp` | `section-${string} home impp` | `section-${string} mobile impp` | `section-${string} fax impp` | `section-${string} pager impp` | \"shipping url\" | \"shipping photo\" | \"shipping impp\" | \"shipping home impp\" | \"shipping mobi...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current URL value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as a URL format when the user finishes editing.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class URLField\n extends PreactFieldElement\n implements URLFieldProps\n{\n accessor autocomplete: URLFieldProps['autocomplete'];\n accessor maxLength: URLFieldProps['maxLength'];\n accessor minLength: URLFieldProps['minLength'];\n /**\n * The current URL value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as a URL format when the user finishes editing.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "AdminAction": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminAction", + "description": "Configure the following properties on the admin action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The text to use as the Action modal's title. If not provided, the name of the extension will be used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether the action is in a loading state, such as during initial page load or when the action is being opened. When `true`, the action might be in an inert state that prevents user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class AdminAction\n extends PreactCustomElement\n implements AdminActionProps\n{\n /**\n * The text to use as the Action modal's title. If not provided, the name of the extension will be used.\n */\n heading: string;\n /**\n * Whether the action is in a loading state, such as during initial page load or when the action is being opened.\n * When `true`, the action might be in an inert state that prevents user interaction.\n */\n loading: boolean;\n constructor();\n}" + } + }, + "RunnableExtension": { + "src/extension.ts": { + "filePath": "src/extension.ts", + "name": "RunnableExtension", + "description": "Defines the structure of a runnable extension, which executes logic and returns data without rendering UI.", + "members": [ + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "api", + "value": "Api", + "description": "The API object providing access to extension capabilities and methods. The specific API type depends on the extension target and determines what functionality is available to your extension." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "output", + "value": "Output | Promise", + "description": "The function output. Your extension function should return the expected output type or a Promise that resolves to that type. The output type is determined by your specific extension target and use case." + } + ], + "value": "export interface RunnableExtension {\n /**\n * The API object providing access to extension capabilities and methods. The specific API type depends on the extension target and determines what functionality is available to your extension.\n */\n api: Api;\n /**\n * The function output. Your extension function should return the expected output type or a Promise that resolves to that type. The output type is determined by your specific extension target and use case.\n */\n output: Output | Promise;\n}" + } + }, + "ShouldRenderApi": { + "src/surfaces/admin/api/should-render/should-render.ts": { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "name": "ShouldRenderApi", + "description": "The `ShouldRenderApi` object provides methods for controlling action extension visibility. Access the following properties on the `ShouldRenderApi` object to determine whether an associated action should appear based on the current context.", + "members": [ + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this data to determine whether the action extension should appear based on the current context." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ShouldRenderApi\n extends StandardApi {\n /**\n * An array of currently viewed or selected resource identifiers. Use this data to determine whether the action extension should appear based on the current context.\n */\n data: Data;\n}" + } + }, + "ShouldRenderOutput": { + "src/surfaces/admin/api/should-render/should-render.ts": { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "name": "ShouldRenderOutput", + "description": "The output returned by `should-render` extensions to control visibility.", + "members": [ + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "boolean", + "description": "Whether to display the associated action extension. Return `true` to show the action, `false` to hide it." + } + ], + "value": "export interface ShouldRenderOutput {\n /** Whether to display the associated action extension. Return `true` to show the action, `false` to hide it. */\n display: boolean;\n}" + } + }, + "BlockExtensionApi": { + "src/surfaces/admin/api/block/block.ts": { + "filePath": "src/surfaces/admin/api/block/block.ts", + "name": "BlockExtensionApi", + "description": "The `BlockExtensionApi` object provides methods for block extensions that render inline content on admin pages. Access the following properties on the `BlockExtensionApi` object to interact with the current context, navigate to other extensions, and display picker dialogs.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface BlockExtensionApi\n extends StandardRenderingExtensionApi {\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.\n */\n data: Data;\n\n /**\n * Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`).\n */\n navigation: Navigation;\n}" + } + }, + "Navigation": { + "src/surfaces/admin/api/block/block.ts": { + "filePath": "src/surfaces/admin/api/block/block.ts", + "name": "Navigation", + "description": "The `Navigation` object provides methods for navigating between extensions and admin pages.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "navigate", + "value": "(url: string | URL) => void", + "description": "Navigates to a specific extension or admin route. Currently supports navigating from a block extension to an action extension on the same resource page.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "navigation.navigate('extension://my-admin-action-extension-handle')", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface Navigation {\n /**\n * Navigates to a specific extension or admin route. Currently supports navigating from a block extension to an action extension on the same resource page.\n *\n * @param url - The destination URL, typically in the format 'extension://extension-handle' for other extensions\n * @example navigation.navigate('extension://my-admin-action-extension-handle')\n */\n navigate: (url: string | URL) => void;\n}" + } + }, + "BlockExtensionComponents": { + "src/surfaces/admin/components/BlockExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/BlockExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BlockExtensionComponents", + "value": "StandardComponents | 'AdminBlock' | 'Form'", + "description": "The components available for building block extensions. Includes all standard components plus the admin block component required for block extension setup and the form component for creating forms." + } + }, + "AdminBlock": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminBlock", + "description": "Configure the following properties on the admin block component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The text displayed as the block's title in the header. If not provided, the extension name will be used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "collapsedSummary", + "value": "string", + "description": "The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class AdminBlock\n extends PreactCustomElement\n implements AdminBlockProps\n{\n /**\n * The text displayed as the block's title in the header. If not provided, the extension name will be used.\n */\n heading: string;\n /**\n * The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.\n */\n collapsedSummary: string;\n constructor();\n}" + } + }, + "Form": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Form", + "description": "Configure the following properties on the form component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Form extends PreactCustomElement implements FormProps {\n constructor();\n}" + } + }, + "AppHomeApi": { + "src/surfaces/admin/api/app-home/app-home.ts": { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "name": "AppHomeApi", + "description": "The `AppHomeApi` object provides methods for app home extensions. Access the following properties on the `AppHomeApi` object to authenticate users, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, handle intents, persist data, display toast notifications, control the Admin page-level loading indicator, and access app-level data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "app", + "value": "AppApi", + "description": "Provides access to app-level data and functionality. Use this API to query information about extensions registered for the current app, including their activation status and target information." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "AppHomeIntents", + "description": "Receives [link intents](/docs/apps/build/sidekick/build-app-data) dispatched to the app home target and resolves them when complete. Subscribe to `intents.request` to be notified each time the admin navigates the merchant to your app via a link intent, and call `intents.response.ok()` / `error()` / `closed()` to resolve the active intent.\n\nWhen you run `dev`, the CLI generates typed variants for every intent declared in `shopify.extension.toml`. Use the `WithGeneratedIntents` helper type to narrow `request.value` and `response.ok` to the generated payloads in your app code." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "LoadingApi", + "description": "Sets the Admin page-level loading indicator. Call `loading(true)` to show the loading indicator while your app home extension performs an asynchronous task. Call `loading(false)`, or call `loading()` without an argument, to hide it when the task completes." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "toast", + "value": "ToastApi", + "description": "Displays brief, non-blocking notification messages at the bottom of the page. Use the Toast API to confirm successful actions, report errors, or provide contextual feedback without interrupting the merchant's workflow." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "tools", + "value": "Tools", + "description": "Registers runtime handlers for app tools declared in your extension configuration. Use this to expose app data lookups and app actions to [Sidekick](/docs/apps/build/sidekick/build-app-data), including link intents that drive the navigate modality from the app home target.\n\nWhen you run `dev`, the CLI generates typed `register` overloads for every tool declared in `shopify.extension.toml`. Use the `WithGeneratedTools` helper type to narrow this property to the generated overloads in your app code." + } + ], + "value": "export interface AppHomeApi\n extends StandardApi {\n /**\n * Displays brief, non-blocking notification messages at the bottom of the page. Use the Toast API to confirm successful actions, report errors, or provide contextual feedback without interrupting the merchant's workflow.\n */\n toast: ToastApi;\n\n /**\n * Provides access to app-level data and functionality. Use this API to query information about extensions registered for the current app, including their activation status and target information.\n */\n app: AppApi;\n\n /**\n * Sets the Admin page-level loading indicator. Call `loading(true)` to show the loading indicator while your app home extension performs an asynchronous task. Call `loading(false)`, or call `loading()` without an argument, to hide it when the task completes.\n */\n loading: LoadingApi;\n\n /**\n * Receives [link intents](/docs/apps/build/sidekick/build-app-data) dispatched to the app home target and resolves them when complete. Subscribe to `intents.request` to be notified each time the admin navigates the merchant to your app via a link intent, and call `intents.response.ok()` / `error()` / `closed()` to resolve the active intent.\n *\n * When you run `dev`, the CLI generates typed variants for every intent declared in `shopify.extension.toml`. Use the `WithGeneratedIntents` helper type to narrow `request.value` and `response.ok` to the generated payloads in your app code.\n */\n intents: AppHomeIntents;\n\n /**\n * Registers runtime handlers for app tools declared in your extension configuration. Use this to expose app data lookups and app actions to [Sidekick](/docs/apps/build/sidekick/build-app-data), including link intents that drive the navigate modality from the app home target.\n *\n * When you run `dev`, the CLI generates typed `register` overloads for every tool declared in `shopify.extension.toml`. Use the `WithGeneratedTools` helper type to narrow this property to the generated overloads in your app code.\n */\n tools: Tools;\n}" + } + }, + "AppApi": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "AppApi", + "description": "The `AppApi` object provides methods for interacting with app-level data and functionality. Use this API to query information about extensions registered for the current app.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "extensions", + "value": "() => Promise", + "description": "Returns a list of all extensions registered for the current app, including their activation status and target information. Use this to discover what extensions are available and where they are activated." + } + ], + "value": "export interface AppApi {\n /**\n * Returns a list of all extensions registered for the current app, including their activation status and target information.\n * Use this to discover what extensions are available and where they are activated.\n *\n * @returns A promise that resolves to an array of extension information objects.\n */\n extensions: () => Promise;\n}" + } + }, + "ExtensionInfo": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "ExtensionInfo", + "description": "Information about an extension registered for the current app.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "activations", + "value": "UiExtensionActivation[] | ThemeExtensionBlockActivation[]", + "description": "The list of activations for this extension. For UI extensions, this contains target information. For theme extensions, this contains detailed block activation information." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string | null", + "description": "The unique handle identifier for this extension, if available.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "ExtensionStatus", + "description": "The current status of this extension.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "ExtensionType", + "description": "The type of extension.", + "isOptional": true + } + ], + "value": "export interface ExtensionInfo {\n /**\n * The unique handle identifier for this extension, if available.\n */\n handle?: string | null;\n\n /**\n * The list of activations for this extension. For UI extensions, this contains target information.\n * For theme extensions, this contains detailed block activation information.\n */\n activations: UiExtensionActivation[] | ThemeExtensionBlockActivation[];\n\n /**\n * The current status of this extension.\n */\n status?: ExtensionStatus;\n\n /**\n * The type of extension.\n */\n type?: ExtensionType;\n}" + } + }, + "UiExtensionActivation": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "UiExtensionActivation", + "description": "Represents an activation of a UI extension at a specific target.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "string", + "description": "The extension target where this extension is activated." + } + ], + "value": "export interface UiExtensionActivation {\n /**\n * The extension target where this extension is activated.\n */\n target: string;\n}" + } + }, + "ThemeExtensionBlockActivation": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "ThemeExtensionBlockActivation", + "description": "Represents a theme extension block activation with its status and nested activations.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "activations", + "value": "ThemeBlockActivation[]", + "description": "The list of theme-specific activations for this block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The handle identifier for this theme extension block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The display name of this theme extension block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "ExtensionStatus", + "description": "The current status of this theme extension block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "ThemeAppBlockTarget | ThemeAppEmbedTarget", + "description": "The target location for this theme extension block or embed." + } + ], + "value": "export interface ThemeExtensionBlockActivation {\n /**\n * The target location for this theme extension block or embed.\n */\n target: ThemeAppBlockTarget | ThemeAppEmbedTarget;\n\n /**\n * The handle identifier for this theme extension block.\n */\n handle: string;\n\n /**\n * The display name of this theme extension block.\n */\n name: string;\n\n /**\n * The current status of this theme extension block.\n */\n status: ExtensionStatus;\n\n /**\n * The list of theme-specific activations for this block.\n */\n activations: ThemeBlockActivation[];\n}" + } + }, + "ThemeBlockActivation": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "ThemeBlockActivation", + "description": "Represents an activation of a theme block at a specific target within a theme.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "string", + "description": "The target location within the theme." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "themeId", + "value": "string", + "description": "The ID of the theme where this block is activated." + } + ], + "value": "export interface ThemeBlockActivation {\n /**\n * The target location within the theme.\n */\n target: string;\n\n /**\n * The ID of the theme where this block is activated.\n */\n themeId: string;\n}" + } + }, + "ExtensionStatus": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionStatus", + "value": "'active' | 'available' | 'unavailable'", + "description": "The status of an extension indicating whether it's active, available for activation, or unavailable.", + "isPublicDocs": true + } + }, + "ThemeAppBlockTarget": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ThemeAppBlockTarget", + "value": "'section'", + "description": "The target location for theme app blocks within a theme section.", + "isPublicDocs": true + } + }, + "ThemeAppEmbedTarget": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ThemeAppEmbedTarget", + "value": "'head' | 'body' | 'compliance_head'", + "description": "The target location for theme app embeds within the document.", + "isPublicDocs": true + } + }, + "ExtensionType": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionType", + "value": "'ui_extension' | 'theme_app_extension'", + "description": "The type of extension.", + "isPublicDocs": true + } + }, + "AppHomeIntents": { + "src/surfaces/admin/api/app-home/app-home.ts": { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "name": "AppHomeIntents", + "description": "The intents API available to app home extensions. It exposes a signal-like `request` that streams link intents into the long-running extension. Inspect `request.value` for information about the active intent.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "invoke", + "value": "IntentInvokeApi", + "description": "Launches an intent workflow for creating or editing Shopify resources.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "request", + "value": "AppHomeIntentRequest", + "description": "The current link intent delivered to the extension. Subscribe to receive new intents over the lifetime of the extension." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "response", + "value": "IntentResponseApi", + "description": "Resolves the current intent. Available only while `request.value` is non-null; the runtime swaps in a fresh handle for each new intent.", + "isOptional": true + } + ], + "value": "export interface AppHomeIntents {\n /**\n * The current link intent delivered to the extension. Subscribe to receive\n * new intents over the lifetime of the extension.\n */\n request: AppHomeIntentRequest;\n /**\n * Resolves the current intent. Available only while `request.value` is\n * non-null; the runtime swaps in a fresh handle for each new intent.\n */\n response?: IntentResponseApi;\n /**\n * Launches an intent workflow for creating or editing Shopify resources.\n */\n invoke?: IntentInvokeApi;\n}" + } + }, + "AppHomeIntentRequest": { + "src/surfaces/admin/api/app-home/app-home.ts": { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "name": "AppHomeIntentRequest", + "description": "The current link intent delivered to an app home extension. The admin pushes a new value into `request` whenever a link intent is dispatched to your app, and resets it to `null` when no intent is active.\n\nThe shape is signal-like (`value` + `subscribe`) so the running extension can observe a stream of intents over its lifetime, mirroring the behaviour the CLI's generated typings already expect via `WithGeneratedIntents`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "subscribe", + "value": "(callback: (value: IntentQueryOptions) => void) => () => void", + "description": "Subscribes to changes in the active intent. The callback is invoked with the new value whenever the admin dispatches a new intent or clears it. Returns a function that unsubscribes the callback." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "IntentQueryOptions | null", + "description": "The intent that's currently being delivered to the extension, or `null` when no intent is active." + } + ], + "value": "export interface AppHomeIntentRequest {\n /**\n * The intent that's currently being delivered to the extension, or `null`\n * when no intent is active.\n */\n readonly value: IntentQueryOptions | null;\n /**\n * Subscribes to changes in the active intent. The callback is invoked with\n * the new value whenever the admin dispatches a new intent or clears it.\n * Returns a function that unsubscribes the callback.\n */\n subscribe: (\n callback: (value: IntentQueryOptions | null) => void,\n ) => () => void;\n}" + } + }, + "IntentQueryOptions": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentQueryOptions", + "description": "Additional parameters for intent invocation when using the string query format. Use these options to provide resource IDs for editing or pass required context data for resource creation.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ [key: string]: unknown; }", + "description": "Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.", + "isOptional": true + } + ], + "value": "export interface IntentQueryOptions {\n /**\n * The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.\n */\n value?: string;\n /**\n * Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.\n */\n data?: {[key: string]: unknown};\n}" + } + }, + "LoadingApi": { + "src/surfaces/admin/api/loading/loading.ts": { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "name": "LoadingApi", + "description": "Sets the Admin page-level loading indicator for hosted app home extensions.\n\nCall with `true` to start loading. Call with `false`, or without an argument, to stop loading.", + "isPublicDocs": true, + "params": [ + { + "name": "isLoading", + "description": "", + "value": "boolean", + "isOptional": true, + "filePath": "src/surfaces/admin/api/loading/loading.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(isLoading?: boolean) => void" + } + }, + "ToastApi": { + "src/surfaces/admin/api/toast/toast.ts": { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "name": "ToastApi", + "description": "The `ToastApi` object provides methods for displaying temporary notification messages. Access these methods through `shopify.toast` to show user feedback and status updates.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "() => void", + "description": "Dismisses any currently visible toast notification. Use this to programmatically hide a toast before its duration expires." + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "(message: string, options?: ToastOptions) => void", + "description": "Displays a toast notification with the specified message. The toast appears as a temporary overlay that automatically dismisses after the specified duration. Use for providing immediate user feedback, confirming actions, or communicating status updates without interrupting the user's workflow." + } + ], + "value": "export interface ToastApi {\n /**\n * Displays a toast notification with the specified message. The toast appears as a temporary overlay that automatically dismisses after the specified duration. Use for providing immediate user feedback, confirming actions, or communicating status updates without interrupting the user's workflow.\n *\n * @param message - The text content to display in the toast notification.\n * @param options - Optional configuration for the toast behavior and appearance.\n */\n show: (message: string, options?: ToastOptions) => void;\n\n /**\n * Dismisses any currently visible toast notification. Use this to programmatically hide a toast before its duration expires.\n */\n hide: () => void;\n}" + } + }, + "ToastOptions": { + "src/surfaces/admin/api/toast/toast.ts": { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "name": "ToastOptions", + "description": "Options for configuring toast notification behavior and appearance.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "string", + "description": "The label for an optional action button displayed in the toast. When provided, an action button appears that the user can click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "duration", + "value": "number", + "description": "The duration in milliseconds to display the toast before automatically dismissing. If not specified, a default duration is used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "isError", + "value": "boolean", + "description": "Whether to display the toast as an error notification. Use for error messages or failed operations.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "onAction", + "value": "() => void", + "description": "Callback function triggered when the user clicks the action button. Only called if `action` is provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "() => void", + "description": "Callback function triggered when the toast is dismissed, either automatically after the duration expires or manually by the user.", + "isOptional": true + } + ], + "value": "export interface ToastOptions {\n /**\n * The duration in milliseconds to display the toast before automatically dismissing. If not specified, a default duration is used.\n */\n duration?: number;\n\n /**\n * Whether to display the toast as an error notification. Use for error messages or failed operations.\n * @defaultValue false\n */\n isError?: boolean;\n\n /**\n * The label for an optional action button displayed in the toast. When provided, an action button appears that the user can click.\n */\n action?: string;\n\n /**\n * Callback function triggered when the user clicks the action button. Only called if `action` is provided.\n */\n onAction?: () => void;\n\n /**\n * Callback function triggered when the toast is dismissed, either automatically after the duration expires or manually by the user.\n */\n onDismiss?: () => void;\n}" + } + }, + "Tools": { + "src/surfaces/admin/api/tools/tools.ts": { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "name": "Tools", + "description": "The `Tools` object provides methods for registering and removing runtime handlers for app tools declared in your extension configuration. Use this API to expose app data lookups and app actions that [Sidekick](/docs/apps/build/sidekick/build-app-data) can invoke on behalf of merchants.\n\nThe base `register` signature accepts any tool name and a generic handler. When you run `dev`, the CLI generates a typed `register` overload for every tool declared in `shopify.extension.toml`, narrowing both the accepted name and the handler's `input`/return types. Use the `WithGeneratedTools` helper to merge the generated typings into your target's API.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "syntaxKind": "PropertySignature", + "name": "clear", + "value": "() => void", + "description": "Unregisters every tool handler currently registered by your extension." + }, + { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "syntaxKind": "PropertySignature", + "name": "register", + "value": "(name: string, handler: ToolHandler) => () => void", + "description": "Registers a tool handler for your app. If a handler with the same name is already registered, it is replaced. Returns a cleanup function that unregisters the handler." + }, + { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "syntaxKind": "PropertySignature", + "name": "unregister", + "value": "(name: string) => void", + "description": "Unregisters a previously registered tool handler. Calling this for a tool that isn't registered is a no-op." + } + ], + "value": "export interface Tools {\n /**\n * Registers a tool handler for your app. If a handler with the same name is\n * already registered, it is replaced. Returns a cleanup function that\n * unregisters the handler.\n *\n * @param name - The tool name as declared in your extension configuration.\n * @param handler - The function invoked when the tool is called.\n * @returns A function that unregisters the handler when invoked.\n */\n register: (name: string, handler: ToolHandler) => () => void;\n\n /**\n * Unregisters a previously registered tool handler. Calling this for a tool\n * that isn't registered is a no-op.\n *\n * @param name - The tool name to unregister.\n */\n unregister: (name: string) => void;\n\n /**\n * Unregisters every tool handler currently registered by your extension.\n */\n clear: () => void;\n}" + } + }, + "ToolHandler": { + "src/surfaces/admin/api/tools/tools.ts": { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "name": "ToolHandler", + "description": "A handler function invoked by the platform when a registered tool is called. The handler receives an `input` object that matches the tool's declared input JSON schema and must return (synchronously or asynchronously) an object that matches the declared output JSON schema.\n\nGenerated tool typings narrow the `input` and return value of this handler for each registered tool name. This base signature is the generic fallback used before code generation has run, or for tools that aren't yet declared in your extension configuration.", + "isPublicDocs": true, + "params": [ + { + "name": "input", + "description": "", + "value": "Record", + "filePath": "src/surfaces/admin/api/tools/tools.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "description": "", + "name": "Record | Promise>", + "value": "Record | Promise>" + }, + "value": "(\n input: Record,\n) => Record | Promise>" + } + }, + "FormExtensionComponents": { + "src/surfaces/admin/components/FormExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/FormExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "FormExtensionComponents", + "value": "StandardComponents | 'Form'", + "description": "The components available for building form-based extensions. Includes all standard components plus the form component for creating structured data collection interfaces with submission handling and validation." + } + }, + "Modal": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Modal", + "description": "Configure the following properties on the modal component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "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.\n\nThis overrides the `heading` prop for screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "\"base\" | \"none\"", + "description": "Adjust the padding around the modal content.\n\n`base`: applies padding that is appropriate for the element.\n\n`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.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\"", + "description": "The size of the modal component, controlling its width and height. Larger sizes provide more space for content while smaller sizes are more compact.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "showOverlay", + "value": "() => void", + "description": "A method to programmatically show the overlay.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "toggleOverlay", + "value": "() => void", + "description": "A method to programmatically toggle the visibility of the overlay.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@abortController@2785", + "value": "AbortController", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@dialog@2779", + "value": "HTMLDialogElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@focusedElement@2781", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@nestedModals@2783", + "value": "Map", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@childrenRerenderObserver@2787", + "value": "MutationObserver", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@shadowDomRerenderObserver@2788", + "value": "MutationObserver", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@onEscape@2782", + "value": "(event: KeyboardEvent) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@onBackdropClick@2784", + "value": "(event: MouseEvent) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@onChildModalChange@2786", + "value": "EventListenerOrEventListenerObject", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "__@isOpen@2778", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@dismiss@2780", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "__@hasOpenChildModal@2775", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@show@2776", + "value": "() => Promise", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@hide@2777", + "value": "() => Promise", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Modal extends PreactOverlayElement implements ModalProps {\n accessor accessibilityLabel: ModalProps['accessibilityLabel'];\n accessor heading: ModalProps['heading'];\n accessor padding: ModalProps['padding'];\n accessor size: ModalProps['size'];\n /** @private */\n [abortController]: AbortController;\n /** @private */\n [dialog]: HTMLDialogElement | null;\n /** @private */\n [focusedElement]: HTMLElement | null;\n /** @private */\n [nestedModals]: Map;\n /** @private */\n [childrenRerenderObserver]: MutationObserver;\n /** @private */\n [shadowDomRerenderObserver]: MutationObserver;\n /** @private */\n [onEscape]: (event: KeyboardEvent) => void;\n /** @private */\n [onBackdropClick]: (event: MouseEvent) => void;\n /** @private */\n [onChildModalChange]: EventListenerOrEventListenerObject;\n /** @private */\n get [isOpen](): boolean;\n /** @private */\n [dismiss](): void;\n /** @private */\n get [hasOpenChildModal](): boolean;\n /** @private */\n [show](): Promise;\n /** @private */\n [hide](): Promise;\n showOverlay(): void;\n hideOverlay(): void;\n toggleOverlay(): void;\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n constructor();\n}" + } + }, + "Page": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Page", + "description": "Use as the outer wrapper of a page.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "\"small\" | \"base\" | \"large\"", + "description": "The inline size of the page\n- `base` corresponds to a set default inline size\n- `large` full width with whitespace", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The main page heading", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Page extends PreactCustomElement implements PageProps {\n accessor inlineSize: PageProps['inlineSize'];\n accessor heading: PageProps['heading'];\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "IntentRenderApi": { + "src/surfaces/admin/api/intents/intent-render.ts": { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "name": "IntentRenderApi", + "description": "The `IntentRenderApi` object provides methods for extensions that render in response to an app intent. Access the intent data to determine what action the merchant requested and use `intents.response` to resolve the intent when complete.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "IntentRenderIntents", + "description": "Provides methods for resolving the current intent. Always available for intent render extensions since they are always invoked inside an intent workflow." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface IntentRenderApi\n extends StandardRenderingExtensionApi {\n /**\n * Provides methods for resolving the current intent. Always available for intent render extensions since they are always invoked inside an intent workflow.\n */\n intents: IntentRenderIntents;\n}" + } + }, + "IntentRenderIntents": { + "src/surfaces/admin/api/intents/intent-render.ts": { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "name": "IntentRenderIntents", + "description": "The intents API available to intent render extensions. Unlike other targets where `response` is optional, intent render extensions always run inside an intent workflow so `response` is guaranteed.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "response", + "value": "IntentResponseApi", + "description": "Resolves the current intent from within the invoked extension. Use `ok()` to signal success, `error()` to report failure, or `closed()` to indicate the merchant cancelled." + } + ], + "value": "export interface IntentRenderIntents {\n /**\n * Resolves the current intent from within the invoked extension. Use `ok()` to signal success, `error()` to report failure, or `closed()` to indicate the merchant cancelled.\n */\n response: IntentResponseApi;\n}" + } + }, + "StandardApi": { + "src/surfaces/admin/api/standard/standard.ts": { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "name": "StandardApi", + "description": "The `StandardApi` object provides core methods available to all extension targets. Access the following properties on the `StandardApi` object to authenticate users, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, handle intents, and persist data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface StandardApi {\n /**\n * The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context.\n */\n extension: {\n target: ExtensionTarget;\n };\n\n /**\n * Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations.\n */\n auth: Auth;\n\n /**\n * Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience.\n */\n i18n: I18n;\n\n /**\n * Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation.\n */\n intents: Intents;\n\n /**\n * Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension.\n */\n storage: Storage;\n\n /**\n * Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query.\n */\n query: (\n query: string,\n options?: {variables?: Variables; version?: Omit},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n}" + } + }, + "CustomerSegmentTemplateApi": { + "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts": { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "name": "CustomerSegmentTemplateApi", + "description": "The `CustomerSegmentTemplateApi` object provides methods for creating customer segment templates. Access the following properties on the `CustomerSegmentTemplateApi` object to build templates with translated content.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "__enabledFeatures", + "value": "string[]", + "description": "", + "isPrivate": true + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating template content into the merchant's language." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface CustomerSegmentTemplateApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardApi {\n /** Utilities for translating template content into the merchant's language. */\n i18n: I18n;\n /** @private */\n __enabledFeatures: string[];\n}" + } + }, + "CustomerSegmentTemplate": { + "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts": { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "name": "CustomerSegmentTemplate", + "description": "Defines a customer segment template that merchants can use to create targeted customer groups.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "createdOn", + "value": "string", + "description": "The creation date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Templates created within the last month display a \"New\" badge." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "dependencies", + "value": "{ standardMetafields?: \"facts.birth_date\"[]; customMetafields?: string[]; }", + "description": "Customer metafields required by this template's query. Declare dependencies so the admin can guide merchants to set up required metafields before using the template.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string | string[]", + "description": "The template description in the merchant's language. Use an array for multiple paragraphs." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "string", + "description": "The segment query code to display in the template with syntax highlighting. This code is shown to merchants but not validated. Test your queries in the Shopify admin segment editor before including them in templates." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "queryToInsert", + "value": "string", + "description": "The segment query code to insert when the merchant selects this template. If omitted, the `query` value is used instead. This code is inserted into the editor but not validated. Test your queries in the Shopify admin segment editor before including them in templates." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The template title in the merchant's language." + } + ], + "value": "export interface CustomerSegmentTemplate {\n /**\n * The template title in the merchant's language.\n */\n title: string;\n /**\n * The template description in the merchant's language. Use an array for multiple paragraphs.\n */\n description: string | string[];\n /**\n * The segment query code to display in the template with syntax highlighting. This code is shown to merchants but not validated. Test your queries in the Shopify admin segment editor before including them in templates.\n */\n query: string;\n /**\n * The segment query code to insert when the merchant selects this template. If omitted, the `query` value is used instead. This code is inserted into the editor but not validated. Test your queries in the Shopify admin segment editor before including them in templates.\n */\n queryToInsert: string;\n /**\n * Customer metafields required by this template's query. Declare dependencies so the admin can guide merchants to set up required metafields before using the template.\n */\n dependencies?: {\n /** Standard Shopify customer metafields used in the query. */\n standardMetafields?: CustomerStandardMetafieldDependency[];\n /** Custom [metafield](/docs/apps/build/metafields) definitions used in the query. */\n customMetafields?: string[];\n };\n /**\n * The creation date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Templates created within the last month display a \"New\" badge.\n */\n createdOn: string;\n}" + } + }, + "DiscountFunctionSettingsApi": { + "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "name": "DiscountFunctionSettingsApi", + "description": "The `DiscountFunctionSettingsApi` object provides methods for configuring discount functions. Access the following properties on the `DiscountFunctionSettingsApi` object to manage function settings and metafields.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "applyMetafieldChange", + "value": "ApplyMetafieldChange", + "description": "Updates or removes [metafields](/docs/apps/build/metafields) that store discount function configuration. Use this to save merchant settings for your discount function." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "DiscountFunctionSettingsData", + "description": "The discount being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "discounts", + "value": "DiscountsApi", + "description": "The `discounts` object provides reactive access to discount configuration, including discount classes and the discount method. Use the signals to read current values and the update functions to modify discount classes in your settings UI. These values automatically update when changed by the merchant or system." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface DiscountFunctionSettingsApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends Omit, 'data'> {\n /**\n * Updates or removes [metafields](/docs/apps/build/metafields) that store discount function configuration. Use this to save merchant settings for your discount function.\n */\n applyMetafieldChange: ApplyMetafieldChange;\n /** The discount being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings. */\n data: DiscountFunctionSettingsData;\n /** The `discounts` object provides reactive access to discount configuration, including discount classes and the discount method. Use the signals to read current values and the update functions to modify discount classes in your settings UI. These values automatically update when changed by the merchant or system. */\n discounts: DiscountsApi;\n}" + } + }, + "ApplyMetafieldChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "ApplyMetafieldChange", + "description": "A function that applies metafield changes to discount function settings. Call this function with an update or removal operation, then await the Promise to receive a result indicating success or failure. Use the result to provide feedback or handle errors in your settings interface.", + "isPublicDocs": true, + "params": [ + { + "name": "change", + "description": "", + "value": "MetafieldChange", + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "description": "", + "name": "Promise", + "value": "Promise" + }, + "value": "(\n change: MetafieldChange,\n) => Promise" + } + }, + "MetafieldChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldChange", + "value": "MetafieldUpdateChange | MetafieldRemoveChange", + "description": "A metafield change operation that can either update or remove a metafield. Pass this to `applyMetafieldChange` to modify discount settings stored in metafields.", + "isPublicDocs": true + } + }, + "MetafieldUpdateChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldUpdateChange", + "description": "A metafield update or creation operation. Use this to set or modify metafield values that store discount function configuration data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The unique key identifying the metafield within its namespace. Use descriptive keys that indicate the setting's purpose (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`)." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace that organizes related metafields. When omitted, a default namespace is assigned. Use consistent namespaces to group related settings.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updateMetafield'", + "description": "Identifies this as an update operation. Always set to `'updateMetafield'` for updates." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string | number", + "description": "The metafield value to store. Can be a string or number depending on your configuration needs." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "valueType", + "value": "SupportedDefinitionType", + "description": "The [data type](/docs/apps/build/metafields/list-of-data-types) that defines how the value is formatted and validated. When omitted, preserves the existing type for updates or uses a default for new metafields. Choose a type that matches your value format.", + "isOptional": true + } + ], + "value": "export interface MetafieldUpdateChange {\n /** Identifies this as an update operation. Always set to `'updateMetafield'` for updates. */\n type: 'updateMetafield';\n /** The unique key identifying the metafield within its namespace. Use descriptive keys that indicate the setting's purpose (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`). */\n key: string;\n /** The namespace that organizes related metafields. When omitted, a default namespace is assigned. Use consistent namespaces to group related settings. */\n namespace?: string;\n /** The metafield value to store. Can be a string or number depending on your configuration needs. */\n value: string | number;\n /** The [data type](/docs/apps/build/metafields/list-of-data-types) that defines how the value is formatted and validated. When omitted, preserves the existing type for updates or uses a default for new metafields. Choose a type that matches your value format. */\n valueType?: SupportedDefinitionType;\n}" + } + }, + "MetafieldRemoveChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldRemoveChange", + "description": "A metafield removal operation. Use this to delete metafields that are no longer needed for your discount configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The unique key of the metafield to remove. Must match the key used when the metafield was created." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace containing the metafield to remove. Required to ensure the correct metafield is targeted, as the same key can exist in different namespaces." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'removeMetafield'", + "description": "Identifies this as a removal operation. Always set to `'removeMetafield'` for deletions." + } + ], + "value": "export interface MetafieldRemoveChange {\n /** Identifies this as a removal operation. Always set to `'removeMetafield'` for deletions. */\n type: 'removeMetafield';\n /** The unique key of the metafield to remove. Must match the key used when the metafield was created. */\n key: string;\n /** The namespace containing the metafield to remove. Required to ensure the correct metafield is targeted, as the same key can exist in different namespaces. */\n namespace: string;\n}" + } + }, + "MetafieldChangeResult": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldChangeResult", + "value": "MetafieldChangeSuccess | MetafieldChangeResultError", + "description": "The result returned after attempting to change a metafield. Check the `type` property to determine if the operation succeeded (`'success'`) or failed (`'error'`), then handle the result appropriately in your extension.", + "isPublicDocs": true + } + }, + "MetafieldChangeSuccess": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldChangeSuccess", + "description": "A successful metafield change operation result. The metafield was updated or removed as requested and the changes are now saved.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates the operation succeeded. When this value is `'success'`, the metafield change was applied successfully." + } + ], + "value": "export interface MetafieldChangeSuccess {\n /** Indicates the operation succeeded. When this value is `'success'`, the metafield change was applied successfully. */\n type: 'success';\n}" + } + }, + "MetafieldChangeResultError": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldChangeResultError", + "description": "A failed metafield change operation result. Use the error message to understand what went wrong and fix the issue, such as validation errors, permission problems, or invalid metafield types.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A human-readable error message explaining why the operation failed. Use this to debug issues or display feedback to merchants." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates the operation failed. Check this value to determine if you need to handle an error." + } + ], + "value": "export interface MetafieldChangeResultError {\n /** Indicates the operation failed. Check this value to determine if you need to handle an error. */\n type: 'error';\n /** A human-readable error message explaining why the operation failed. Use this to debug issues or display feedback to merchants. */\n message: string;\n}" + } + }, + "DiscountFunctionSettingsData": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "name": "DiscountFunctionSettingsData", + "description": "The `data` object exposed to discount function settings extensions in the `admin.discount-details.function-settings.render` target. Use this to access the current discount configuration and populate your settings interface with existing values.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The discount's unique global identifier (GID) in the [GraphQL Admin API](/docs/api/admin-graphql) format (for example, `gid://shopify/DiscountAutomaticApp/123`). Use this ID to associate settings with the correct discount or query discount data." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "An array of [metafields](/docs/apps/build/metafields) that store the discount function's configuration values. Use these metafields to populate your settings UI with the current discount configuration and display existing settings to merchants." + } + ], + "value": "export interface DiscountFunctionSettingsData {\n /** The discount's unique global identifier (GID) in the [GraphQL Admin API](/docs/api/admin-graphql) format (for example, `gid://shopify/DiscountAutomaticApp/123`). Use this ID to associate settings with the correct discount or query discount data. */\n id: string;\n /** An array of [metafields](/docs/apps/build/metafields) that store the discount function's configuration values. Use these metafields to populate your settings UI with the current discount configuration and display existing settings to merchants. */\n metafields: Metafield[];\n}" + } + }, + "Metafield": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "name": "Metafield", + "description": "A [metafield](/docs/apps/build/metafields) that stores discount function configuration data. Use metafields to persist settings that control how your discount function behaves, such as discount thresholds, eligibility rules, or custom discount logic parameters.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "A human-readable description explaining the metafield's purpose and how it affects discount behavior. Use this to document your settings for other developers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique global identifier (GID) for this metafield. Use this ID to reference the metafield in GraphQL queries or updates." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The unique key identifying this metafield within its namespace. This key determines how you access the metafield value (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`)." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace that organizes related metafields together. All metafields for a discount should use a consistent namespace to group related settings." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The metafield [definition type](/docs/apps/build/metafields/list-of-data-types) that specifies the value format and validation rules. Use this to determine how to parse and display the value." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The metafield value stored as a string. Parse this value according to the metafield type to use it in your settings UI." + } + ], + "value": "export interface Metafield {\n /** A human-readable description explaining the metafield's purpose and how it affects discount behavior. Use this to document your settings for other developers. */\n description?: string;\n /** The unique global identifier (GID) for this metafield. Use this ID to reference the metafield in GraphQL queries or updates. */\n id: string;\n /** The namespace that organizes related metafields together. All metafields for a discount should use a consistent namespace to group related settings. */\n namespace: string;\n /** The unique key identifying this metafield within its namespace. This key determines how you access the metafield value (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`). */\n key: string;\n /** The metafield value stored as a string. Parse this value according to the metafield type to use it in your settings UI. */\n value: string;\n /** The metafield [definition type](/docs/apps/build/metafields/list-of-data-types) that specifies the value format and validation rules. Use this to determine how to parse and display the value. */\n type: string;\n}" + } + }, + "DiscountsApi": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "name": "DiscountsApi", + "description": "The `DiscountsApi` object provides reactive access to discount configuration. Use the signals to read discount classes and method, and the update function to change which parts of the purchase (products, order, or shipping) the discount affects.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "discountClasses", + "value": "ReadonlySignalLike", + "description": "A signal that contains the discount classes (Product, Order, or Shipping). Read this to determine where the discount applies in the purchase flow. A discount can apply to multiple classes simultaneously." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "discountMethod", + "value": "ReadonlySignalLike", + "description": "A signal that contains the discount method (`'automatic'` or `'code'`). Read this to determine whether the discount applies automatically at checkout or requires a customer-entered code." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "updateDiscountClasses", + "value": "UpdateSignalFunction", + "description": "A function that updates the discount classes to change where the discount applies. Call this function with an array of `DiscountClass` values to set which parts of the purchase (products, order total, or shipping) the discount affects." + } + ], + "value": "export interface DiscountsApi {\n /**\n * A signal that contains the discount classes (Product, Order, or Shipping). Read this to determine where the discount applies in the purchase flow. A discount can apply to multiple classes simultaneously.\n */\n discountClasses: ReadonlySignalLike;\n /**\n * A function that updates the discount classes to change where the discount applies. Call this function with an array of `DiscountClass` values to set which parts of the purchase (products, order total, or shipping) the discount affects.\n */\n updateDiscountClasses: UpdateSignalFunction;\n /**\n * A signal that contains the discount method (`'automatic'` or `'code'`). Read this to determine whether the discount applies automatically at checkout or requires a customer-entered code.\n */\n discountMethod: ReadonlySignalLike;\n}" + } + }, + "ReadonlySignalLike": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "ReadonlySignalLike", + "description": "Represents a reactive signal interface that provides both immediate value access and subscription-based updates. Enables real-time synchronization with changing data through the observer pattern.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "MethodSignature", + "name": "subscribe", + "value": "(fn: (value: T) => void) => () => void", + "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "T", + "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." + } + ], + "value": "export interface ReadonlySignalLike {\n /**\n * The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup.\n */\n readonly value: T;\n /**\n * Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value.\n */\n subscribe(fn: (value: T) => void): () => void;\n}" + } + }, + "DiscountClass": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DiscountClass", + "value": "'product' | 'order' | 'shipping'", + "description": "The discount class that determines where the discount applies in the purchase flow. Use this to understand what type of discount the merchant is configuring (product-level, order-level, or shipping).", + "isPublicDocs": true + } + }, + "DiscountMethod": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DiscountMethod", + "value": "'automatic' | 'code'", + "description": "The method used to apply a discount. Use `'automatic'` for discounts that apply automatically at checkout, or `'code'` for discounts that require a code entered by the customer.", + "isPublicDocs": true + } + }, + "UpdateSignalFunction": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "UpdateSignalFunction", + "description": "A function that updates a signal and returns a result indicating success or failure. The function is typically used along with a `ReadonlySignalLike` object.", + "params": [ + { + "name": "value", + "description": "", + "value": "T", + "filePath": "src/shared.ts" + } + ], + "returns": { + "filePath": "src/shared.ts", + "description": "", + "name": "Result", + "value": "Result" + }, + "value": "(value: T) => Result" + } + }, + "Result": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Result", + "value": "{success: true; value: T} | {success: false; errors: ValidationError[]}", + "description": "A result type that indicates the success or failure of an operation." + } + }, + "ValidationError": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "ValidationError", + "description": "A validation error object that is returned when an operation fails.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A code identifier for the error." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "issues", + "value": "{ message: string; path: string[]; }[]", + "description": "Field-level validation issues", + "isOptional": true + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message describing the error." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "" + } + ], + "value": "interface ValidationError {\n type: 'error';\n /**\n * A message describing the error.\n */\n message: string;\n /**\n * A code identifier for the error.\n */\n code: string;\n /**\n * Field-level validation issues\n */\n issues?: {\n message: string;\n path: string[];\n }[];\n}" + } + }, + "FunctionSettingsComponents": { + "src/surfaces/admin/components/FunctionSettingsComponents.ts": { + "filePath": "src/surfaces/admin/components/FunctionSettingsComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "FunctionSettingsComponents", + "value": "FormExtensionComponents | 'FunctionSettings'", + "description": "The components available for building function settings extensions. Includes all form components plus the function settings component required for function settings configuration." + } + }, + "FunctionSettings": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionSettings", + "description": "Configure the following properties on the function settings component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class FunctionSettings\n extends PreactCustomElement\n implements FunctionSettingsProps\n{\n constructor();\n}" + } + }, + "PrintActionExtensionApi": { + "src/surfaces/admin/api/print-action/print-action.ts": { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "name": "PrintActionExtensionApi", + "description": "The `PrintActionExtensionApi` object provides methods for print action extensions that generate custom printable documents. Access the following properties on the `PrintActionExtensionApi` object to access selected resources and display picker dialogs for print configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items to include in the print document, such as selected orders or products." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface PrintActionExtensionApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardRenderingExtensionApi {\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items to include in the print document, such as selected orders or products.\n */\n data: Data;\n}" + } + }, + "PrintActionExtensionComponents": { + "src/surfaces/admin/components/PrintActionExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/PrintActionExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PrintActionExtensionComponents", + "value": "StandardComponents | 'AdminPrintAction'", + "description": "The components available for building print action extensions. Includes all standard components plus the admin print action component required for print action setup." + } + }, + "AdminPrintAction": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminPrintAction", + "description": "Configure the following properties on the admin print action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The `src` URL of the preview and the document to print. If not provided, the preview will show an empty state and the print button will be disabled. HTML, PDFs, and images are supported.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class AdminPrintAction\n extends PreactCustomElement\n implements AdminPrintActionProps\n{\n /**\n * The `src` URL of the preview and the document to print.\n * If not provided, the preview will show an empty state and the print button will be disabled.\n * HTML, PDFs, and images are supported.\n */\n src: string;\n constructor();\n}" + } + }, + "ProductDetailsConfigurationApi": { + "src/surfaces/admin/api/product-configuration/product-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "name": "ProductDetailsConfigurationApi", + "description": "The `ProductDetailsConfigurationApi` object provides methods for configuring product bundles and relationships. Access the following properties on the `ProductDetailsConfigurationApi` object to build product configuration interfaces.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data & { product: Product; app: { launchUrl: string; applicationUrl: string; }; }", + "description": "Product configuration data including the current product, selected items, and app URLs. Use this to access the product being configured and build your configuration interface." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ProductDetailsConfigurationApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends BlockExtensionApi {\n /** Product configuration data including the current product, selected items, and app URLs. Use this to access the product being configured and build your configuration interface. */\n data: Data & {\n /**\n * The product currently being viewed in the admin.\n * @deprecated\n */\n product: Product;\n /** URLs for launching and navigating to your app, including the launch URL and base application URL. Use these to create links or redirect merchants to your app. */\n app: {\n launchUrl: string;\n applicationUrl: string;\n };\n };\n}" + } + }, + "Product": { + "src/surfaces/admin/api/product-configuration/product-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "name": "Product", + "description": "A product configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The URL-friendly unique identifier used in product URLs (for example, `'blue-t-shirt'`)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "hasOnlyDefaultVariant", + "value": "boolean", + "description": "Whether the product has only the default variant with no custom options. When `true`, the product has no size, color, or other option variations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The product's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "onlineStoreUrl", + "value": "string", + "description": "The URL to view this product on the online store. Use this to create \"View in store\" links.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "options", + "value": "{ id: string; name: string; position: number; values: string[]; }[]", + "description": "Product options that define how variants differ (for example, Size, Color, Material). Each option has an ID, name, position, and array of possible values." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productCategory", + "value": "string", + "description": "The standardized product category taxonomy. Use this for product classification in search and organization.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productComponents", + "value": "ProductComponent[]", + "description": "An array of component products that make up this bundle. Each component represents a product included in the bundle configuration." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productType", + "value": "string", + "description": "The product category or type used for organization (for example, \"T-Shirt\", \"Shoes\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "'ACTIVE' | 'ARCHIVED' | 'DRAFT'", + "description": "The publication status indicating whether the product is active (published), archived (discontinued), or draft (unpublished)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The product's display name shown to merchants and customers." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "totalInventory", + "value": "number", + "description": "The total available inventory summed across all variants and locations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "totalVariants", + "value": "number", + "description": "The total number of variants this product has." + } + ], + "value": "export interface Product {\n /** The product's unique global identifier (GID). */\n id: string;\n /** The product's display name shown to merchants and customers. */\n title: string;\n /** The URL-friendly unique identifier used in product URLs (for example, `'blue-t-shirt'`). */\n handle: string;\n /** The publication status indicating whether the product is active (published), archived (discontinued), or draft (unpublished). */\n status: 'ACTIVE' | 'ARCHIVED' | 'DRAFT';\n /** The total number of variants this product has. */\n totalVariants: number;\n /** The total available inventory summed across all variants and locations. */\n totalInventory: number;\n /** Whether the product has only the default variant with no custom options. When `true`, the product has no size, color, or other option variations. */\n hasOnlyDefaultVariant: boolean;\n /** The URL to view this product on the online store. Use this to create \"View in store\" links. */\n onlineStoreUrl?: string;\n /** Product options that define how variants differ (for example, Size, Color, Material). Each option has an ID, name, position, and array of possible values. */\n options: {\n id: string;\n name: string;\n position: number;\n values: string[];\n }[];\n /** The product category or type used for organization (for example, \"T-Shirt\", \"Shoes\"). */\n productType: string;\n /** The standardized product category taxonomy. Use this for product classification in search and organization. */\n productCategory?: string;\n /** An array of component products that make up this bundle. Each component represents a product included in the bundle configuration. */\n productComponents: ProductComponent[];\n}" + } + }, + "ProductComponent": { + "src/surfaces/admin/api/product-configuration/product-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "name": "ProductComponent", + "description": "A component product that is part of a bundle. Represents an individual product included in a bundle configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "componentVariantsCount", + "value": "number", + "description": "The count of variants from this product that are used as bundle components. Use this to understand how many variants are configured in bundles." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "featuredImage", + "value": "{\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null", + "description": "The featured image displayed for this component product with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The component product's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "nonComponentVariantsCount", + "value": "number", + "description": "The count of variants from this product that aren't used in any bundles. Use this to identify available variants for adding to bundle configurations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productUrl", + "value": "string", + "description": "The admin URL for this component product. Use this to create links to the product's details page in the admin." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The product's display name. Use this to show which product is included in the bundle." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "totalVariants", + "value": "number", + "description": "The total number of variants this component product has. Use this to determine if variant selection is needed for this component." + } + ], + "value": "export interface ProductComponent {\n /** The component product's unique global identifier (GID). */\n id: string;\n /** The product's display name. Use this to show which product is included in the bundle. */\n title: string;\n /** The featured image displayed for this component product with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces. */\n featuredImage?: {\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null;\n /** The total number of variants this component product has. Use this to determine if variant selection is needed for this component. */\n totalVariants: number;\n /** The admin URL for this component product. Use this to create links to the product's details page in the admin. */\n productUrl: string;\n /** The count of variants from this product that are used as bundle components. Use this to understand how many variants are configured in bundles. */\n componentVariantsCount: number;\n /** The count of variants from this product that aren't used in any bundles. Use this to identify available variants for adding to bundle configurations. */\n nonComponentVariantsCount: number;\n}" + } + }, + "PurchaseOptionsCardConfigurationApi": { + "src/surfaces/admin/api/purchase-options-card-action.ts": { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "name": "PurchaseOptionsCardConfigurationApi", + "description": "The `PurchaseOptionsCardConfigurationApi` object provides methods for action extensions that interact with purchase options and selling plans. Access the following properties on the `PurchaseOptionsCardConfigurationApi` object to work with selected products and their associated subscription configurations.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "close", + "value": "() => void", + "description": "Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ selected: { id: string; sellingPlanId?: string; }[]; }", + "description": "Selected purchase option data including product and selling plan identifiers." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface PurchaseOptionsCardConfigurationApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends ActionExtensionApi {\n /** Selected purchase option data including product and selling plan identifiers. */\n data: {\n /** Array of selected items with their product IDs and optional selling plan IDs for subscription configurations. */\n selected: {\n /** The product or variant identifier. */\n id: string;\n /** The associated selling plan identifier, if a subscription option is selected. */\n sellingPlanId?: string;\n }[];\n };\n}" + } + }, + "ProductVariantDetailsConfigurationApi": { + "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "name": "ProductVariantDetailsConfigurationApi", + "description": "The `ProductVariantDetailsConfigurationApi` object provides methods for configuring product variant bundles and relationships. Access the following properties on the `ProductVariantDetailsConfigurationApi` object to build variant configuration interfaces.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data & { variant: ProductVariant; app: { launchUrl: string; applicationUrl: string; }; }", + "description": "Product variant configuration data including the current variant, selected items, and app URLs. Use this to access the variant being configured and build your configuration interface." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ProductVariantDetailsConfigurationApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends BlockExtensionApi {\n /** Product variant configuration data including the current variant, selected items, and app URLs. Use this to access the variant being configured and build your configuration interface. */\n data: Data & {\n /**\n * The product variant currently being viewed in the admin.\n * @deprecated\n */\n variant: ProductVariant;\n /** URLs for launching and navigating to your app, including the launch URL and base application URL. Use these to create links or redirect merchants to your app. */\n app: {\n launchUrl: string;\n applicationUrl: string;\n };\n };\n}" + } + }, + "ProductVariant": { + "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "name": "ProductVariant", + "description": "A product variant configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "barcode", + "value": "string", + "description": "The barcode, UPC, or ISBN number for the variant." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "compareAtPrice", + "value": "string", + "description": "The original price before any discounts or markdowns." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The variant's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "price", + "value": "string", + "description": "The current selling price for this variant." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productVariantComponents", + "value": "ProductVariantComponent[]", + "description": "An array of component variants that make up this bundle variant. Each component represents a product variant included in the bundle." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "selectedOptions", + "value": "{ name: string; value: string; }[]", + "description": "The option values that define this specific variant with name and value pairs (for example, Size: Large, Color: Blue)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "sku", + "value": "string", + "description": "The Stock Keeping Unit (SKU) identifier for inventory tracking." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "taxable", + "value": "boolean", + "description": "Whether this variant is subject to taxes. When `true`, applicable taxes are calculated at checkout." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "taxCode", + "value": "string", + "description": "The harmonized system (HS) tax code for international shipping and customs." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The display name showing only the variant's option values (for example, \"Medium / Blue\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "weight", + "value": "number", + "description": "The physical weight of the variant as a number." + } + ], + "value": "export interface ProductVariant {\n /** The variant's unique global identifier (GID). */\n id: string;\n /** The Stock Keeping Unit (SKU) identifier for inventory tracking. */\n sku: string;\n /** The barcode, UPC, or ISBN number for the variant. */\n barcode: string;\n /** The display name showing only the variant's option values (for example, \"Medium / Blue\"). */\n title: string;\n /** A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\"). */\n displayName: string;\n /** The current selling price for this variant. */\n price: string;\n /** The original price before any discounts or markdowns. */\n compareAtPrice: string;\n /** Whether this variant is subject to taxes. When `true`, applicable taxes are calculated at checkout. */\n taxable: boolean;\n /** The harmonized system (HS) tax code for international shipping and customs. */\n taxCode: string;\n /** The physical weight of the variant as a number. */\n weight: number;\n /** The option values that define this specific variant with name and value pairs (for example, Size: Large, Color: Blue). */\n selectedOptions: {\n name: string;\n value: string;\n }[];\n /** An array of component variants that make up this bundle variant. Each component represents a product variant included in the bundle. */\n productVariantComponents: ProductVariantComponent[];\n}" + } + }, + "ProductVariantComponent": { + "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "name": "ProductVariantComponent", + "description": "A component variant that is part of a product bundle. Represents an individual product variant included in a bundle configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The component variant's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "{\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null", + "description": "The image displayed for this component variant with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productVariantUrl", + "value": "string", + "description": "The admin URL for this product variant. Use this to create links to the variant's details page in the admin." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "selectedOptions", + "value": "{ name: string; value: string; }[]", + "description": "The option values that define this specific component variant with name and value pairs (for example, Size: Large, Color: Blue)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "sku", + "value": "string", + "description": "The Stock Keeping Unit (SKU) identifier for this component variant.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The display name showing only the variant's option values (for example, \"Medium / Blue\")." + } + ], + "value": "export interface ProductVariantComponent {\n /** The component variant's unique global identifier (GID). */\n id: string;\n /** A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\"). */\n displayName: string;\n /** The display name showing only the variant's option values (for example, \"Medium / Blue\"). */\n title: string;\n /** The Stock Keeping Unit (SKU) identifier for this component variant. */\n sku?: string;\n /** The image displayed for this component variant with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces. */\n image?: {\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null;\n /** The admin URL for this product variant. Use this to create links to the variant's details page in the admin. */\n productVariantUrl: string;\n /** The option values that define this specific component variant with name and value pairs (for example, Size: Large, Color: Blue). */\n selectedOptions: {\n name: string;\n value: string;\n }[];\n}" + } + }, + "OrderRoutingRuleApi": { + "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "name": "OrderRoutingRuleApi", + "description": "The `OrderRoutingRuleApi` object provides methods for configuring order routing rules. Access the following properties on the `OrderRoutingRuleApi` object to manage rule settings and metafields.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "applyMetafieldsChange", + "value": "ApplyMetafieldsChange", + "description": "Updates or removes [metafields](/docs/apps/build/metafields) that store order routing rule configuration." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "The order routing rule being configured, including its metadata and associated [metafields](/docs/apps/build/metafields)." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface OrderRoutingRuleApi\n extends StandardRenderingExtensionApi {\n /** Updates or removes [metafields](/docs/apps/build/metafields) that store order routing rule configuration. */\n applyMetafieldsChange: ApplyMetafieldsChange;\n /** The order routing rule being configured, including its metadata and associated [metafields](/docs/apps/build/metafields). */\n data: Data;\n}" + } + }, + "ApplyMetafieldsChange": { + "src/surfaces/admin/api/order-routing-rule/metafields.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts", + "name": "ApplyMetafieldsChange", + "description": "A function that applies metafield changes to order routing rule settings. Call this function with one or more change operations to update or remove metafields in batch. Use batch operations to apply multiple configuration changes efficiently.", + "isPublicDocs": true, + "params": [ + { + "name": "changes", + "description": "", + "value": "MetafieldsChange[]", + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(changes: MetafieldsChange[]) => void" + } + }, + "MetafieldsChange": { + "src/surfaces/admin/api/order-routing-rule/metafields.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldsChange", + "value": "MetafieldUpdateChange | MetafieldRemoveChange | MetafieldUpdateChange[] | MetafieldRemoveChange[]", + "description": "One or more metafield change operations to apply to order routing rule settings. Can be a single change or an array of changes for batch operations. Use arrays to apply multiple changes at once.", + "isPublicDocs": true + } + }, + "ValidationSettingsApi": { + "src/surfaces/admin/api/checkout-rules/validation-settings.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "name": "ValidationSettingsApi", + "description": "The `ValidationSettingsApi` object provides methods for configuring cart and checkout validation functions. Access the following properties on the `ValidationSettingsApi` object to manage validation settings and metafields.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "applyMetafieldChange", + "value": "ApplyMetafieldChange", + "description": "Updates or removes [metafields](/docs/apps/build/metafields) that store validation function configuration. Use this to save merchant settings for your validation function." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "ValidationData", + "description": "The validation being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ValidationSettingsApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardRenderingExtensionApi {\n /**\n * Updates or removes [metafields](/docs/apps/build/metafields) that store validation function configuration. Use this to save merchant settings for your validation function.\n */\n applyMetafieldChange: ApplyMetafieldChange;\n /** The validation being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings. */\n data: ValidationData;\n}" + } + }, + "ValidationData": { + "src/surfaces/admin/api/checkout-rules/launch-options.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "name": "ValidationData", + "description": "The `data` object exposed to validation settings extensions in the `admin.settings.validation.render` target. Use this to access the current validation configuration and populate your settings interface with existing values.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "shopifyFunction", + "value": "ShopifyFunction", + "description": "The [Shopify Function](/docs/apps/build/functions) that implements the validation logic. Use this ID to associate configuration changes with the correct function." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "validation", + "value": "Validation", + "description": "The validation configuration containing the validation ID and metafields. Present when editing an existing validation, absent when creating a new validation. Use the presence of this value to determine if you're in create or edit mode.", + "isOptional": true + } + ], + "value": "export interface ValidationData {\n /** The validation configuration containing the validation ID and metafields. Present when editing an existing validation, absent when creating a new validation. Use the presence of this value to determine if you're in create or edit mode. */\n validation?: Validation;\n /** The [Shopify Function](/docs/apps/build/functions) that implements the validation logic. Use this ID to associate configuration changes with the correct function. */\n shopifyFunction: ShopifyFunction;\n}" + } + }, + "ShopifyFunction": { + "src/surfaces/admin/api/checkout-rules/launch-options.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "name": "ShopifyFunction", + "description": "A [Shopify Function](/docs/apps/build/functions) that implements cart and checkout validation logic. This identifies which function the settings interface is configuring.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The [Shopify Function's](/docs/apps/build/functions) unique global identifier (GID). Use this ID to associate settings changes with the correct function." + } + ], + "value": "export interface ShopifyFunction {\n /** The [Shopify Function's](/docs/apps/build/functions) unique global identifier (GID). Use this ID to associate settings changes with the correct function. */\n id: string;\n}" + } + }, + "Validation": { + "src/surfaces/admin/api/checkout-rules/launch-options.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "name": "Validation", + "description": "A validation configuration that exists and is active in the shop. Use this object to access the validation's current settings and metafields when merchants edit an existing validation.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The validation's unique global identifier (GID). Use this ID to reference the validation in GraphQL operations or when saving updated settings." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "An array of [metafields](/docs/apps/build/metafields) that store the validation's configuration values. Use these metafields to populate your settings UI with the current validation configuration." + } + ], + "value": "export interface Validation {\n /** The validation's unique global identifier (GID). Use this ID to reference the validation in GraphQL operations or when saving updated settings. */\n id: string;\n /** An array of [metafields](/docs/apps/build/metafields) that store the validation's configuration values. Use these metafields to populate your settings UI with the current validation configuration. */\n metafields: Metafield[];\n}" + } + }, + "ClosedIntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "ClosedIntentResponse", + "description": "The response returned when a merchant closes or cancels the workflow without completing it. Check for this response to handle cancellation gracefully in your extension.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'closed'", + "description": "Indicates the workflow was closed without completion. When `'closed'`, the merchant exited the workflow before finishing.", + "isOptional": true + } + ], + "value": "export interface ClosedIntentResponse {\n /** Indicates the workflow was closed without completion. When `'closed'`, the merchant exited the workflow before finishing. */\n code?: 'closed';\n}" + } + }, + "SuccessIntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "SuccessIntentResponse", + "description": "The response returned when a merchant successfully completes the workflow. Use this to access the created or updated resource data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'ok'", + "description": "Indicates successful completion. When `'ok'`, the merchant completed the workflow and the resource was created or updated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ [key: string]: unknown; }", + "description": "Additional data returned by the workflow, such as the created or updated resource information with IDs and properties.", + "isOptional": true + } + ], + "value": "export interface SuccessIntentResponse {\n /** Indicates successful completion. When `'ok'`, the merchant completed the workflow and the resource was created or updated. */\n code?: 'ok';\n /** Additional data returned by the workflow, such as the created or updated resource information with IDs and properties. */\n data?: {[key: string]: unknown};\n}" + } + }, + "ErrorIntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "ErrorIntentResponse", + "description": "The response returned when the workflow fails due to validation errors or other issues. Use this to display error messages and help merchants fix problems.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'error'", + "description": "Indicates the workflow failed. When `'error'`, the workflow encountered validation errors or other issues that prevented completion.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "issues", + "value": "Issue[]", + "description": "Specific validation issues or field errors. Present when validation fails on particular fields, allowing you to show targeted error messages.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A general error message describing what went wrong. Use this to display feedback when specific field errors aren't available.", + "isOptional": true + } + ], + "value": "export interface ErrorIntentResponse {\n /** Indicates the workflow failed. When `'error'`, the workflow encountered validation errors or other issues that prevented completion. */\n code?: 'error';\n /** A general error message describing what went wrong. Use this to display feedback when specific field errors aren't available. */\n message?: string;\n /** Specific validation issues or field errors. Present when validation fails on particular fields, allowing you to show targeted error messages. */\n issues?: Issue[];\n}" + } + }, + "IntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentResponse", + "value": "SuccessIntentResponse | ErrorIntentResponse | ClosedIntentResponse", + "description": "The result of an intent workflow. Check the `code` property to determine the outcome: `'ok'` for success, `'error'` for failure, or `'closed'` if the merchant cancelled.", + "isPublicDocs": true + } + }, + "IntentActivity": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentActivity", + "description": "A handle for tracking an in-progress intent workflow.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "complete", + "value": "Promise", + "description": "A Promise that resolves when the workflow completes. Await this to get the outcome and handle success, failure, or cancellation appropriately.", + "isOptional": true + } + ], + "value": "export interface IntentActivity {\n /**\n * A Promise that resolves when the workflow completes. Await this to get the outcome and handle success, failure, or cancellation appropriately.\n */\n complete?: Promise;\n}" + } + }, + "IntentAction": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentAction", + "value": "'create' | 'edit' | 'pick'", + "description": "The type of operation to perform: creating a new resource, editing an existing one, or picking existing resources.", + "isPublicDocs": true + } + }, + "IntentType": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentType", + "value": "'shopify/Article' | 'shopify/Catalog' | 'shopify/Collection' | 'shopify/Customer' | 'shopify/Discount' | 'shopify/File' | 'shopify/Location' | 'shopify/Market' | 'shopify/Menu' | 'shopify/MetafieldDefinition' | 'shopify/Metaobject' | 'shopify/MetaobjectDefinition' | 'shopify/Page' | 'shopify/Product' | 'shopify/ProductVariant'", + "description": "The types of Shopify resources that support intent-based creation and editing workflows.", + "isPublicDocs": true + } + }, + "Collection": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Collection", + "description": "A collection resource selected from the resource picker. Collections are groups of products organized by manual curation or automated rules. Use collection data to access product groupings, organizational information, and collection metadata.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "availablePublicationCount", + "value": "number", + "description": "The number of sales channels where this collection can be published. Use this to understand the collection's potential reach across different storefronts." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "The collection description as plain text without HTML formatting. Use this when you need the description without markup." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "descriptionHtml", + "value": "string", + "description": "The collection description formatted as HTML. Use this to display rich text descriptions with formatting and styling in your UI." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The URL-friendly unique identifier used in collection URLs (for example, `'summer-collection'` in `/collections/summer-collection`). Use this to generate collection links or match URL paths." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The collection's unique global identifier (GID). Use this ID for collection-related GraphQL operations." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "ResourceImage | null", + "description": "The featured image displayed for the collection. Use this for collection thumbnails, headers, or preview images.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "productsAutomaticallySortedCount", + "value": "number", + "description": "The count of products automatically added to the collection based on automation rules. Use this to understand how many products match the collection's criteria." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "productsCount", + "value": "number", + "description": "The total number of products in the collection, including both manually added and automatically included products. Use this to show collection size or for pagination." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "productsManuallySortedCount", + "value": "number", + "description": "The count of products manually added by the merchant. Use this to understand how much manual curation the collection has." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "publicationCount", + "value": "number", + "description": "The number of sales channels where the collection is currently published. Use this to check the collection's actual visibility across storefronts." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "ruleSet", + "value": "RuleSet | null", + "description": "The automation rules that determine which products are automatically included. Present only for automated (smart) collections. When `null`, the collection is manually curated. Use this to understand the collection's filtering logic.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "seo", + "value": "{ description?: string; title?: string; }", + "description": "Search engine optimization metadata for the collection. Use this to understand how the collection appears in search engine results." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "sortOrder", + "value": "CollectionSortOrder", + "description": "The default sort order that determines how products are arranged in the collection. This controls the product sequence customers see on the storefront." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "storefrontId", + "value": "string", + "description": "The Storefront API identifier for this collection. Use this ID when making Storefront API queries for this collection." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "templateSuffix", + "value": "string | null", + "description": "The theme template suffix for using custom theme templates (for example, `'featured'` to use `collection.featured.liquid`). When `null`, uses the default collection template.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The collection's display name shown to merchants and customers. Use this as the primary collection identifier in lists and displays." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "updatedAt", + "value": "string", + "description": "ISO 8601 timestamp when the collection was last updated. Use this to track changes, sync with external systems, or show freshness indicators." + } + ], + "value": "export interface Collection extends Resource {\n /** The number of sales channels where this collection can be published. Use this to understand the collection's potential reach across different storefronts. */\n availablePublicationCount: number;\n /** The collection description as plain text without HTML formatting. Use this when you need the description without markup. */\n description: string;\n /** The collection description formatted as HTML. Use this to display rich text descriptions with formatting and styling in your UI. */\n descriptionHtml: string;\n /** The URL-friendly unique identifier used in collection URLs (for example, `'summer-collection'` in `/collections/summer-collection`). Use this to generate collection links or match URL paths. */\n handle: string;\n /** The collection's unique global identifier (GID). Use this ID for collection-related GraphQL operations. */\n id: string;\n /** The featured image displayed for the collection. Use this for collection thumbnails, headers, or preview images. */\n image?: ResourceImage | null;\n /** The count of products automatically added to the collection based on automation rules. Use this to understand how many products match the collection's criteria. */\n productsAutomaticallySortedCount: number;\n /** The total number of products in the collection, including both manually added and automatically included products. Use this to show collection size or for pagination. */\n productsCount: number;\n /** The count of products manually added by the merchant. Use this to understand how much manual curation the collection has. */\n productsManuallySortedCount: number;\n /** The number of sales channels where the collection is currently published. Use this to check the collection's actual visibility across storefronts. */\n publicationCount: number;\n /** The automation rules that determine which products are automatically included. Present only for automated (smart) collections. When `null`, the collection is manually curated. Use this to understand the collection's filtering logic. */\n ruleSet?: RuleSet | null;\n /** Search engine optimization metadata for the collection. Use this to understand how the collection appears in search engine results. */\n seo: {\n /** The SEO meta description that appears in search engine result snippets. This summarizes the collection for search engines. */\n description?: string | null;\n /** The SEO page title that appears in browser tabs and search results. When `null`, the collection's regular title is used. */\n title?: string | null;\n };\n /** The default sort order that determines how products are arranged in the collection. This controls the product sequence customers see on the storefront. */\n sortOrder: CollectionSortOrder;\n /** The Storefront API identifier for this collection. Use this ID when making Storefront API queries for this collection. */\n storefrontId: string;\n /** The theme template suffix for using custom theme templates (for example, `'featured'` to use `collection.featured.liquid`). When `null`, uses the default collection template. */\n templateSuffix?: string | null;\n /** The collection's display name shown to merchants and customers. Use this as the primary collection identifier in lists and displays. */\n title: string;\n /** ISO 8601 timestamp when the collection was last updated. Use this to track changes, sync with external systems, or show freshness indicators. */\n updatedAt: string;\n}" + } + }, + "ResourceImage": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ResourceImage", + "description": "An image associated with a product, variant, or collection. Use image data to display thumbnails, galleries, or product previews in your extension.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "altText", + "value": "string", + "description": "Alternative text describing the image for screen readers and accessibility. This text appears when images fail to load. Use descriptive alt text to make your extension accessible.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique identifier for the image file. Use this ID for image-related GraphQL operations." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "originalSrc", + "value": "string", + "description": "The full URL to the original image file. Use this URL to display the image in your extension UI." + } + ], + "value": "export interface ResourceImage {\n /** The unique identifier for the image file. Use this ID for image-related GraphQL operations. */\n id: string;\n /** Alternative text describing the image for screen readers and accessibility. This text appears when images fail to load. Use descriptive alt text to make your extension accessible. */\n altText?: string;\n /** The full URL to the original image file. Use this URL to display the image in your extension UI. */\n originalSrc: string;\n}" + } + }, + "RuleSet": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "RuleSet", + "description": "A set of rules that determine which products are automatically included in a collection. Use this to understand how an automated collection populates itself with products.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "appliedDisjunctively", + "value": "boolean", + "description": "The logical operator for combining multiple rules. When `true`, products are included if they match ANY rule (OR logic). When `false`, products must match ALL rules (AND logic). Use this to understand the collection's filtering strategy." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "rules", + "value": "CollectionRule[]", + "description": "An array of rules that define product inclusion criteria. Each rule checks a different product attribute. Products are added to the collection based on how these rules are combined (see `appliedDisjunctively`)." + } + ], + "value": "export interface RuleSet {\n /** The logical operator for combining multiple rules. When `true`, products are included if they match ANY rule (OR logic). When `false`, products must match ALL rules (AND logic). Use this to understand the collection's filtering strategy. */\n appliedDisjunctively: boolean;\n /** An array of rules that define product inclusion criteria. Each rule checks a different product attribute. Products are added to the collection based on how these rules are combined (see `appliedDisjunctively`). */\n rules: CollectionRule[];\n}" + } + }, + "CollectionRule": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "CollectionRule", + "description": "A single rule that defines product inclusion criteria for an automated collection. Rules filter products based on their attributes to automatically populate a collection.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "column", + "value": "string", + "description": "The product field to evaluate (for example, `'title'`, `'tag'`, `'vendor'`, or `'product_type'`). This determines which product attribute the rule checks." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "condition", + "value": "string", + "description": "The value to compare against. For example, if checking tags, this might be `'summer'` or `'featured'`. The product attribute must match this condition value according to the relation." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "relation", + "value": "string", + "description": "The comparison operator that determines how the field is matched (for example, `'equals'`, `'contains'`, `'starts_with'`, `'ends_with'`, `'not_equals'`). This defines the matching logic between the column and condition." + } + ], + "value": "export interface CollectionRule {\n /** The product field to evaluate (for example, `'title'`, `'tag'`, `'vendor'`, or `'product_type'`). This determines which product attribute the rule checks. */\n column: string;\n /** The value to compare against. For example, if checking tags, this might be `'summer'` or `'featured'`. The product attribute must match this condition value according to the relation. */\n condition: string;\n /** The comparison operator that determines how the field is matched (for example, `'equals'`, `'contains'`, `'starts_with'`, `'ends_with'`, `'not_equals'`). This defines the matching logic between the column and condition. */\n relation: string;\n}" + } + }, + "CollectionSortOrder": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "CollectionSortOrder", + "value": "export enum CollectionSortOrder {\n /** Products arranged in the custom order set by the merchant. Use this when merchants have manually organized products for specific merchandising. */\n Manual = 'MANUAL',\n /** Products sorted by sales volume, with best-sellers first. Use this to highlight popular products. */\n BestSelling = 'BEST_SELLING',\n /** Products sorted alphabetically by title from A to Z. Use this for easy browsing of product names. */\n AlphaAsc = 'ALPHA_ASC',\n /** Products sorted alphabetically by title from Z to A. Use this for reverse alphabetical ordering. */\n AlphaDesc = 'ALPHA_DESC',\n /** Products sorted by price from highest to lowest. Use this to show premium or expensive items first. */\n PriceDesc = 'PRICE_DESC',\n /** Products sorted by price from lowest to highest. Use this to show affordable options first. */\n PriceAsc = 'PRICE_ASC',\n /** Products sorted by creation date with newest products first. Use this to highlight recently added items. */\n CreatedDesc = 'CREATED_DESC',\n /** Products sorted by creation date with oldest products first. Use this for chronological ordering. */\n Created = 'CREATED',\n /** Products sorted by search relevance based on query terms. Use this when the collection is filtered by search. */\n MostRelevant = 'MOST_RELEVANT',\n}", + "description": "The sort order that determines how products appear in a collection. This controls the default product arrangement that customers see when viewing the collection on the storefront.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Manual", + "value": "MANUAL", + "description": "Products arranged in the custom order set by the merchant. Use this when merchants have manually organized products for specific merchandising." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "BestSelling", + "value": "BEST_SELLING", + "description": "Products sorted by sales volume, with best-sellers first. Use this to highlight popular products." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "AlphaAsc", + "value": "ALPHA_ASC", + "description": "Products sorted alphabetically by title from A to Z. Use this for easy browsing of product names." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "AlphaDesc", + "value": "ALPHA_DESC", + "description": "Products sorted alphabetically by title from Z to A. Use this for reverse alphabetical ordering." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "PriceDesc", + "value": "PRICE_DESC", + "description": "Products sorted by price from highest to lowest. Use this to show premium or expensive items first." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "PriceAsc", + "value": "PRICE_ASC", + "description": "Products sorted by price from lowest to highest. Use this to show affordable options first." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "CreatedDesc", + "value": "CREATED_DESC", + "description": "Products sorted by creation date with newest products first. Use this to highlight recently added items." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Created", + "value": "CREATED", + "description": "Products sorted by creation date with oldest products first. Use this for chronological ordering." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "MostRelevant", + "value": "MOST_RELEVANT", + "description": "Products sorted by search relevance based on query terms. Use this when the collection is filtered by search." + } + ] + } + }, + "IntentQuery": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentQuery", + "description": "A structured intent specification defining what workflow to launch. Use this format when you prefer object syntax over string query format.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "IntentAction", + "description": "The operation to perform: `'create'` for new resources or `'edit'` for existing ones." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ [key: string]: unknown; }", + "description": "Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "IntentType", + "description": "The type of resource to create or edit (for example, `'shopify/Product'`)." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.", + "isOptional": true + } + ], + "value": "export interface IntentQuery extends IntentQueryOptions {\n /**\n * The operation to perform: `'create'` for new resources or `'edit'` for existing ones.\n */\n action: IntentAction;\n /**\n * The type of resource to create or edit (for example, `'shopify/Product'`).\n */\n type: IntentType;\n}" + } + }, + "LoadingOptions": { + "src/surfaces/admin/api/loading/loading.ts": { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "name": "LoadingOptions", + "description": "Options to configure the Admin page-level loading indicator.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "syntaxKind": "PropertySignature", + "name": "isLoading", + "value": "boolean", + "description": "Pass `true` to show the loading indicator, `false` to hide it.", + "isOptional": true + } + ], + "value": "export interface LoadingOptions {\n /**\n * Pass `true` to show the loading indicator, `false` to hide it.\n */\n isLoading?: boolean;\n}" + } + }, + "Money": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Money", + "value": "string", + "description": "A monetary value represented as a string (for example, `\"19.99\"` or `\"0.00\"`). The format always includes the decimal point and cents, even for whole dollar amounts. Use this type for prices, costs, and other currency values.", + "isPublicDocs": true + } + }, + "FulfillmentServiceType": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "FulfillmentServiceType", + "value": "export enum FulfillmentServiceType {\n /** Digital gift card fulfillment with automatic delivery. No physical shipping required. */\n GiftCard = 'GIFT_CARD',\n /** Manual fulfillment handled directly by the merchant. The merchant packs and ships orders themselves. */\n Manual = 'MANUAL',\n /** Third-party fulfillment service that handles warehousing and shipping (for example, ShipBob, Amazon FBA, or custom 3PL providers). */\n ThirdParty = 'THIRD_PARTY',\n}", + "description": "The types of fulfillment services that can handle order fulfillment. This determines how products are delivered to customers.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "GiftCard", + "value": "GIFT_CARD", + "description": "Digital gift card fulfillment with automatic delivery. No physical shipping required." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Manual", + "value": "MANUAL", + "description": "Manual fulfillment handled directly by the merchant. The merchant packs and ships orders themselves." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ThirdParty", + "value": "THIRD_PARTY", + "description": "Third-party fulfillment service that handles warehousing and shipping (for example, ShipBob, Amazon FBA, or custom 3PL providers)." + } + ] + } + }, + "WeightUnit": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "WeightUnit", + "value": "export enum WeightUnit {\n /** Weight measured in kilograms (kg). Commonly used in metric system countries. */\n Kilograms = 'KILOGRAMS',\n /** Weight measured in grams (g). Used for lightweight items in metric system. */\n Grams = 'GRAMS',\n /** Weight measured in pounds (lb). Commonly used in the United States. */\n Pounds = 'POUNDS',\n /** Weight measured in ounces (oz). Used for lightweight items in imperial system. */\n Ounces = 'OUNCES',\n}", + "description": "The unit of measurement for product weight. Use this with the weight value to calculate shipping costs or display product specifications.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Kilograms", + "value": "KILOGRAMS", + "description": "Weight measured in kilograms (kg). Commonly used in metric system countries." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Grams", + "value": "GRAMS", + "description": "Weight measured in grams (g). Used for lightweight items in metric system." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Pounds", + "value": "POUNDS", + "description": "Weight measured in pounds (lb). Commonly used in the United States." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Ounces", + "value": "OUNCES", + "description": "Weight measured in ounces (oz). Used for lightweight items in imperial system." + } + ] + } + }, + "ProductVariantInventoryPolicy": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "ProductVariantInventoryPolicy", + "value": "export enum ProductVariantInventoryPolicy {\n /** Prevents purchases when inventory reaches zero. Customers can't add out-of-stock variants to their cart. Use this to avoid overselling. */\n Deny = 'DENY',\n /** Allows purchases even when inventory is zero or negative. Customers can continue buying out-of-stock variants. Use this for backorders or made-to-order products. */\n Continue = 'CONTINUE',\n}", + "description": "The inventory policy that determines whether customers can purchase a variant when it's out of stock. Use this to control checkout behavior for low or zero inventory items.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Deny", + "value": "DENY", + "description": "Prevents purchases when inventory reaches zero. Customers can't add out-of-stock variants to their cart. Use this to avoid overselling." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Continue", + "value": "CONTINUE", + "description": "Allows purchases even when inventory is zero or negative. Customers can continue buying out-of-stock variants. Use this for backorders or made-to-order products." + } + ] + } + }, + "ProductVariantInventoryManagement": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "ProductVariantInventoryManagement", + "value": "export enum ProductVariantInventoryManagement {\n /** Inventory tracked and managed by Shopify. Stock levels update through Shopify admin or API. Use this for standard inventory management. */\n Shopify = 'SHOPIFY',\n /** Inventory not tracked. The variant is always considered in stock. Use this for services, digital goods, or custom products with unlimited availability. */\n NotManaged = 'NOT_MANAGED',\n /** Inventory tracked by an external fulfillment service. The third-party system manages stock levels. Use this when a 3PL or fulfillment app controls inventory. */\n FulfillmentService = 'FULFILLMENT_SERVICE',\n}", + "description": "The system responsible for tracking inventory levels for a variant. This determines where stock counts are managed and updated.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Shopify", + "value": "SHOPIFY", + "description": "Inventory tracked and managed by Shopify. Stock levels update through Shopify admin or API. Use this for standard inventory management." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "NotManaged", + "value": "NOT_MANAGED", + "description": "Inventory not tracked. The variant is always considered in stock. Use this for services, digital goods, or custom products with unlimited availability." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "FulfillmentService", + "value": "FULFILLMENT_SERVICE", + "description": "Inventory tracked by an external fulfillment service. The third-party system manages stock levels. Use this when a 3PL or fulfillment app controls inventory." + } + ] + } + }, + "ProductStatus": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "ProductStatus", + "value": "export enum ProductStatus {\n /** The product is published and available for sale on active sales channels. Customers can view and purchase this product. */\n Active = 'ACTIVE',\n /** The product is archived and no longer available. Archived products don't appear on storefronts and can't be purchased. Use this for discontinued items. */\n Archived = 'ARCHIVED',\n /** The product is an unpublished draft not visible to customers. Draft products are still being prepared or reviewed. */\n Draft = 'DRAFT',\n}", + "description": "The publication status indicating a product's availability state. Use this to filter products or determine which products customers can see and purchase.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Active", + "value": "ACTIVE", + "description": "The product is published and available for sale on active sales channels. Customers can view and purchase this product." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Archived", + "value": "ARCHIVED", + "description": "The product is archived and no longer available. Archived products don't appear on storefronts and can't be purchased. Use this for discontinued items." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Draft", + "value": "DRAFT", + "description": "The product is an unpublished draft not visible to customers. Draft products are still being prepared or reviewed." + } + ] + } + }, + "StandardRenderingExtensionApi": { + "src/surfaces/admin/api/standard/standard-rendering.ts": { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "name": "StandardRenderingExtensionApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface StandardRenderingExtensionApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardApi {\n /**\n * Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel.\n */\n resourcePicker: ResourcePickerApi;\n\n /**\n * Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.\n */\n picker: PickerApi;\n}" + } + }, + "CustomerStandardMetafieldDependency": { + "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts": { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CustomerStandardMetafieldDependency", + "value": "'facts.birth_date'", + "description": "Standard customer metafields that can be referenced as template dependencies.", + "isPublicDocs": true + } + }, + "OrderRoutingRule": { + "src/surfaces/admin/api/order-routing-rule/data.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "name": "OrderRoutingRule", + "description": "An order routing rule configuration that determines how orders are routed to fulfillment locations. Use this to access the rule's current settings and populate your configuration interface.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "A description explaining the rule's purpose and how it routes orders. Use this to help merchants understand what the rule does." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique global identifier (GID) for the order routing rule. Use this ID to associate configuration changes with the correct rule." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The display label for the order routing rule shown to merchants in the admin. Use this to identify the rule in lists and settings pages." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "An array of [metafields](/docs/apps/build/metafields) that store the routing rule's configuration values. Use these metafields to populate your settings UI with the current rule configuration." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "priority", + "value": "number", + "description": "The priority order for rule evaluation when multiple rules exist. Lower numbers are evaluated first (for example, a rule with priority 1 runs before priority 2). Use this to understand the rule's position in the evaluation sequence.", + "isOptional": true + } + ], + "value": "export interface OrderRoutingRule {\n /** The display label for the order routing rule shown to merchants in the admin. Use this to identify the rule in lists and settings pages. */\n label: string;\n /** A description explaining the rule's purpose and how it routes orders. Use this to help merchants understand what the rule does. */\n description: string;\n /** The unique global identifier (GID) for the order routing rule. Use this ID to associate configuration changes with the correct rule. */\n id: string;\n /** The priority order for rule evaluation when multiple rules exist. Lower numbers are evaluated first (for example, a rule with priority 1 runs before priority 2). Use this to understand the rule's position in the evaluation sequence. */\n priority?: number;\n /** An array of [metafields](/docs/apps/build/metafields) that store the routing rule's configuration values. Use these metafields to populate your settings UI with the current rule configuration. */\n metafields: Metafield[];\n}" + } + }, + "ComponentChildren": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentChildren", + "value": "preact.ComponentChildren", + "description": "Represents any valid children that can be rendered within a component, including elements, strings, numbers, or arrays of these types. This is an alias for Preact's `ComponentChildren` type.", + "isPublicDocs": true + } + }, + "StringChildren": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "StringChildren", + "value": "string", + "description": "Represents string-only children for components that specifically require text content.", + "isPublicDocs": true + } + }, + "ActionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ActionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The text to use as the action modal's title. If not provided, the name of the extension will be used.", + "isOptional": true + } + ], + "value": "export interface ActionProps {\n /**\n * The text to use as the action modal's title. If not provided, the name of the extension will be used.\n */\n heading?: string;\n}" + } + }, + "ActionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ActionSlots", + "description": "The action component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + } + ], + "value": "export interface ActionSlots {\n /**\n * The primary action button or link, representing the main or most important action available in this context.\n * Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.\n */\n primaryAction?: ComponentChildren;\n /**\n * Additional action buttons or links that provide alternative or supporting actions.\n * Visually de-emphasized compared to the primary action.\n */\n secondaryActions?: ComponentChildren;\n}" + } + }, + "BaseOverlayProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseOverlayProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterShow", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + } + ], + "value": "export interface BaseOverlayProps {\n /**\n * A callback fired immediately after the overlay is shown.\n */\n onShow?: (event: Event) => void;\n /**\n * A callback fired when the overlay is shown, after any show animations have completed.\n */\n onAfterShow?: (event: Event) => void;\n /**\n * A callback fired immediately after the overlay is hidden.\n */\n onHide?: (event: Event) => void;\n /**\n * A callback fired when the overlay is hidden, after any hide animations have completed.\n */\n onAfterHide?: (event: Event) => void;\n}" + } + }, + "BaseOverlayMethods": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseOverlayMethods", + "description": "Shared interface for web component methods that control overlay visibility.\n\nAll methods are required (not optional) because components implementing this interface must provide consistent JavaScript APIs. Unlike props/attributes, methods are not rendered in HTML and consumers expect them to be available on all component instances.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "showOverlay", + "value": "() => void", + "description": "A method to programmatically show the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "toggleOverlay", + "value": "() => void", + "description": "A method to programmatically toggle the visibility of the overlay." + } + ], + "value": "export interface BaseOverlayMethods {\n /**\n * A method to programmatically show the overlay.\n *\n * @implementation This is a method to be called on the element and not a callback and should hence be camelCase\n */\n showOverlay: () => void;\n /**\n * A method to programmatically hide the overlay.\n *\n * @implementation This is a method to be called on the element and not a callback and should hence be camelCase\n */\n hideOverlay: () => void;\n /**\n * A method to programmatically toggle the visibility of the overlay.\n *\n * @implementation This is a method to be called on the element and not a callback and should hence be camelCase\n */\n toggleOverlay: () => void;\n}" + } + }, + "FocusEventProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FocusEventProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface FocusEventProps {\n /**\n * A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n onBlur?: (event: FocusEvent) => void;\n /**\n * A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n onFocus?: (event: FocusEvent) => void;\n}" + } + }, + "ToggleEventProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ToggleEventProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + } + ], + "value": "export interface ToggleEventProps {\n /**\n * A callback fired when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n onAfterToggle?: (event: ToggleEvent$1) => void;\n /**\n * A callback fired immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n onToggle?: (event: ToggleEvent$1) => void;\n}" + } + }, + "ToggleState": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ToggleState", + "value": "'open' | 'closed'", + "description": "Represents the visibility state of a toggleable element.\n\n- `open`: The element is visible or expanded.\n- `closed`: The element is hidden or collapsed.", + "isPublicDocs": true + } + }, + "ExtendableEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ExtendableEvent", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "waitUntil", + "value": "(promise: Promise) => void", + "description": "A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.\n\nCan be called multiple times to add promises to the event, but must be called synchronously during event dispatch. Cannot be called after a `setTimeout` or within a microtask.", + "isOptional": true + } + ], + "value": "export interface ExtendableEvent extends Event {\n /**\n * A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.\n *\n * Can be called multiple times to add promises to the event, but must be called synchronously during event dispatch.\n * Cannot be called after a `setTimeout` or within a microtask.\n */\n waitUntil?: (promise: Promise) => void;\n}" + } + }, + "AggregateError": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AggregateError", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "errors", + "value": "T[]", + "description": "An array of individual errors that have been aggregated together. Each error in this array represents a separate failure that occurred." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "stack", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface AggregateError extends Error {\n /**\n * An array of individual errors that have been aggregated together.\n * Each error in this array represents a separate failure that occurred.\n */\n errors: T[];\n}" + } + }, + "AggregateErrorEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AggregateErrorEvent", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "colno", + "value": "number", + "description": "The **`colno`** read-only property of the ErrorEvent interface returns an integer containing the column number of the script file on which the error occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "AggregateError", + "description": "The aggregated error object containing multiple individual errors. Access the `errors` property to retrieve the array of individual error instances." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "filename", + "value": "string", + "description": "The **`filename`** read-only property of the ErrorEvent interface returns a string containing the name of the script file in which the error occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lineno", + "value": "number", + "description": "The **`lineno`** read-only property of the ErrorEvent interface returns an integer containing the line number of the script file on which the error occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "The **`message`** read-only property of the ErrorEvent interface returns a string containing a human-readable error message describing the problem.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/message)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + } + ], + "value": "export interface AggregateErrorEvent extends ErrorEvent {\n /**\n * The aggregated error object containing multiple individual errors.\n * Access the `errors` property to retrieve the array of individual error instances.\n */\n error: AggregateError;\n}" + } + }, + "ToneKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ToneKeyword", + "value": "'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical' | 'accent' | 'custom'", + "description": "Defines the semantic color treatment of a component to convey specific intent or status.\n\nTones apply coordinated color schemes (text, background, icons) across the component. Some components, like banner, also use tone to determine accessibility attributes and screen reader announcements.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General-purpose information without specific sentiment.\n- `info`: Informational content that provides helpful details or guidance.\n- `success`: Positive outcomes, successful operations, or confirmations.\n- `caution`: Warnings about potential issues that require attention but aren't critical.\n- `warning`: Similar to caution, indicates something that needs user awareness.\n- `critical`: Errors, failures, or urgent issues that require immediate attention.\n- `accent`: Highlighted or emphasized content that doesn't fit other semantic tones.\n- `custom`: Custom color treatment defined by your theme or implementation.", + "isPublicDocs": true + } + }, + "IconType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IconType", + "value": "'replace' | 'search' | 'split' | 'link' | 'edit' | 'info' | 'incomplete' | 'complete' | 'product' | 'variant' | 'collection' | 'select' | 'color' | 'money' | 'order' | 'code' | 'adjust' | 'affiliate' | 'airplane' | 'alert-bubble' | 'alert-circle' | 'alert-diamond' | 'alert-location' | 'alert-octagon' | 'alert-octagon-filled' | 'alert-triangle' | 'alert-triangle-filled' | 'app-extension' | 'apps' | 'archive' | 'arrow-down' | 'arrow-down-circle' | 'arrow-down-right' | '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' | 'battery-low' | 'bill' | 'blank' | 'blog' | 'bolt' | 'bolt-filled' | 'book' | 'book-open' | '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-filled' | 'cart-sale' | 'cart-send' | 'cart-up' | 'cash-dollar' | 'cash-euro' | 'cash-pound' | 'cash-rupee' | 'cash-yen' | 'catalog-product' | 'categories' | 'channels' | '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-add' | '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' | 'delivered' | 'delivery' | 'desktop' | 'disabled' | 'disabled-filled' | 'discount' | 'discount-add' | 'discount-automatic' | 'discount-code' | 'discount-remove' | 'dns-settings' | 'dock-floating' | 'dock-side' | 'domain' | 'domain-landing-page' | 'domain-new' | 'domain-redirect' | 'download' | 'drag-drop' | 'drag-handle' | 'drawer' | 'duplicate' | 'email' | 'email-follow-up' | 'email-newsletter' | 'empty' | 'enabled' | 'enter' | 'envelope' | 'envelope-soft-pack' | 'eraser' | 'exchange' | 'exit' | 'export' | 'external' | 'eye-check-mark' | 'eye-dropper' | 'eye-dropper-list' | 'eye-first' | 'eyeglasses' | 'fav' | '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' | 'geolocation' | 'gift' | 'gift-card' | 'git-branch' | 'git-commit' | 'git-repository' | 'globe' | 'globe-asia' | 'globe-europe' | 'globe-lines' | 'globe-list' | 'graduation-hat' | 'grid' | 'hashtag' | 'hashtag-decimal' | 'hashtag-list' | 'heart' | 'hide' | 'hide-filled' | 'home' | 'home-filled' | 'icons' | 'identity-card' | 'image' | 'image-add' | 'image-alt' | 'image-explore' | 'image-magic' | 'image-none' | 'image-with-text-overlay' | 'images' | 'import' | 'in-progress' | 'incentive' | 'incoming' | 'info-filled' | 'inheritance' | 'inventory' | 'inventory-edit' | 'inventory-list' | 'inventory-transfer' | 'inventory-updated' | 'iq' | 'key' | 'keyboard' | 'keyboard-filled' | 'keyboard-hide' | 'keypad' | 'label-printer' | 'language' | 'language-translate' | '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-list' | 'list-bulleted' | 'list-bulleted-filled' | 'list-numbered' | 'live' | 'live-critical' | 'live-none' | '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-filled' | 'menu-horizontal' | 'menu-vertical' | 'merge' | 'metafields' | 'metaobject' | 'metaobject-list' | 'metaobject-reference' | 'microphone' | 'microphone-muted' | 'minimize' | 'minus' | 'minus-circle' | 'mobile' | 'money-none' | 'money-split' | 'moon' | 'nature' | 'note' | 'note-add' | 'notification' | 'number-one' | 'order-batches' | 'order-draft' | 'order-filled' | 'order-first' | 'order-fulfilled' | 'order-repeat' | 'order-unfulfilled' | 'orders-status' | 'organization' | 'outdent' | 'outgoing' | 'package' | 'package-cancel' | 'package-fulfilled' | 'package-on-hold' | 'package-reassign' | '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' | 'partially-complete' | 'passkey' | 'paste' | 'pause-circle' | 'payment' | 'payment-capture' | 'payout' | 'payout-dollar' | 'payout-euro' | 'payout-pound' | 'payout-rupee' | 'payout-yen' | 'person' | 'person-add' | 'person-exit' | 'person-filled' | 'person-list' | 'person-lock' | 'person-remove' | 'person-segment' | 'personalized-text' | 'phablet' | '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' | 'point-of-sale-register' | 'price-list' | 'print' | 'product-add' | 'product-cost' | 'product-filled' | '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-folded' | 'receipt-paid' | 'receipt-pound' | 'receipt-refund' | 'receipt-rupee' | 'receipt-yen' | 'receivables' | 'redo' | 'referral-code' | 'refresh' | 'remove-background' | 'reorder' | 'replay' | 'reset' | 'return' | 'reward' | 'rocket' | 'rotate-left' | 'rotate-right' | 'sandbox' | 'save' | 'savings' | 'scan-qr-code' | 'search-add' | 'search-list' | 'search-recent' | 'search-resource' | 'send' | 'settings' | 'share' | 'shield-check-mark' | 'shield-none' | 'shield-pending' | 'shield-person' | 'shipping-label' | 'shipping-label-cancel' | 'shopcodes' | 'slideshow' | 'smiley-happy' | 'smiley-joy' | 'smiley-neutral' | 'smiley-sad' | 'social-ad' | 'social-post' | 'sort' | 'sort-ascending' | 'sort-descending' | 'sound' | 'sports' | 'star' | 'star-circle' | 'star-filled' | 'star-half' | '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-indent-remove' | 'text-italic' | 'text-quote' | 'text-title' | 'text-underline' | 'text-with-image' | 'theme' | 'theme-edit' | 'theme-store' | 'theme-template' | 'three-d-environment' | 'thumbs-down' | 'thumbs-up' | 'tip-jar' | 'toggle-off' | 'toggle-on' | 'transaction' | 'transaction-fee-add' | 'transaction-fee-dollar' | 'transaction-fee-euro' | 'transaction-fee-pound' | 'transaction-fee-rupee' | 'transaction-fee-yen' | 'transfer' | 'transfer-in' | 'transfer-internal' | 'transfer-out' | 'truck' | 'undo' | 'unknown-device' | 'unlock' | 'upload' | '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' | 'x-circle-filled'", + "description": "Represents the available icon names that can be used in icon components. This is derived from the complete list of supported icons in the design system.", + "isPublicDocs": true + } + }, + "ExtractStrict": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtractStrict", + "value": "", + "description": "A type-safe version of TypeScript's `Extract` utility that constrains the second type parameter to be assignable to the first. This provides compile-time validation that you're only extracting types that actually exist within the union, catching potential errors earlier in development.", + "isPublicDocs": true + } + }, + "optionalSpace": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "optionalSpace", + "value": "'' | ' '", + "description": "A utility type representing an optional space character for use in string literal type composition. Allows flexible formatting of compound values where spacing is a matter of preference rather than semantic difference.", + "isPublicDocs": true + } + }, + "DisplayProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DisplayProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface DisplayProps {\n /**\n * The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n *\n * - `auto`: the component’s initial value. The actual value depends on the component and context.\n * - `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n *\n * Learn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).\n *\n * @default 'auto'\n */\n display?: MaybeResponsive<'auto' | 'none'>;\n}" + } + }, + "AccessibilityRoleProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AccessibilityRoleProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + } + ], + "value": "export interface AccessibilityRoleProps {\n /**\n * The semantic meaning of the component’s content. When set,\n * the role will be used by assistive technologies to help users\n * navigate the page.\n *\n * @implementation Although, in HTML hosts, this property changes the element used,\n * changing this property must not impact the visual styling of inside or outside of the box.\n *\n * @default 'generic'\n */\n accessibilityRole?: AccessibilityRole;\n}" + } + }, + "LabelAccessibilityVisibilityProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LabelAccessibilityVisibilityProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + } + ], + "value": "export interface LabelAccessibilityVisibilityProps {\n /**\n * Controls whether the label is visible to all users or only to screen readers.\n *\n * - `visible`: The label is shown to everyone (default).\n * - `exclusive`: The label is visually hidden but still announced by screen readers.\n *\n * Use `exclusive` when the surrounding context makes the label redundant visually,\n * but screen reader users still need it for clarity.\n *\n * @default 'visible'\n */\n labelAccessibilityVisibility?: ExtractStrict<\n AccessibilityVisibilityProps['accessibilityVisibility'],\n 'visible' | 'exclusive'\n >;\n}" + } + }, + "BorderRadiusKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderRadiusKeyword", + "value": "SizeKeyword | 'max' | 'none'", + "description": "Defines the radius of rounded corners, using the standard size scale, `max` for fully rounded, or `none` for sharp corners.", + "isPublicDocs": true + } + }, + "OverflowProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OverflowProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + } + ], + "value": "export interface OverflowProps {\n /**\n * The overflow behavior of the element.\n *\n * - `visible`: the content that extends beyond the element’s container is visible.\n * - `hidden`: clips the content when it is larger than the element’s container.\n * The element will not be scrollable and the users will not be able\n * to access the clipped content by dragging or using a scroll wheel on a mouse.\n *\n * @default 'visible'\n */\n overflow?: 'hidden' | 'visible';\n}" + } + }, + "BaseBoxProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseBoxProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface BaseBoxProps\n extends AccessibilityVisibilityProps,\n BackgroundProps,\n DisplayProps,\n SizingProps,\n PaddingProps,\n BorderProps,\n OverflowProps {\n /**\n * The content displayed within the box component, which serves as a flexible container for organizing and styling other components.\n */\n children?: ComponentChildren;\n /**\n * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.\n */\n accessibilityLabel?: string;\n}" + } + }, + "BaseBoxPropsWithRole": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseBoxPropsWithRole", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface BaseBoxPropsWithRole\n extends BaseBoxProps,\n AccessibilityRoleProps {}" + } + }, + "ButtonBehaviorProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonBehaviorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ], + "value": "export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {\n /**\n * The behavior of the button component.\n *\n * - `button`: Used to indicate the component acts as a button, meaning it has no default action.\n * - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n * - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n *\n * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.\n *\n * @default 'button'\n */\n type?: 'submit' | 'button' | 'reset';\n /**\n * A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n onClick?: (event: Event) => void;\n /**\n * Whether the button is disabled, preventing it from being clicked or receiving focus.\n *\n * @default false\n */\n disabled?: boolean;\n /**\n * Whether to replace the button content with a loading indicator while a background action is being performed.\n *\n * This also disables the button component.\n *\n * @default false\n */\n loading?: boolean;\n}" + } + }, + "LinkBehaviorProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LinkBehaviorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {\n /**\n * The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.\n */\n href?: string;\n /**\n * The browsing context where the linked URL should be displayed.\n *\n * - `auto`: The target is automatically determined based on the origin of the URL.\n * - `_blank`: Opens the URL in a new window or tab.\n * - `_self`: Opens the URL in the same browsing context as the current one.\n * - `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n * - `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.\n *\n * @implementation Surfaces can set specific rules on how they handle each URL.\n * @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.\n * @implementation For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n *\n * Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n *\n * @default 'auto'\n */\n target?: 'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString;\n /**\n * Prompts the browser to download the linked URL rather than navigate to it.\n * When set, the value specifies the suggested filename for the downloaded file.\n *\n * The filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes.\n * Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n *\n * Learn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).\n */\n download?: string;\n /**\n * A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n onClick?: (event: Event) => void;\n}" + } + }, + "InteractionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "InteractionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "export interface InteractionProps {\n /**\n * The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n */\n commandFor?: string;\n /**\n * The action that `commandFor` should take when this component is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the visibility of the target component.\n * - `--copy`: Copies the target `ClipboardItem`.\n *\n * Learn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n *\n * @default '--auto'\n */\n command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';\n /**\n * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.\n */\n interestFor?: string;\n}" + } + }, + "BaseClickableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseClickableProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ], + "value": "export interface BaseClickableProps\n extends ButtonBehaviorProps,\n LinkBehaviorProps {}" + } + }, + "BaseInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseInputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + } + ], + "value": "export interface BaseInputProps {\n /**\n * The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.\n */\n name?: string;\n /**\n * Whether the field is disabled, preventing any user interaction.\n *\n * @default false\n */\n disabled?: boolean;\n}" + } + }, + "InputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "InputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface InputProps extends BaseInputProps {\n /**\n * A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n onChange?: (event: Event) => void;\n /**\n * A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).\n */\n onInput?: (event: Event) => void;\n value?: string;\n /**\n * The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.\n *\n * @implementation `defaultValue` reflects to the `value` attribute.\n */\n defaultValue?: string;\n}" + } + }, + "MultipleInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MultipleInputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user selects or deselects options. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "values", + "value": "string[]", + "description": "An array of `value` attributes for the currently selected options. When provided, this property automatically sets the `selected` state on child option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.", + "isOptional": true + } + ], + "value": "export interface MultipleInputProps extends BaseInputProps {\n /**\n * A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n onChange?: (event: Event) => void;\n /**\n * A callback fired when the user selects or deselects options. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).\n */\n onInput?: (event: Event) => void;\n /**\n * An array of `value` attributes for the currently selected options. When provided, this property automatically sets the `selected` state on child option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.\n */\n values?: string[];\n}" + } + }, + "FileInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FileInputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "files", + "value": "ReadonlyArray", + "description": "An array of File objects representing the files currently selected by the user.\n\nThis property is read-only and cannot be directly modified. To clear the selected files, set the `value` prop to an empty string or null.", + "isOptional": true, + "defaultValue": "[]" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished selecting one or more files.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes to the file selection.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "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.\n\nLearn more about the [file input value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value).", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface FileInputProps extends BaseInputProps {\n /**\n * A callback fired when the user has finished selecting one or more files.\n */\n onChange?: (event: Event) => void;\n /**\n * A callback fired when the user makes any changes to the file selection.\n */\n onInput?: (event: Event) => void;\n /**\n * A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\").\n * When the user selected multiple files, the value represents the first file in the list of files they selected.\n * The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file.\n *\n * Learn more about the [file input value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value).\n *\n * @default ''\n */\n value?: string;\n /**\n * An array of File objects representing the files currently selected by the user.\n *\n * This property is read-only and cannot be directly modified.\n * To clear the selected files, set the `value` prop to an empty string or null.\n *\n * @default []\n */\n files?: ReadonlyArray;\n}" + } + }, + "FieldErrorProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldErrorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + } + ], + "value": "export interface FieldErrorProps {\n /**\n * An error message displayed below the checkbox to indicate validation problems.\n * When set, the checkbox is styled with error indicators and the message is announced to screen readers.\n */\n error?: string;\n}" + } + }, + "BasicFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BasicFieldProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface BasicFieldProps\n extends FieldErrorProps,\n LabelAccessibilityVisibilityProps {\n /**\n * Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.\n *\n * @default false\n */\n required?: boolean;\n /**\n * The text displayed as the field label, which identifies the purpose of the field to users.\n * This label is associated with the field for accessibility and helps users understand what information to provide.\n */\n label?: string;\n}" + } + }, + "FieldDetailsProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldDetailsProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + } + ], + "value": "export interface FieldDetailsProps {\n /**\n * Supplementary text displayed below the checkbox to provide additional context, instructions, or help.\n * Use this to explain what checking the box means or provide guidance to users.\n * This text is announced to screen readers.\n */\n details?: string;\n}" + } + }, + "FieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FieldProps\n extends BasicFieldProps,\n InputProps,\n FocusEventProps,\n FieldDetailsProps {\n /**\n * The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.\n */\n placeholder?: string;\n}" + } + }, + "BaseTextFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseTextFieldProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface BaseTextFieldProps extends FieldProps {\n /**\n * Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.\n *\n * @default false\n */\n readOnly?: boolean;\n}" + } + }, + "FieldDecorationProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldDecorationProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "ComponentChildren", + "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconType | AnyString", + "description": "An icon displayed inside the field to provide visual context about the expected input or field purpose. Commonly used for search fields, currency inputs, or to indicate field type. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string", + "description": "A non-editable text value 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`.\n\nThis text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "string", + "description": "A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n\nThis text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface FieldDecorationProps {\n /**\n * A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n *\n * This text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.\n *\n * @default ''\n */\n suffix?: string;\n /**\n * A non-editable text value 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`.\n *\n * This text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.\n *\n * @default ''\n */\n prefix?: string;\n /**\n * An icon displayed inside the field to provide visual context about the expected input or field purpose.\n * Commonly used for search fields, currency inputs, or to indicate field type.\n * Accepts any icon name from the icon library or a custom string identifier.\n *\n * @default ''\n */\n icon?: IconType | AnyString;\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: ComponentChildren;\n}" + } + }, + "NumberConstraintsProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "NumberConstraintsProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "controls", + "value": "'auto' | 'stepper' | 'none'", + "description": "The type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + } + ], + "value": "export interface NumberConstraintsProps {\n /**\n * The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n *\n * Users can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.\n *\n * @default Infinity\n */\n max?: number;\n /**\n * The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n *\n * Users can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.\n *\n * @default -Infinity\n */\n min?: number;\n /**\n * The amount the value can increase or decrease by. This can be an integer or decimal.\n * If a `max` or `min` is specified with `step` when increasing/decreasing the value\n * via the buttons, the final value will always round to the `max` or `min`\n * rather than the closest valid amount.\n *\n * @default 1\n */\n step?: number;\n /**\n * The type of controls displayed in the field.\n *\n * - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property.\n * Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n * - `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n * - `auto`: the presence of the controls depends on the surface and context.\n *\n * @default 'auto'\n */\n controls?: 'auto' | 'stepper' | 'none';\n}" + } + }, + "MinMaxLengthProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MinMaxLengthProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "isOptional": true, + "defaultValue": "0" + } + ], + "value": "export interface MinMaxLengthProps {\n /**\n * The maximum number of characters allowed in the field.\n *\n * @default Infinity\n */\n maxLength?: number;\n /**\n * The minimum number of characters required in the field.\n *\n * @default 0\n */\n minLength?: number;\n}" + } + }, + "BaseSelectableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseSelectableProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + } + ], + "value": "export interface BaseSelectableProps {\n /**\n * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.\n */\n accessibilityLabel?: string;\n /**\n * Whether the checkbox is disabled, preventing user interaction.\n * Disabled checkboxes appear dimmed and their values aren't submitted with forms.\n *\n * @default false\n */\n disabled?: boolean;\n /**\n * The value submitted with the form when this checkbox is checked.\n * If not specified, the default value is \"on\".\n */\n value?: string;\n}" + } + }, + "BaseOptionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseOptionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultSelected", + "value": "boolean", + "description": "The initial selected state for uncontrolled components. Use this when you want the option to start selected but don't need to control its state afterward.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the option is currently selected. Use this for controlled components where you manage the selection state.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + } + ], + "value": "export interface BaseOptionProps extends BaseSelectableProps {\n /**\n * Whether the option is currently selected. Use this for controlled components where you manage the selection state.\n *\n * @default false\n */\n selected?: boolean;\n /**\n * The initial selected state for uncontrolled components. Use this when you want the option to start selected\n * but don't need to control its state afterward.\n *\n * @implementation `defaultSelected` reflects to the `selected` attribute.\n *\n * @default false\n */\n defaultSelected?: boolean;\n}" + } + }, + "BaseCheckableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseCheckableProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked. Use this for controlled components where you manage the checked state.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "The initial checked state for uncontrolled components. Use this when you want the control to start checked but don't need to control its state afterward.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name used to identify this checkbox in form submissions. When the checkbox is checked, its `name` and `value` are included in the form data. Must be unique within the containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + } + ], + "value": "export interface BaseCheckableProps\n extends BaseSelectableProps,\n InteractionProps {\n /**\n * The text label displayed next to the checkbox that describes what the checkbox controls.\n * Clicking the label will also toggle the checkbox state.\n */\n label?: string;\n /**\n * Whether the control is currently checked. Use this for controlled components where you manage the checked state.\n *\n * @default false\n */\n checked?: boolean;\n /**\n * The initial checked state for uncontrolled components. Use this when you want the control to start checked\n * but don't need to control its state afterward.\n *\n * @implementation `defaultChecked` reflects to the `checked` attribute.\n *\n * @default false\n */\n defaultChecked?: boolean;\n /**\n * The name used to identify this checkbox in form submissions.\n * When the checkbox is checked, its `name` and `value` are included in the form data.\n * Must be unique within the containing form.\n */\n name?: string;\n /**\n * A callback that is run whenever the control is changed. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n onChange?: (event: Event) => void;\n /**\n * A callback that is run whenever the control is changed. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).\n */\n onInput?: (event: Event) => void;\n}" + } + }, + "ChipProps$1": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChipProps$1", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "ComponentChildren", + "description": "The graphic to display inside of the chip.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface ChipProps$1 extends GlobalProps {\n /**\n * The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.\n */\n children?: ComponentChildren;\n /**\n * The graphic to display inside of the chip.\n *\n * @implementation Only `s-icon` is supported.\n */\n graphic?: ComponentChildren;\n /**\n * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.\n */\n accessibilityLabel?: string;\n /**\n * The color emphasis level that controls visual intensity.\n *\n * @default 'base'\n */\n color?: ColorKeyword;\n}" + } + }, + "AutocompleteProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AutocompleteProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "| AutocompleteField\n | `${AutocompleteSection} ${AutocompleteField}`\n | `${AutocompleteGroup} ${AutocompleteField}`\n | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`\n | 'on'\n | 'off'", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on' for everything else" + } + ], + "value": "export interface AutocompleteProps<\n AutocompleteField extends AnyAutocompleteField,\n> {\n /**\n * A hint about the intended content of the field for browser autofill.\n *\n * When set to `on` (the default), this property indicates that the field should support\n * autofill, but you do not have any more semantic information on the intended\n * contents.\n *\n * When set to `off`, you are indicating that this field contains sensitive\n * information, or contents that are never saved, like one-time codes.\n *\n * Alternatively, you can provide value which describes the\n * specific data you would like to be entered into this field during autofill.\n *\n * Learn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.\n *\n * @default 'tel' for PhoneField\n * @default 'email' for EmailField\n * @default 'url' for URLField\n * @default 'on' for everything else\n */\n autocomplete?:\n | AutocompleteField\n | `${AutocompleteSection} ${AutocompleteField}`\n | `${AutocompleteGroup} ${AutocompleteField}`\n | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`\n | 'on'\n | 'off';\n}" + } + }, + "AutocompleteSection": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteSection", + "value": "`section-${string}`", + "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page.", + "isPublicDocs": true + } + }, + "AutocompleteGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteGroup", + "value": "'shipping' | 'billing'", + "description": "The contact information group the autocomplete data should be sourced from.", + "isPublicDocs": true + } + }, + "AutocompleteAddressGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteAddressGroup", + "value": "'fax' | 'home' | 'mobile' | 'pager'", + "description": "The contact information subgroup the autocomplete data should be sourced from.", + "isPublicDocs": true + } + }, + "AnyAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyAutocompleteField", + "value": "'additional-name' | 'address-level1' | 'address-level2' | 'address-level3' | 'address-level4' | 'address-line1' | 'address-line2' | 'address-line3' | 'country-name' | 'country' | 'current-password' | 'email' | 'family-name' | 'given-name' | 'honorific-prefix' | 'honorific-suffix' | 'language' | 'name' | 'new-password' | 'nickname' | 'one-time-code' | 'organization-title' | 'organization' | 'photo' | 'postal-code' | 'sex' | 'street-address' | 'transaction-amount' | 'transaction-currency' | 'url' | 'username' | 'bday-day' | 'bday-month' | 'bday-year' | 'bday' | 'cc-additional-name' | 'cc-expiry-month' | 'cc-expiry-year' | 'cc-expiry' | 'cc-family-name' | 'cc-given-name' | 'cc-name' | 'cc-number' | 'cc-csc' | 'cc-type' | `${AutocompleteAddressGroup} email` | 'impp' | `${AutocompleteAddressGroup} impp` | 'tel' | 'tel-area-code' | 'tel-country-code' | 'tel-extension' | 'tel-local-prefix' | 'tel-local-suffix' | 'tel-local' | 'tel-national' | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`", + "description": "Represents all possible autocomplete field values as defined by the HTML autocomplete specification. These values help browsers provide appropriate autofill suggestions for form fields.\n\nLearn more about [autocomplete values](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete).", + "isPublicDocs": true + } + }, + "FunctionSettingsError": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionSettingsError", + "description": "Represents an error that occurs when saving function settings data.\n\nThese errors are returned when the extension-provided data fails validation or causes issues during the commit process to Shopify's servers. Handle these errors in the `onError` callback to provide feedback to users about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A unique identifier describing the “class” of error. These will match the GraphQL error codes as closely as possible. For example the enums returned by the `metafieldsSet` mutation.\n\nLearn more about [MetafieldsSetUserErrorCode](/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode)." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "'FunctionSettingsError'", + "description": "The error type name, always set to `FunctionSettingsError`.\n\nThis helps identify errors specific to function settings, distinguishing them from other error types." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "stack", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FunctionSettingsError extends Error {\n /**\n * A unique identifier describing the “class” of error. These will match\n * the GraphQL error codes as closely as possible. For example the enums\n * returned by the `metafieldsSet` mutation.\n *\n * Learn more about [MetafieldsSetUserErrorCode](/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode).\n */\n code: string;\n /**\n * The error type name, always set to `FunctionSettingsError`.\n *\n * This helps identify errors specific to function settings, distinguishing them from other error types.\n */\n name: 'FunctionSettingsError';\n}" + } + }, + "BaseTypographyProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseTypographyProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "'ltr' | 'rtl' | 'auto' | ''", + "description": "Indicates the directionality of the element’s text.\n\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n- `auto`: The user agent determines the direction based on the content.\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "fontVariantNumeric", + "value": "'auto' | 'normal' | 'tabular-nums'", + "description": "The rendering style for numbers in the font.\n\n- `auto`: Inherits the setting from the parent element.\n- `normal`: Uses the font's default numeric glyphs.\n- `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n\nLearn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `caution`: Advisory notices that need attention.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `accent`: Highlighted or promotional content.\n- `custom`: Custom styling controlled by your theme.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface BaseTypographyProps {\n /**\n * The color emphasis level that controls visual intensity.\n *\n * - `base`: Primary color for body text, standard UI elements, and general content with good readability.\n * - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n *\n * @default 'base'\n */\n color?: ColorKeyword;\n /**\n * The semantic meaning and color treatment of the component.\n *\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent.\n * - `info`: Informational content or helpful tips.\n * - `success`: Positive outcomes or successful states.\n * - `caution`: Advisory notices that need attention.\n * - `warning`: Important warnings about potential issues.\n * - `critical`: Urgent problems or destructive actions.\n * - `accent`: Highlighted or promotional content.\n * - `custom`: Custom styling controlled by your theme.\n *\n * @default 'auto'\n */\n tone?: ToneKeyword;\n /**\n * The rendering style for numbers in the font.\n *\n * - `auto`: Inherits the setting from the parent element.\n * - `normal`: Uses the font's default numeric glyphs.\n * - `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n *\n * Learn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).\n *\n * @default 'auto'\n */\n fontVariantNumeric?: 'auto' | 'normal' | 'tabular-nums';\n /**\n * The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n *\n * The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n *\n * It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.\n *\n * @default ''\n */\n lang?: string;\n /**\n * Indicates the directionality of the element’s text.\n *\n * - `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n * - `auto`: The user agent determines the direction based on the content.\n * - `ltr`: The languages written from left to right (such as English).\n * - `rtl`: The languages written from right to left (such as Arabic).\n *\n * Learn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).\n *\n * @default ''\n */\n dir?: 'ltr' | 'rtl' | 'auto' | '';\n}" + } + }, + "BlockTypographyProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BlockTypographyProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lineClamp", + "value": "number", + "description": "The maximum number of lines to display before truncating the text content.\n\nLearn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).", + "isOptional": true, + "defaultValue": "Infinity - no truncation is applied" + } + ], + "value": "export interface BlockTypographyProps {\n /**\n * The maximum number of lines to display before truncating the text content.\n *\n * Learn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).\n *\n * @default Infinity - no truncation is applied\n */\n lineClamp?: number;\n}" + } + }, + "BaseImageProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseImageProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true, + "defaultValue": "``" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes.\n\nLearn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. This overrides the `src` property.\n\nLearn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset).", + "isOptional": true + } + ], + "value": "export interface BaseImageProps {\n /**\n * Alternative text that describes the image for accessibility.\n *\n * Provides a text description of the image for users with assistive technology\n * and serves as a fallback when the image fails to load. A well-written description\n * enables people with visual impairments to understand non-text content.\n *\n * When a screen reader encounters an image, it reads this description aloud.\n * When an image fails to load, this text displays on screen, helping all users\n * understand what content was intended.\n *\n * Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4)\n * and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).\n *\n * @default ``\n */\n alt?: string;\n /**\n * A set of media conditions and their corresponding sizes.\n *\n * Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).\n */\n sizes?: string;\n /**\n * The image source (either a remote URL or a local file resource).\n *\n * When the image is loading or no `src` is provided, a placeholder is rendered.\n *\n * @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be\n * reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare.\n *\n * Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).\n */\n src?: string;\n /**\n * A set of image sources and their width or pixel density descriptors. This overrides the `src` property.\n *\n * Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset).\n */\n srcSet?: string;\n}" + } + }, + "MoneyAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MoneyAutocompleteField", + "value": "'transaction-amount'", + "description": "Represents autocomplete values that are valid for money/currency input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for monetary inputs.", + "isPublicDocs": true + } + }, + "ParagraphType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ParagraphType", + "value": "'paragraph' | 'small'", + "description": "", + "isPublicDocs": true + } + }, + "PaginationProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PaginationProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hasNextPage", + "value": "boolean", + "description": "Whether there's an additional page of data.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hasPreviousPage", + "value": "boolean", + "description": "Whether there's a previous page of data.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table. When `true`, the table might be in an inert state that prevents user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onNextPage", + "value": "(event: Event) => void", + "description": "A callback fired when the next page button is clicked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onPreviousPage", + "value": "(event: Event) => void", + "description": "A callback fired when the previous page button is clicked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paginate", + "value": "boolean", + "description": "Whether to use pagination controls.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PaginationProps {\n /**\n * Whether to use pagination controls.\n *\n * @default false\n */\n paginate?: boolean;\n /**\n * A callback fired when the previous page button is clicked.\n */\n onPreviousPage?: (event: Event) => void;\n /**\n * A callback fired when the next page button is clicked.\n */\n onNextPage?: (event: Event) => void;\n /**\n * Whether there's an additional page of data.\n *\n * @default false\n */\n hasNextPage?: boolean;\n /**\n * Whether there's a previous page of data.\n *\n * @default false\n */\n hasPreviousPage?: boolean;\n /**\n * Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table.\n * When `true`, the table might be in an inert state that prevents user interaction.\n *\n * @default false\n */\n loading?: boolean;\n}" + } + }, + "TextType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextType", + "value": "'address' | 'redundant' | 'mark' | 'emphasis' | 'offset' | 'strong' | 'small' | 'generic'", + "description": "Defines the semantic type and styling treatment for text content. Each type maps to appropriate HTML elements and applies specific styling for different contexts.", + "isPublicDocs": true + } + }, + "URLAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "URLAutocompleteField", + "value": "'url' | 'photo' | 'impp' | 'home impp' | 'mobile impp' | 'fax impp' | 'pager impp'", + "description": "Represents autocomplete values that are valid for URL input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for URL inputs.\n\nAvailable values:\n- `url` - General URL or web address\n- `photo` - URL to a photo or image\n- `impp` - Instant messaging protocol URL\n- `home impp` - Home instant messaging protocol URL\n- `mobile impp` - Mobile instant messaging protocol URL\n- `fax impp` - Fax instant messaging protocol URL\n- `pager impp` - Pager instant messaging protocol URL", + "isPublicDocs": true + } + }, + "Key": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Key", + "value": "string | number | any", + "description": "Represents a unique key for identifying elements in lists. Can be a string, number, or any other value.", + "isPublicDocs": true + } + }, + "RefCallback": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "RefCallback", + "description": "Represents a callback function that receives a reference to a DOM element or component instance. Called when the element is mounted or unmounted.", + "isPublicDocs": true, + "params": [ + { + "name": "instance", + "description": "", + "value": "T", + "filePath": "src/surfaces/admin/components.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/components.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(instance: T | null) => void" + } + }, + "Ref": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Ref", + "value": "RefObject | RefCallback | null", + "description": "Represents a reference to a DOM element or component instance. Can be either a ref object, callback function, or null.", + "isPublicDocs": true + } + }, + "RefObject": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "RefObject", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "current", + "value": "T | null", + "description": "The current value of the ref, which holds a reference to the DOM element or component instance. Will be `null` if the element is not yet mounted or has been unmounted." + } + ], + "value": "export interface RefObject {\n /**\n * The current value of the ref, which holds a reference to the DOM element or component instance.\n * Will be `null` if the element is not yet mounted or has been unmounted.\n */\n current: T | null;\n}" + } + }, + "ComponentChild": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentChild", + "value": "VNode | object | string | number | bigint | boolean | null | undefined", + "description": "Represents a single child element that can be rendered, including VNodes, primitives, or null/undefined values.", + "isPublicDocs": true + } + }, + "VNode": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "VNode", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "endTime", + "value": "number", + "description": "The time that the rendering of this `vnode` was completed. Will only be set when the devtools are attached. Default value: `-1`", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "Key", + "description": "A unique key used to identify this element in lists for efficient reconciliation." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "props", + "value": "P & { children: ComponentChildren$1; }", + "description": "The properties passed to this component or element, including children." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "Ref | null", + "description": "A ref to the element, which is not guaranteed by React.ReactElement. For compatibility reasons with popular react libs we define it as optional too.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "startTime", + "value": "number", + "description": "The time this `vnode` started rendering. Will only be set when the devtools are attached. Default value: `0`", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "ComponentType

| string", + "description": "The component type or HTML element tag name that this VNode represents." + } + ], + "value": "export interface VNode

{\n /**\n * The component type or HTML element tag name that this VNode represents.\n */\n type: ComponentType

| string;\n /**\n * The properties passed to this component or element, including children.\n */\n props: P & {\n children: ComponentChildren$1;\n };\n /**\n * A unique key used to identify this element in lists for efficient reconciliation.\n */\n key: Key;\n /**\n * A ref to the element, which is not guaranteed by React.ReactElement. For compatibility reasons with popular react libs we define it as optional too.\n */\n ref?: Ref | null;\n /**\n * The time this `vnode` started rendering. Will only be set when\n * the devtools are attached.\n * Default value: `0`\n */\n startTime?: number;\n /**\n * The time that the rendering of this `vnode` was completed. Will only be\n * set when the devtools are attached.\n * Default value: `-1`\n */\n endTime?: number;\n}" + } + }, + "ComponentType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentType", + "value": "ComponentClass

| FunctionComponent

", + "description": "Represents any valid component type, either a class component or a function component.", + "isPublicDocs": true + } + }, + "ComponentClass": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ComponentClass", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "contextType", + "value": "Context", + "description": "The context type this component can consume. When set, the component will have access to this context's value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

", + "description": "The default values for props that will be used when props are not explicitly provided to component instances.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component class, used in debugging and dev tools.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "getDerivedStateFromError", + "value": "(error: any) => Partial", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "getDerivedStateFromProps", + "value": "(props: Readonly

, state: Readonly) => Partial", + "description": "", + "isOptional": true + } + ], + "value": "export interface ComponentClass

{\n new (props: P, context?: any): Component;\n /**\n * A human-readable name for this component class, used in debugging and dev tools.\n */\n displayName?: string;\n /**\n * The default values for props that will be used when props are not explicitly provided to component instances.\n */\n defaultProps?: Partial

;\n /**\n * The context type this component can consume. When set, the component will have access to this context's value.\n */\n contextType?: Context;\n getDerivedStateFromProps?(\n props: Readonly

,\n state: Readonly,\n ): Partial | null;\n getDerivedStateFromError?(error: any): Partial | null;\n}" + } + }, + "Context": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Context", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "Consumer", + "value": "Consumer", + "description": "A component that consumes the context value and re-renders when it changes." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "T", + "description": "The default value for this context, used when no Provider is found in the component tree." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this context, used in debugging and dev tools.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "Provider", + "value": "Provider", + "description": "A component that provides the context value to its descendants." + } + ], + "value": "export interface Context {\n /**\n * The default value for this context, used when no Provider is found in the component tree.\n */\n readonly defaultValue: T;\n}" + } + }, + "Consumer": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Consumer", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component, used in debugging and dev tools.", + "isOptional": true + } + ], + "value": "export interface Consumer\n extends FunctionComponent<{\n /**\n * A render function that receives the current context value and returns elements to render.\n * This function is called whenever the context value changes, allowing components to re-render with the updated value.\n */\n children: (value: T) => ComponentChildren$1;\n }> {}" + } + }, + "Provider": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Provider", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component, used in debugging and dev tools.", + "isOptional": true + } + ], + "value": "export interface Provider\n extends FunctionComponent<{\n /**\n * The context value to provide to consuming components.\n */\n value: T;\n /**\n * The child components that will have access to this context value.\n */\n children?: ComponentChildren$1;\n }> {}" + } + }, + "FunctionComponent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionComponent", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component, used in debugging and dev tools.", + "isOptional": true + } + ], + "value": "export interface FunctionComponent

{\n (props: RenderableProps

, context?: any): ComponentChildren$1;\n /**\n * A human-readable name for this component, used in debugging and dev tools.\n */\n displayName?: string;\n /**\n * The default values for props that will be used when props are not explicitly provided.\n */\n defaultProps?: Partial

| undefined;\n}" + } + }, + "ErrorInfo": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ErrorInfo", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "componentStack", + "value": "string", + "description": "A string representation of the component stack trace at the point where an error occurred. Useful for debugging to understand which components were rendering when the error happened.", + "isOptional": true + } + ], + "value": "export interface ErrorInfo {\n /**\n * A string representation of the component stack trace at the point where an error occurred.\n * Useful for debugging to understand which components were rendering when the error happened.\n */\n componentStack?: string;\n}" + } + }, + "RenderableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RenderableProps", + "value": "P & Readonly<\n Attributes & {\n /**\n * The child elements to be rendered within this component.\n */\n children?: ComponentChildren$1;\n /**\n * A reference to the DOM element or component instance, allowing direct access to the underlying element.\n */\n ref?: Ref;\n }\n >", + "description": "Represents the props that can be rendered by a component, combining custom props with standard attributes like children and ref.", + "isPublicDocs": true + } + }, + "Attributes": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Attributes", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "jsx", + "value": "boolean | undefined", + "description": "An internal flag indicating whether this element was created using JSX syntax.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "Key | undefined", + "description": "A unique key used to identify this element in lists for efficient reconciliation during re-renders.", + "isOptional": true + } + ], + "value": "export interface Attributes {\n /**\n * A unique key used to identify this element in lists for efficient reconciliation during re-renders.\n */\n key?: Key | undefined;\n /**\n * An internal flag indicating whether this element was created using JSX syntax.\n */\n jsx?: boolean | undefined;\n}" + } + }, + "Component": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Component", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "state", + "value": "Readonly", + "description": "The current state of the component." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "props", + "value": "RenderableProps", + "description": "The props passed to this component." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "context", + "value": "any", + "description": "The context value this component can access if a contextType is specified." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "base", + "value": "Element | Text", + "description": "The underlying DOM element or text node that this component rendered." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setState", + "value": "(state: Partial | ((prevState: Readonly, props: Readonly

) => Partial | Pick) | Pick, callback?: () => void) => void", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "forceUpdate", + "value": "(callback?: () => void) => void", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "render", + "value": "(props?: RenderableProps, state?: Readonly, context?: any) => ComponentChildren$1", + "description": "" + } + ], + "value": "declare abstract class Component {\n constructor(props?: P, context?: any);\n static displayName?: string;\n static defaultProps?: any;\n static contextType?: Context;\n // Static members cannot reference class type parameters. This is not\n // supported in TypeScript. Reusing the same type arguments from `Component`\n // will lead to an impossible state where one cannot satisfy the type\n // constraint under no circumstances, see #1356.In general type arguments\n // seem to be a bit buggy and not supported well at the time of this\n // writing with TS 3.3.3333.\n static getDerivedStateFromProps?(\n props: Readonly,\n state: Readonly,\n ): object | null;\n\n static getDerivedStateFromError?(error: any): object | null;\n /**\n * The current state of the component.\n */\n state: Readonly;\n /**\n * The props passed to this component.\n */\n props: RenderableProps

;\n /**\n * The context value this component can access if a contextType is specified.\n */\n context: any;\n /**\n * The underlying DOM element or text node that this component rendered.\n */\n base?: Element | Text;\n // From https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e836acc75a78cf0655b5dfdbe81d69fdd4d8a252/types/react/index.d.ts#L402\n // // We MUST keep setState() as a unified signature because it allows proper checking of the method return type.\n // // See: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/18365#issuecomment-351013257\n setState(\n state:\n | ((\n prevState: Readonly,\n props: Readonly

,\n ) => Pick | Partial | null)\n | (Pick | Partial | null),\n callback?: () => void,\n ): void;\n\n forceUpdate(callback?: () => void): void;\n abstract render(\n props?: RenderableProps

,\n state?: Readonly,\n context?: any,\n ): ComponentChildren$1;\n}" + } + }, + "Styles": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Styles", + "value": "string", + "description": "Represents CSS styles as a string, typically used for inline styles or style injection.", + "isPublicDocs": true + } + }, + "RenderImpl": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RenderImpl", + "value": "Omit & {\n ShadowRoot: (element: any) => ComponentChildren;\n styles?: Styles;\n}", + "description": "Represents the implementation details for rendering components within a shadow DOM. Extends `ShadowRootInit` with a render function and optional styles.", + "isPublicDocs": true + } + }, + "CallbackEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackEvent", + "value": "Event & {\n currentTarget: HTMLElementTagNameMap[T];\n}", + "description": "An event object with a strongly-typed `currentTarget` property that references the specific HTML element that triggered the event.\n\nThis type extends the standard DOM `Event` interface and ensures type safety when accessing the element that fired the event.", + "isPublicDocs": true + } + }, + "CallbackToggleEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackToggleEvent", + "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", + "description": "A toggle event with a strongly-typed `currentTarget` property. Extends the `ToggleEvent` interface with type-safe access to the element that triggered the toggle.", + "isPublicDocs": true + } + }, + "CallbackEventListener": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackEventListener", + "value": "(EventListener & {\n (event: CallbackEvent): void;\n }) | null", + "description": "A function that handles events from UI components.\n\nThis type represents an event listener callback that receives a `CallbackEvent` with a strongly-typed `currentTarget`. Use this for component event handlers like `click`, `focus`, `blur`, and other DOM events.", + "isPublicDocs": true + } + }, + "CallbackErrorEventListener": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackErrorEventListener", + "value": "(EventListener & {\n (\n event: CallbackEvent & {\n error: TError;\n },\n ): void;\n }) | null", + "description": "A function that handles error events from UI components. This type represents an event listener callback that receives both the event and an error object.", + "isPublicDocs": true + } + }, + "CallbackExtendableEventListener": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackExtendableEventListener", + "value": "(EventListener & {\n (event: CallbackExtendableEvent): void;\n }) | null", + "description": "A function that handles extendable events from UI components. This type represents an event listener callback that can use `waitUntil` to extend the event lifetime.", + "isPublicDocs": true + } + }, + "CallbackExtendableEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "CallbackExtendableEvent", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "waitUntil", + "value": "(promise: Promise) => void", + "description": "A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.\n\nCan be called multiple times to add promises to the event, but must be called synchronously during event dispatch. Cannot be called after a `setTimeout` or within a microtask.", + "isOptional": true + } + ], + "value": "export interface CallbackExtendableEvent<\n TTagName extends keyof HTMLElementTagNameMap,\n> extends CallbackEvent,\n Pick {}" + } + }, + "PreactBaseElementProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PreactBaseElementProps", + "description": "Base props for Preact custom elements without children support. Includes common properties like key, ref, and slot for elements that don't accept child content.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "preact.Key", + "description": "A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists. Essential for maintaining component state and optimizing re-renders when lists change.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "preact.Ref", + "description": "A reference to access the underlying DOM element directly. Typically created using `useRef()` to interact with the element imperatively or measure its properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "Lowercase", + "description": "The named slot to which this element is assigned in the parent component's shadow DOM.\n\nUsed for advanced component composition with web components.", + "isOptional": true + } + ], + "value": "export interface PreactBaseElementProps {\n /**\n * A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.\n * Essential for maintaining component state and optimizing re-renders when lists change.\n */\n key?: preact.Key;\n /**\n * A reference to access the underlying DOM element directly.\n * Typically created using `useRef()` to interact with the element imperatively or measure its properties.\n */\n ref?: preact.Ref;\n /**\n * The named slot to which this element is assigned in the parent component's shadow DOM.\n *\n * Used for advanced component composition with web components.\n */\n slot?: Lowercase;\n}" + } + }, + "PreactBaseElementPropsWithChildren": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PreactBaseElementPropsWithChildren", + "description": "Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "preact.ComponentChildren", + "description": "The child elements to be rendered within this component.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "preact.Key", + "description": "A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists. Essential for maintaining component state and optimizing re-renders when lists change.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "preact.Ref", + "description": "A reference to access the underlying DOM element directly. Typically created using `useRef()` to interact with the element imperatively or measure its properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "Lowercase", + "description": "The named slot to which this element is assigned in the parent component's shadow DOM.\n\nUsed for advanced component composition with web components.", + "isOptional": true + } + ], + "value": "export interface PreactBaseElementPropsWithChildren\n extends PreactBaseElementProps {\n /**\n * The child elements to be rendered within this component.\n */\n children?: preact.ComponentChildren;\n}" + } + }, + "RequiredBannerProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredBannerProps", + "value": "Required", + "description": "Represents the banner component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The main message content displayed within the banner, providing important information or guidance to users.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "collapsible", + "value": "boolean", + "description": "Whether the banner content can be collapsed. When true, child elements are initially hidden but can be revealed by the user expanding the banner.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "dismissible", + "value": "boolean", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event fires, then `hidden` is set to `true`, any animation completes, and the `afterhide` event fires.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the banner.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property will be `true` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "(event: Event) => void", + "description": "A callback fired when the banner is dismissed by the user clicking the close button. Does not fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "MakeResponsive": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MakeResponsive", + "value": "T | `@container${string}`", + "description": "Makes a type responsive by allowing it to be either the base value or a container query string. This enables conditional styling based on container dimensions.", + "isPublicDocs": true + } + }, + "MakeResponsivePick": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MakeResponsivePick", + "value": "{\n [P in TProperty]: MakeResponsive;\n}", + "description": "Makes a property's value potentially responsive.", + "isPublicDocs": true + } + }, + "RequiredBoxProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredBoxProps", + "value": "Required", + "description": "Represents the box component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ResponsiveBoxProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResponsiveBoxProps", + "value": "MakeResponsivePick<\n RequiredBoxProps,\n | 'padding'\n | 'paddingBlock'\n | 'paddingBlockStart'\n | 'paddingBlockEnd'\n | 'paddingInline'\n | 'paddingInlineStart'\n | 'paddingInlineEnd'\n | 'display'\n>", + "description": "Represents box props with responsive capabilities for layout properties.\n\nThis enables conditional styling based on container queries.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ButtonOnlyProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ButtonOnlyProps", + "value": "", + "description": "Represents button props that are specific to button-type elements only. Extracts the subset of `ButtonProps` that includes the `type` property.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The label text or elements displayed inside the button component, describing the action that will be performed when clicked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconType | AnyString", + "description": "An icon displayed inside the button, typically positioned before the button text. Use icons to help users quickly identify the button's action or to improve scannability. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The displayed inline width of the button.\n\n- `auto`: the size of the button depends on the surface and context.\n- `fill`: the button will takes up 100% of the available inline size.\n- `fit-content`: the button will take up the minimum inline-size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary' | 'tertiary'", + "description": "The visual appearance of the button component.\n\n- `auto`: The variant is automatically determined by the button component's context.\n- `primary`: High emphasis button for the primary action on the page. Should be used sparingly.\n- `secondary`: Medium emphasis button for secondary actions.\n- `tertiary`: Low emphasis button for less important actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "ButtonBaseProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ButtonBaseProps", + "value": "Required<\n Pick<\n ButtonOnlyProps,\n | 'accessibilityLabel'\n | 'disabled'\n | 'command'\n | 'commandFor'\n | 'icon'\n | 'interestFor'\n | 'lang'\n | 'loading'\n | 'type'\n | 'tone'\n | 'variant'\n | 'target'\n | 'href'\n | 'download'\n >\n>", + "description": "Represents the base button props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconType | AnyString", + "description": "An icon displayed inside the button, typically positioned before the button text. Use icons to help users quickly identify the button's action or to improve scannability. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary' | 'tertiary'", + "description": "The visual appearance of the button component.\n\n- `auto`: The variant is automatically determined by the button component's context.\n- `primary`: High emphasis button for the primary action on the page. Should be used sparingly.\n- `secondary`: Medium emphasis button for secondary actions.\n- `tertiary`: Low emphasis button for less important actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "PreactInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PreactInputProps", + "value": "Required<\n Pick\n>", + "description": "Represents the essential input props required for Preact-based input elements. Includes properties like `disabled`, `id`, `name`, and `value`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ] + } + }, + "ClickableBaseProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ClickableBaseProps", + "value": "Required<\n Pick<\n ClickableProps$1,\n | 'command'\n | 'commandFor'\n | 'interestFor'\n | 'disabled'\n | 'download'\n | 'href'\n | 'lang'\n | 'loading'\n | 'overflow'\n | 'target'\n | 'type'\n >\n>", + "description": "Represents the base clickable props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the component is disabled, preventing clicks and focus. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You shouldapply disabled styling as needed.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content.\n\nUse this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the component is in a loading state, which indicates to assistive technology that an action is in progress and prevents interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ] + } + }, + "PreactFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PreactFieldProps", + "value": "PreactInputProps & Required<\n Pick<\n TextFieldProps$1,\n | 'defaultValue'\n | 'details'\n | 'error'\n | 'label'\n | 'labelAccessibilityVisibility'\n | 'placeholder'\n | 'readOnly'\n | 'required'\n >\n > & {\n /**\n * Controls browser autofill behavior for the field.\n *\n * Basic values:\n * - `on` - Enables autofill without specifying content type (default)\n * - `off` - Disables autofill for sensitive data or one-time codes\n *\n * Specific field values describe the expected data type. You can optionally prefix these with:\n * - `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n * - `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n * - Both section and group (for example, `section-primary shipping email`)\n *\n * Providing a specific autofill token helps browsers suggest more relevant saved data.\n *\n * Learn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.\n *\n * @default 'tel' for PhoneField\n * @default 'email' for EmailField\n * @default 'url' for URLField\n * @default 'on' for everything else\n */\n autocomplete: Autocomplete;\n }", + "description": "Represents the props for Preact-based form field components with autocomplete support. The generic type parameter allows specifying the valid autocomplete values for the field.", + "isPublicDocs": true + } + }, + "TextFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextFieldProps", + "value": "PreactFieldProps<\n /** @default 'on' */\n Required['autocomplete']\n> & Required<\n Pick<\n TextFieldProps$1,\n 'icon' | 'maxLength' | 'minLength' | 'prefix' | 'suffix'\n >\n >", + "description": "Represents the props for text input field components. Extends `PreactFieldProps` with autocomplete support for text-related fields.", + "isPublicDocs": true + } + }, + "ColorFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColorFieldProps", + "value": "Omit<\n PreactFieldProps['autocomplete']>,\n 'value' | 'defaultValue'\n> & Required>", + "description": "Represents the props for color input field components. Extends `PreactFieldProps` with autocomplete support for color-related fields.", + "isPublicDocs": true + } + }, + "ReplaceType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReplaceType", + "value": "Exclude | TTo", + "description": "A utility type that replaces occurrences of one type with another within a union type. Useful for type transformations where you need to swap out specific types.", + "isPublicDocs": true + } + }, + "EmailFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "EmailFieldProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required>", + "description": "Represents the props for email input field components. Extends `PreactFieldProps` with autocomplete support for email-related fields.", + "isPublicDocs": true + } + }, + "RequiredAlignedProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredAlignedProps", + "value": "Required", + "description": "Represents the grid component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive", + "description": "The vertical alignment of the entire grid within its container (in horizontal layouts).\n\nUse this to distribute grid rows along the block axis (vertical in left-to-right/right-to-left layouts, horizontal in vertical writing modes). This property overrides the block value set by `placeContent`.\n\nLearn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive", + "description": "The vertical alignment of grid items within their grid areas (in horizontal layouts).\n\nUse this to position items along the block axis (vertical in left-to-right/right-to-left layouts, horizontal in vertical writing modes). This property overrides the block value set by `placeItems`.\n\nLearn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateColumns", + "value": "MaybeResponsive", + "description": "The columns in the grid and their sizes.\n\nUse values like `1fr 2fr` to create fluid columns, `200px 1fr` to mix fixed and flexible columns, or `repeat(3, 1fr)` to create equal-width columns.\n\nLearn more about the [grid-template-columns property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateRows", + "value": "MaybeResponsive", + "description": "The rows in the grid and their sizes.\n\nUse values like `100px auto` to create rows with fixed and automatic heights, or `repeat(3, 100px)` to create equal-height rows.\n\nLearn more about the [grid-template-rows property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive", + "description": "The horizontal alignment of the entire grid within its container (in horizontal layouts).\n\nUse this to distribute grid columns along the inline axis (horizontal in left-to-right/right-to-left layouts, vertical in vertical writing modes). This property overrides the inline value set by `placeContent`.\n\nLearn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "justifyItems", + "value": "MaybeResponsive", + "description": "The horizontal alignment of grid items within their grid areas (in horizontal layouts).\n\nUse this to position items along the inline axis (horizontal in left-to-right/right-to-left layouts, vertical in vertical writing modes). This property overrides the inline value set by `placeItems`.\n\nLearn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeContent", + "value": "MaybeResponsive<\n `${AlignContentKeyword} ${JustifyContentKeyword}` | AlignContentKeyword\n >", + "description": "A shorthand property for `justify-content` and `align-content`.\n\nLearn more about the [place-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-content).", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeItems", + "value": "MaybeResponsive<\n `${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword\n >", + "description": "A shorthand for setting both `justify-items` and `align-items` in a single declaration.\n\nAccepts either a single value (applied to both axes) or two space-separated values (align-items justify-items).\n\nLearn more about the [place-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-items).", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ResponsiveGridProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResponsiveGridProps", + "value": "MakeResponsivePick<\n RequiredAlignedProps,\n 'rowGap' | 'columnGap' | 'gap' | 'gridTemplateColumns' | 'gridTemplateRows'\n>", + "description": "Represents grid props with responsive capabilities for layout properties.\n\nThis enables conditional styling based on container queries.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateColumns", + "value": "MaybeResponsive", + "description": "The columns in the grid and their sizes.\n\nUse values like `1fr 2fr` to create fluid columns, `200px 1fr` to mix fixed and flexible columns, or `repeat(3, 1fr)` to create equal-width columns.\n\nLearn more about the [grid-template-columns property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateRows", + "value": "MaybeResponsive", + "description": "The rows in the grid and their sizes.\n\nUse values like `100px auto` to create rows with fixed and automatic heights, or `repeat(3, 100px)` to create equal-height rows.\n\nLearn more about the [grid-template-rows property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "RequiredGridItemProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredGridItemProps", + "value": "Required", + "description": "Represents the grid item component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridColumn", + "value": "`span ${number}` | 'auto'", + "description": "The number of columns the item will span across.\n\nLearn more about the [grid-column property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridRow", + "value": "`span ${number}` | 'auto'", + "description": "The number of rows the item will span across.\n\nLearn more about the [grid-row property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "RequiredLinkProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredLinkProps", + "value": "Required", + "description": "Represents the link component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The text or elements displayed within the link component, which navigates users to a different location when activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "LinkBaseProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "LinkBaseProps", + "value": "Required<\n Pick<\n LinkProps$1,\n | 'accessibilityLabel'\n | 'command'\n | 'commandFor'\n | 'interestFor'\n | 'download'\n | 'href'\n | 'lang'\n | 'target'\n | 'tone'\n >\n>", + "description": "Represents the base link props with all core properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "PolyfillCommandEventInit": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PolyfillCommandEventInit", + "value": "EventInit & {\n source: HTMLElement | null | undefined;\n command: PreactOverlayControlProps['command'];\n}", + "description": "Represents the initialization object for creating a polyfill command event. Used for overlay control commands in environments that require polyfills.", + "isPublicDocs": true + } + }, + "PreactOverlayControlProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PreactOverlayControlProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information." + } + ], + "value": "export interface PreactOverlayControlProps\n extends Pick {\n /**\n * The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the visibility of the target component.\n *\n * @default '--auto'\n */\n command: Extract<\n InteractionProps['command'],\n '--show' | '--hide' | '--toggle' | '--auto'\n >;\n /**\n * The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.\n */\n commandFor: Extract;\n /**\n * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.\n */\n interestFor: Extract;\n}" + } + }, + "PolyfillCommandEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PolyfillCommandEvent", + "value": "Event & {\n source: PolyfillCommandEventInit['source'];\n command: PolyfillCommandEventInit['command'];\n /** Have to use `_s_shadowSource` because `source` is retargeted to the shadow host by browsers */\n _s_shadowSource: PolyfillCommandEventInit['source'];\n}", + "description": "Represents a polyfill command event for overlay controls. Used in environments where native command events are not available.", + "isPublicDocs": true + } + }, + "RequiredAlignedModalProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredAlignedModalProps", + "value": "Required", + "description": "Represents the modal component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.\n\nThis overrides the `heading` prop for screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterShow", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "Adjust the padding around the modal content.\n\n`base`: applies padding that is appropriate for the element.\n\n`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.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "showOverlay", + "value": "() => void", + "description": "A method to programmatically show the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "SizeKeyword | 'max'", + "description": "Adjust the size of the modal.\n\n`max`: expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "toggleOverlay", + "value": "() => void", + "description": "A method to programmatically toggle the visibility of the overlay." + } + ] + } + }, + "ContextCallback": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ContextCallback", + "description": "A callback which is provided by a context requester and is called with the value satisfying the request. This callback can be called multiple times by context providers as the requested value is changed.", + "isPublicDocs": true, + "params": [ + { + "name": "value", + "description": "", + "value": "T", + "filePath": "src/surfaces/admin/components.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/components.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(value: T) => void" + } + }, + "RequiredMoneyFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredMoneyFieldProps", + "value": "Required", + "description": "Represents the money field component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "| AutocompleteField\n | `${AutocompleteSection} ${AutocompleteField}`\n | `${AutocompleteGroup} ${AutocompleteField}`\n | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`\n | 'on'\n | 'off'", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on' for everything else" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "controls", + "value": "'auto' | 'stepper' | 'none'", + "description": "The type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ] + } + }, + "PasswordFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PasswordFieldProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required<\n Pick<\n PasswordFieldProps$1,\n | 'defaultValue'\n | 'details'\n | 'disabled'\n | 'error'\n | 'labelAccessibilityVisibility'\n | 'minLength'\n | 'maxLength'\n | 'label'\n | 'name'\n | 'placeholder'\n | 'readOnly'\n | 'required'\n | 'value'\n >\n >", + "description": "Represents the props for password input field components. Extends `PreactFieldProps` with autocomplete support for password-related fields.", + "isPublicDocs": true + } + }, + "Popover": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Popover", + "description": "Configure the following properties on the popover component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Popover\n extends PreactPopoverElement\n implements PopoverProps\n{\n constructor();\n}" + } + }, + "SearchFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SearchFieldProps", + "value": "PreactFieldProps<\n /**\n * @default 'on'\n */\n Required['autocomplete']\n> & Required<\n Pick<\n TextFieldProps$1,\n | 'defaultValue'\n | 'details'\n | 'disabled'\n | 'error'\n | 'labelAccessibilityVisibility'\n | 'minLength'\n | 'maxLength'\n | 'label'\n | 'name'\n | 'placeholder'\n | 'readOnly'\n | 'required'\n | 'value'\n >\n >", + "description": "Represents the props for search input field components. Extends `PreactFieldProps` for search-specific functionality.", + "isPublicDocs": true + } + }, + "RequiredSectionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredSectionProps", + "value": "Required", + "description": "Represents the section component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "The padding applied to all edges of the element.\n\n- `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context.\n- `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.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + } + ] + } + }, + "AlignedStackProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AlignedStackProps", + "value": "Required", + "description": "Represents the stack component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive", + "description": "The alignment of multiple lines of content along the stack component's cross axis.\n\nThis only applies when content wraps to multiple lines (typically in inline direction).\n\nLearn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive", + "description": "The alignment of individual children along the stack component's cross axis (perpendicular to the stacking direction).\n\nFor example, in a vertical stack (block direction), this controls horizontal alignment of each child.\n\nLearn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "MaybeResponsive<'block' | 'inline'>", + "description": "The direction in which children are arranged within the stack.\n\n- `block`: Arranges children vertically in a column (in horizontal writing modes). Children will not wrap.\n- `inline`: Arranges children horizontally in a row (in horizontal writing modes). Children will wrap to the next line if needed.\n\nThis uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values) to ensure proper behavior across different writing modes.", + "isOptional": true, + "defaultValue": "'block'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive", + "description": "The distribution of children along the stack component's main axis (the direction of stacking).\n\nFor example, in a vertical stack (block direction), this controls vertical distribution. Use this to space out children or align them to the start, center, or end.\n\nLearn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ResponsiveStackProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResponsiveStackProps", + "value": "MakeResponsivePick<\n AlignedStackProps,\n 'gap' | 'rowGap' | 'columnGap' | 'direction'\n>", + "description": "Represents stack props with responsive capabilities for layout properties.\n\nThis enables conditional styling based on container queries.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "MaybeResponsive<'block' | 'inline'>", + "description": "The direction in which children are arranged within the stack.\n\n- `block`: Arranges children vertically in a column (in horizontal writing modes). Children will not wrap.\n- `inline`: Arranges children horizontally in a row (in horizontal writing modes). Children will wrap to the next line if needed.\n\nThis uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values) to ensure proper behavior across different writing modes.", + "isOptional": true, + "defaultValue": "'block'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "TextAreaProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextAreaProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required>", + "description": "Represents the props for textarea components. Extends `PreactFieldProps` for multi-line text input functionality.", + "isPublicDocs": true + } + }, + "URLFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "URLFieldProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required>", + "description": "Represents the props for URL input field components. Extends `PreactFieldProps` with autocomplete support for URL-related fields.", + "isPublicDocs": true + } + }, + "AdminActionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminActionProps", + "description": "Configure the following properties on the admin action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The text to use as the action modal's title. If not provided, the name of the extension will be used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the action is in a loading state, such as during initial page load or when the action is being opened. When `true`, the action is in an inert state that prevents user interaction.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface AdminActionProps\n extends Pick {}" + } + }, + "AdminBlockProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminBlockProps", + "description": "Configure the following properties on the admin block component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "collapsedSummary", + "value": "string", + "description": "The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The text displayed as the block's title in the header. If not provided, the extension name will be used.", + "isOptional": true + } + ], + "value": "export interface AdminBlockProps\n extends Pick {}" + } + }, + "AdminPrintActionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminPrintActionProps", + "description": "Configure the following properties on the admin print action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The URL of the document to preview and print. Supports HTML, PDF, and image formats. If not provided, the preview will show an empty state and the print button will be disabled.", + "isOptional": true + } + ], + "value": "export interface AdminPrintActionProps\n extends Pick {}" + } + }, + "FunctionSettingsErrorEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "FunctionSettingsErrorEvent", + "value": "AggregateErrorEvent", + "description": "Represents the event type for function settings errors. Extracted from the parameters of the `onFunctionSettingsError` callback.", + "isPublicDocs": true + } + }, + "AvatarEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AvatarEvents", + "description": "The avatar component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "OnErrorEventHandler", + "description": "A callback fired when the avatar image fails to load.\n\nLearn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "load", + "value": "CallbackEventListener | null", + "description": "A callback fired when the avatar image successfully loads.\n\nLearn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).", + "isOptional": true + } + ], + "value": "export interface AvatarEvents {\n /**\n * A callback fired when the avatar image successfully loads.\n *\n * Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).\n */\n load: CallbackEventListener | null = null;\n /**\n * A callback fired when the avatar image fails to load.\n *\n * Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).\n */\n error: OnErrorEventHandler = null;\n}" + } + }, + "BadgeSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BadgeSlots", + "description": "The badge component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text label displayed within the badge component, typically a short status indicator or category label.", + "isOptional": true + } + ], + "value": "export interface BadgeSlots {\n /**\n * The text label displayed within the badge component, typically a short status indicator or category label.\n */\n children?: HTMLElement;\n}" + } + }, + "BannerEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BannerEvents", + "description": "The banner component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the banner is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "dismiss", + "value": "CallbackEventListener | null", + "description": "A callback fired when the banner is dismissed.", + "isOptional": true + } + ], + "value": "export interface BannerEvents {\n /**\n * A callback fired when the banner is dismissed.\n */\n dismiss: CallbackEventListener | null = null;\n /**\n * A callback fired after the banner is hidden.\n */\n afterhide: CallbackEventListener | null = null;\n}" + } + }, + "BannerSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BannerSlots", + "description": "The banner component supports slots for additional content placement within the banner. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The main message content displayed within the banner component, providing important information or guidance to users.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Action buttons displayed at the bottom of the banner that let users respond to the message. Accepts up to two button components with `variant=\"secondary\"` or `variant=\"auto\"`.", + "isOptional": true + } + ], + "value": "export interface BannerSlots {\n /**\n * The main message content displayed within the banner component, providing important information or guidance to users.\n */\n children?: HTMLElement;\n /**\n * Action buttons displayed at the bottom of the banner that let users respond to the message.\n * Accepts up to two button components with `variant=\"secondary\"` or `variant=\"auto\"`.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "BoxSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BoxSlots", + "description": "The box component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + } + ], + "value": "export interface BoxSlots {\n /**\n * The content displayed within the box component, which serves as a flexible container for organizing and styling other components.\n */\n children?: HTMLElement;\n}" + } + }, + "ButtonEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonEvents", + "description": "The button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener | null", + "description": "A callback fired when the button loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the button is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener | null", + "description": "A callback fired when the button receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface ButtonEvents {\n /**\n * A callback fired when the button is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n /**\n * A callback fired when the button loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener | null = null;\n /**\n * A callback fired when the button receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener | null = null;\n}" + } + }, + "ButtonSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonSlots", + "description": "The button component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The label text or elements displayed inside the button component, describing the action that will be performed when clicked.", + "isOptional": true + } + ], + "value": "export interface ButtonSlots {\n /**\n * The label text or elements displayed inside the button component, describing the action that will be performed when clicked.\n */\n children?: HTMLElement;\n}" + } + }, + "ButtonGroupSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonGroupSlots", + "description": "The button group component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The buttons displayed within the button group component, which are arranged together as a cohesive set of related actions.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action for this group, displayed with high visual emphasis. Accepts a single button with `variant=\"primary\"`.\n\nUse this for the primary action you want users to take. This can't be used when `gap=\"none\"`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Supporting actions displayed with less emphasis than the primary action. Accepts one or more button components with `variant=\"secondary\"` or `variant=\"auto\"`.\n\nUse these for alternative or less critical actions.", + "isOptional": true + } + ], + "value": "export interface ButtonGroupSlots {\n /**\n * The buttons displayed within the button group component, which are arranged together as a cohesive set of related actions.\n */\n children?: HTMLElement;\n /**\n * The main action for this group, displayed with high visual emphasis.\n * Accepts a single button with `variant=\"primary\"`.\n *\n * Use this for the primary action you want users to take. This can't be used when `gap=\"none\"`.\n */\n 'primary-action'?: HTMLElement;\n /**\n * Supporting actions displayed with less emphasis than the primary action.\n * Accepts one or more button components with `variant=\"secondary\"` or `variant=\"auto\"`.\n *\n * Use these for alternative or less critical actions.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "CheckboxEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "CheckboxEvents", + "description": "The checkbox component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the checkbox.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface CheckboxEvents {\n /**\n * A callback fired when the checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the checkbox.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n}" + } + }, + "ChipSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChipSlots", + "description": "The chip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "HTMLElement", + "description": "An optional icon to display at the start of the chip. Accepts only icon components.", + "isOptional": true + } + ], + "value": "export interface ChipSlots {\n /**\n * The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.\n */\n children?: HTMLElement;\n /**\n * An optional icon to display at the start of the chip. Accepts only icon components.\n */\n graphic?: HTMLElement;\n}" + } + }, + "ChoiceSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceSlots", + "description": "The choice list component supports slots for additional content placement within each choice. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The label text or elements that identify this selectable choice to users.\n\nThe label is produced by extracting and concatenating the text nodes from the provided content; any markup or element structure is ignored.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "HTMLElement", + "description": "Additional text to provide context or guidance for the input.\n\nThis text is displayed along with the input and its label to offer more information or instructions to the user.", + "isOptional": true + } + ], + "value": "export interface ChoiceSlots {\n /**\n * The label text or elements that identify this selectable choice to users.\n *\n * The label is produced by extracting and\n * concatenating the text nodes from the provided content;\n * any markup or element structure is ignored.\n */\n children?: HTMLElement;\n /**\n * Additional text to provide context or guidance for the input.\n *\n * This text is displayed along with the input and its label\n * to offer more information or instructions to the user.\n *\n * @implementation this content should be linked to the input with an `aria-describedby` attribute.\n */\n details?: HTMLElement;\n}" + } + }, + "ChoiceListEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceListEvents", + "description": "The choice list component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener | null", + "description": "A callback fired when the choice list selection changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user inputs data into the choice list.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ChoiceListEvents {\n /**\n * A callback fired when the choice list selection changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener | null = null;\n /**\n * A callback fired when the user inputs data into the choice list.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener | null = null;\n}" + } + }, + "ChoiceListSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceListSlots", + "description": "The choice list component supports slots for additional content placement within each choice. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The choices a user can select from.\n\nAccepts choice components.", + "isOptional": true + } + ], + "value": "export interface ChoiceListSlots {\n /**\n * The choices a user can select from.\n *\n * Accepts choice components.\n */\n children?: HTMLElement;\n}" + } + }, + "ClickableEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableEvents", + "description": "The clickable component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener | null", + "description": "A callback fired when the component loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the component is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener | null", + "description": "A callback fired when the component receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface ClickableEvents {\n /**\n * A callback fired when the component is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n /**\n * A callback fired when the component loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener | null = null;\n /**\n * A callback fired when the component receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener | null = null;\n}" + } + }, + "ClickableSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableSlots", + "description": "The clickable component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the clickable component, which makes any content interactive and clickable without the semantic meaning of a button or link.", + "isOptional": true + } + ], + "value": "export interface ClickableSlots {\n /**\n * The content displayed within the clickable component, which makes any content interactive and clickable without the semantic meaning of a button or link.\n */\n children?: HTMLElement;\n}" + } + }, + "ClickableChipEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableChipEvents", + "description": "The clickable chip component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the chip is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the chip is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "remove", + "value": "CallbackEventListener | null", + "description": "A callback fired when the chip is removed.", + "isOptional": true + } + ], + "value": "export interface ClickableChipEvents {\n /**\n * A callback fired when the chip is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n /**\n * A callback fired when the chip is removed.\n */\n remove: CallbackEventListener | null = null;\n /**\n * A callback fired after the chip is hidden.\n */\n afterhide: CallbackEventListener | null = null;\n}" + } + }, + "ClickableChipSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableChipSlots", + "description": "The clickable chip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text label displayed within the chip, which represents an interactive filter, tag, or selectable item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "HTMLElement", + "description": "An optional icon to display at the start of the chip. Accepts only icon components.", + "isOptional": true + } + ], + "value": "export interface ClickableChipSlots {\n /**\n * The text label displayed within the chip, which represents an interactive filter, tag, or selectable item.\n */\n children?: HTMLElement;\n /**\n * An optional icon to display at the start of the chip. Accepts only icon components.\n */\n graphic?: HTMLElement;\n}" + } + }, + "ColorFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorFieldEvents", + "description": "The color field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the color field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the color field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the color field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the color field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ColorFieldEvents {\n /**\n * A callback fired when the color field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the color field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the color field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the color field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "ColorPickerEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorPickerEvents", + "description": "The color picker component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener | null", + "description": "A callback fired when the color picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user inputs data into the color picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ColorPickerEvents {\n /**\n * A callback fired when the color picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener | null = null;\n /**\n * A callback fired when the user inputs data into the color picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener | null = null;\n}" + } + }, + "DateFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DateFieldEvents", + "description": "The date field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the date field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the date field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the date field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the date field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "invalid", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date field value is invalid.\n\nLearn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "viewchange", + "value": "CallbackEventListener | null", + "description": "A callback fired when the calendar view changes (such as when navigating between months).", + "isOptional": true + } + ], + "value": "export interface DateFieldEvents {\n /**\n * A callback fired when the date field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the date field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the date field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the date field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n /**\n * A callback fired when the calendar view changes (such as when navigating between months).\n */\n viewchange: CallbackEventListener | null = null;\n /**\n * A callback fired when the date field value is invalid.\n *\n * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).\n */\n invalid: CallbackEventListener | null = null;\n}" + } + }, + "DatePickerEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DatePickerEvents", + "description": "The date picker component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date picker loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date picker receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user inputs data into the date picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "viewchange", + "value": "CallbackEventListener | null", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", + "isOptional": true + } + ], + "value": "export interface DatePickerEvents {\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewchange: CallbackEventListener | null = null;\n /**\n * A callback fired when the date picker receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener | null = null;\n /**\n * A callback fired when the date picker loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener | null = null;\n /**\n * A callback fired when the user inputs data into the date picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener | null = null;\n /**\n * A callback fired when the date picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener | null = null;\n}" + } + }, + "DropZoneEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DropZoneEvents", + "description": "The drop zone component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the drop zone value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "droprejected", + "value": "CallbackEventListener", + "description": "A callback fired when a dropped file is rejected due to file type or size restrictions.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the drop zone.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface DropZoneEvents {\n /**\n * A callback fired when the drop zone value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener = null;\n /**\n * A callback fired when the user inputs data into the drop zone.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener = null;\n /**\n * A callback fired when a dropped file is rejected due to file type or size restrictions.\n */\n droprejected: CallbackEventListener = null;\n}" + } + }, + "DropZoneSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DropZoneSlots", + "description": "The drop zone component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content to include inside the drop zone container", + "isOptional": true + } + ], + "value": "export interface DropZoneSlots {\n /**\n * The content to include inside the drop zone container\n */\n children?: HTMLElement;\n}" + } + }, + "EmailFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "EmailFieldEvents", + "description": "The email field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the email field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the email field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the email field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the email field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface EmailFieldEvents {\n /**\n * A callback fired when the email field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the email field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the email field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "GridSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "GridSlots", + "description": "The grid component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The child elements displayed within the grid component, which are arranged in a flexible grid layout with configurable columns, rows, and spacing.", + "isOptional": true + } + ], + "value": "export interface GridSlots {\n /**\n * The child elements displayed within the grid component, which are arranged in a flexible grid layout with configurable columns, rows, and spacing.\n */\n children?: HTMLElement;\n}" + } + }, + "GridItemSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "GridItemSlots", + "description": "The grid item component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the grid item component, which represents a single cell in the grid layout and can span multiple columns or rows.", + "isOptional": true + } + ], + "value": "export interface GridItemSlots {\n /**\n * The content displayed within the grid item component, which represents a single cell in the grid layout and can span multiple columns or rows.\n */\n children?: HTMLElement;\n}" + } + }, + "HeadingSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "HeadingSlots", + "description": "The heading component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The heading text displayed within the heading component, which provides a title or section header for content.", + "isOptional": true + } + ], + "value": "export interface HeadingSlots {\n /**\n * The heading text displayed within the heading component, which provides a title or section header for content.\n */\n children?: HTMLElement;\n}" + } + }, + "ImageEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ImageEvents", + "description": "The image component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "OnErrorEventHandler", + "description": "A callback fired when the image fails to load.\n\nLearn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "load", + "value": "CallbackEventListener | null", + "description": "A callback fired when the image successfully loads.\n\nLearn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).", + "isOptional": true + } + ], + "value": "export interface ImageEvents {\n /**\n * A callback fired when the image successfully loads.\n *\n * Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).\n */\n load: CallbackEventListener | null = null;\n /**\n * A callback fired when the image fails to load.\n *\n * Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).\n */\n error: OnErrorEventHandler = null;\n}" + } + }, + "LinkEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LinkEvents", + "description": "The link component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the link is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + } + ], + "value": "export interface LinkEvents {\n /**\n * A callback fired when the link is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n}" + } + }, + "LinkSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LinkSlots", + "description": "The link component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text or elements displayed within the link component, which navigates users to a different location when activated.", + "isOptional": true + } + ], + "value": "export interface LinkSlots {\n /**\n * The text or elements displayed within the link component, which navigates users to a different location when activated.\n */\n children?: HTMLElement;\n}" + } + }, + "ListItemSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ListItemSlots", + "description": "The list item component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the list item, which represents a single entry in an ordered or unordered list.", + "isOptional": true + } + ], + "value": "export interface ListItemSlots {\n /**\n * The content displayed within the list item, which represents a single entry in an ordered or unordered list.\n */\n children?: HTMLElement;\n}" + } + }, + "MenuSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MenuSlots", + "description": "The menu component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The items displayed within the menu. Only accepts button and section components. Use button for individual menu actions and section to group related items.", + "isOptional": true + } + ], + "value": "export interface MenuSlots {\n /**\n * The items displayed within the menu. Only accepts button and section components. Use button for individual menu actions and section to group related items.\n */\n children?: HTMLElement;\n}" + } + }, + "ModalEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ModalEvents", + "description": "The modal component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the modal is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aftershow", + "value": "CallbackEventListener | null", + "description": "A callback fired after the modal is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "CallbackEventListener | null", + "description": "A callback fired when the modal is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "CallbackEventListener | null", + "description": "A callback fired when the modal is shown.", + "isOptional": true + } + ], + "value": "export interface ModalEvents {\n /**\n * A callback fired when the modal is hidden.\n */\n hide: CallbackEventListener | null = null;\n /**\n * A callback fired when the modal is shown.\n */\n show: CallbackEventListener | null = null;\n /**\n * A callback fired after the modal is hidden.\n */\n afterhide: CallbackEventListener | null = null;\n /**\n * A callback fired after the modal is shown.\n */\n aftershow: CallbackEventListener | null = null;\n}" + } + }, + "ModalSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ModalSlots", + "description": "The modal component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the modal component, typically including form fields, information, or interactive elements.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action button displayed in the modal footer, representing the primary action users should take.\n\nOnly accepts a single button component with a `variant` of `primary`. This action should align with the modal's main purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Additional action buttons displayed in the modal footer, providing alternative or supporting actions.\n\nOnly accepts button components with a `variant` of `secondary` or `auto`. These are visually de-emphasized to establish clear hierarchy.", + "isOptional": true + } + ], + "value": "export interface ModalSlots {\n /**\n * The content displayed within the modal component, typically including form fields, information, or interactive elements.\n */\n children?: HTMLElement;\n /**\n * The main action button displayed in the modal footer, representing the primary action users should take.\n *\n * Only accepts a single button component with a `variant` of `primary`. This action should align with the modal's main purpose.\n */\n 'primary-action'?: HTMLElement;\n /**\n * Additional action buttons displayed in the modal footer, providing alternative or supporting actions.\n *\n * Only accepts button components with a `variant` of `secondary` or `auto`. These are visually de-emphasized to establish clear hierarchy.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "MoneyFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MoneyFieldEvents", + "description": "The money field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the money field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the money field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the money field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the money field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface MoneyFieldEvents {\n /**\n * A callback fired when the money field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the money field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the money field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "NumberFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "NumberFieldEvents", + "description": "The number field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the number field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the number field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the number field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the number field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface NumberFieldEvents {\n /**\n * A callback fired when the number field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the number field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the number field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "OptionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OptionSlots", + "description": "The option component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text or elements displayed as the option label, which identifies the selectable choice to users in a dropdown or selection list.", + "isOptional": true + } + ], + "value": "export interface OptionSlots {\n /**\n * The text or elements displayed as the option label, which identifies the selectable choice to users in a dropdown or selection list.\n */\n children?: HTMLElement;\n}" + } + }, + "OptionGroupSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OptionGroupSlots", + "description": "The option group component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.", + "isOptional": true + } + ], + "value": "export interface OptionGroupSlots {\n /**\n * The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.\n */\n children?: HTMLElement;\n}" + } + }, + "OrderedListSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OrderedListSlots", + "description": "The ordered list component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The list entries displayed within the ordered list, where each item is numbered sequentially. Only accepts list item components as children. Each list item represents a single numbered entry in the sequence.", + "isOptional": true + } + ], + "value": "export interface OrderedListSlots {\n /**\n * The list entries displayed within the ordered list, where each item is numbered sequentially. Only accepts list item components as children. Each list item represents a single numbered entry in the sequence.\n */\n children?: HTMLElement;\n}" + } + }, + "PageSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PageSlots", + "description": "The page component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aside", + "value": "HTMLElement", + "description": "The content to display in the aside section of the page.\n\nThis slot is only rendered when `inlineSize` is \"base\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "breadcrumb-actions", + "value": "HTMLElement", + "description": "The navigation back actions for the page.\n\nOnly accepts link components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The main page content displayed within the page component, which serves as the primary container for the page's information and interface elements.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The primary action for the page.\n\nOnly accepts a single button component with a `variant` of `primary`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "The secondary actions for the page.\n\nOnly accepts button group and button components with a `variant` of `secondary` or `auto`.", + "isOptional": true + } + ], + "value": "export interface PageSlots {\n /**\n * The main page content displayed within the page component, which serves as the primary container for the page's information and interface elements.\n */\n children?: HTMLElement;\n /**\n * The content to display in the aside section of the page.\n *\n * This slot is only rendered when `inlineSize` is \"base\".\n */\n aside?: HTMLElement;\n /**\n * The primary action for the page.\n *\n * Only accepts a single button component with a `variant` of `primary`.\n *\n */\n 'primary-action'?: HTMLElement;\n /**\n * The secondary actions for the page.\n *\n * Only accepts button group and button components with a `variant` of `secondary` or `auto`.\n */\n 'secondary-actions'?: HTMLElement;\n /**\n * The navigation back actions for the page.\n *\n * Only accepts link components.\n */\n 'breadcrumb-actions'?: HTMLElement;\n}" + } + }, + "ParagraphSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ParagraphSlots", + "description": "The paragraph component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling.", + "isOptional": true + } + ], + "value": "export interface ParagraphSlots {\n /**\n * The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling.\n */\n children?: HTMLElement;\n}" + } + }, + "PasswordFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PasswordFieldEvents", + "description": "The password field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the password field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the password field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the password field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the password field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface PasswordFieldEvents {\n /**\n * A callback fired when the password field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the password field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the password field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "PopoverEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PopoverEvents", + "description": "The popover component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the popover is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aftershow", + "value": "CallbackEventListener | null", + "description": "A callback fired after the popover is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aftertoggle", + "value": "CallbackEventListener | null", + "description": "A callback fired after the popover is toggled.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "CallbackEventListener | null", + "description": "A callback fired when the popover is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "CallbackEventListener | null", + "description": "A callback fired when the popover is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "toggle", + "value": "CallbackEventListener | null", + "description": "A callback fired when the popover is toggled.", + "isOptional": true + } + ], + "value": "export interface PopoverEvents {\n /**\n * A callback fired when the popover is shown.\n */\n show: CallbackEventListener | null;\n /**\n * A callback fired when the popover is hidden.\n */\n hide: CallbackEventListener | null;\n /**\n * A callback fired after the popover is shown.\n */\n aftershow: CallbackEventListener | null;\n /**\n * A callback fired after the popover is hidden.\n */\n afterhide: CallbackEventListener | null;\n /**\n * A callback fired when the popover is toggled.\n */\n toggle: CallbackEventListener | null;\n /**\n * A callback fired after the popover is toggled.\n */\n aftertoggle: CallbackEventListener | null;\n}" + } + }, + "PopoverSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PopoverSlots", + "description": "The popover component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the popover component, which appears in an overlay positioned relative to its trigger element.", + "isOptional": true + } + ], + "value": "export interface PopoverSlots {\n /**\n * The content displayed within the popover component, which appears in an overlay positioned relative to its trigger element.\n */\n children?: HTMLElement;\n}" + } + }, + "QueryContainerSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "QueryContainerSlots", + "description": "The query container component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the query container component, which enables container queries for responsive styling based on the container's size rather than the viewport.", + "isOptional": true + } + ], + "value": "export interface QueryContainerSlots {\n /**\n * The content displayed within the query container component, which enables container queries for responsive styling based on the container's size rather than the viewport.\n */\n children?: HTMLElement;\n}" + } + }, + "SearchFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SearchFieldEvents", + "description": "The search field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the search field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the search field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the search field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the search field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface SearchFieldEvents {\n /**\n * A callback fired when the search field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the search field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the search field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the search field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "SectionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SectionSlots", + "description": "The section component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.", + "isOptional": true + } + ], + "value": "export interface SectionSlots {\n /**\n * The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.\n */\n children?: HTMLElement;\n}" + } + }, + "SelectEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SelectEvents", + "description": "The select component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the select value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the select.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface SelectEvents {\n /**\n * A callback fired when the select value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the select.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n}" + } + }, + "SelectSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SelectSlots", + "description": "The select component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The selectable options displayed in the dropdown list. Accepts option components for individual selectable items, and option group components to organize related options into logical groups with labels.", + "isOptional": true + } + ], + "value": "export interface SelectSlots {\n /**\n * The selectable options displayed in the dropdown list. Accepts option components for individual selectable items, and option group components to organize related options into logical groups with labels.\n */\n children?: HTMLElement;\n}" + } + }, + "StackSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "StackSlots", + "description": "The stack component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.", + "isOptional": true + } + ], + "value": "export interface StackSlots {\n /**\n * The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.\n */\n children?: HTMLElement;\n}" + } + }, + "SwitchEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SwitchEvents", + "description": "The switch component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the switch value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the switch.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface SwitchEvents {\n /**\n * A callback fired when the switch value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the switch.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n}" + } + }, + "TableEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableEvents", + "description": "The table component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "nextpage", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user navigates to the next page.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "previouspage", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user navigates to the previous page.", + "isOptional": true + } + ], + "value": "export interface TableEvents {\n /**\n * A callback fired when the user navigates to the previous page.\n */\n previouspage: CallbackEventListener | null = null;\n /**\n * A callback fired when the user navigates to the next page.\n */\n nextpage: CallbackEventListener | null = null;\n}" + } + }, + "TableSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableSlots", + "description": "The table component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The table structure defining headers and data rows.\n\nAccepts table header row (for column headers) and table body (for data rows) components. Structure your table with a table header row first, followed by table body.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "filters", + "value": "HTMLElement", + "description": "Filter controls displayed above the table.\n\nAccepts input components like search field or select for filtering table data. These controls appear in a dedicated area above the table content.", + "isOptional": true + } + ], + "value": "export interface TableSlots {\n /**\n * The table structure defining headers and data rows.\n *\n * Accepts table header row (for column headers) and table body (for data rows) components. Structure your table with a table header row first, followed by table body.\n */\n children?: HTMLElement;\n /**\n * Filter controls displayed above the table.\n *\n * Accepts input components like search field or select for filtering table data. These controls appear in a dedicated area above the table content.\n */\n filters?: HTMLElement;\n}" + } + }, + "TableBodySlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableBodySlots", + "description": "The table body component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The data rows displayed in the table body.\n\nAccepts table row components, with each row representing a single record or entry in the table.", + "isOptional": true + } + ], + "value": "export interface TableBodySlots {\n /**\n * The data rows displayed in the table body.\n *\n * Accepts table row components, with each row representing a single record or entry in the table.\n */\n children?: HTMLElement;\n}" + } + }, + "TableCellSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableCellSlots", + "description": "The table cell component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The data value displayed in this cell.\n\nAccepts text content or inline components representing the cell's data value.", + "isOptional": true + } + ], + "value": "export interface TableCellSlots {\n /**\n * The data value displayed in this cell.\n *\n * Accepts text content or inline components representing the cell's data value.\n */\n children?: HTMLElement;\n}" + } + }, + "TableHeaderSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeaderSlots", + "description": "The table header component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The column heading text.\n\nThis text labels the column in table variant and appears as a label for data in list variant.", + "isOptional": true + } + ], + "value": "export interface TableHeaderSlots {\n /**\n * The column heading text.\n *\n * This text labels the column in table variant and appears as a label for data in list variant.\n */\n children?: HTMLElement;\n}" + } + }, + "TableHeaderRowSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeaderRowSlots", + "description": "The table header row component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The column headers displayed in the table header row.\n\nAccepts table header components, with each header defining a column and providing its label.", + "isOptional": true + } + ], + "value": "export interface TableHeaderRowSlots {\n /**\n * The column headers displayed in the table header row.\n *\n * Accepts table header components, with each header defining a column and providing its label.\n */\n children?: HTMLElement;\n}" + } + }, + "TableRowSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableRowSlots", + "description": "The table row component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The data cells displayed in this table row.\n\nAccepts table cell components, with each cell containing a data value for the corresponding column.", + "isOptional": true + } + ], + "value": "export interface TableRowSlots {\n /**\n * The data cells displayed in this table row.\n *\n * Accepts table cell components, with each cell containing a data value for the corresponding column.\n */\n children?: HTMLElement;\n}" + } + }, + "TextSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextSlots", + "description": "The text component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.", + "isOptional": true + } + ], + "value": "export interface TextSlots {\n /**\n * The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.\n */\n children?: HTMLElement;\n}" + } + }, + "TextAreaEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextAreaEvents", + "description": "The text area component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text area loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text area value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text area receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the text area.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface TextAreaEvents {\n /**\n * A callback fired when the text area value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text area loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text area receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "TextFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextFieldEvents", + "description": "The text field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the text field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface TextFieldEvents {\n /**\n * A callback fired when the text field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "TextFieldSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextFieldSlots", + "description": "The text field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the text field.\n\nAccepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface TextFieldSlots {\n /**\n * Additional interactive content displayed within the text field.\n *\n * Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "ThumbnailEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ThumbnailEvents", + "description": "The thumbnail component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "OnErrorEventHandler", + "description": "A callback fired when the thumbnail image fails to load.\n\nLearn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "load", + "value": "CallbackEventListener | null", + "description": "A callback fired when the thumbnail image successfully loads.\n\nLearn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).", + "isOptional": true + } + ], + "value": "export interface ThumbnailEvents {\n /**\n * A callback fired when the thumbnail image successfully loads.\n *\n * Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).\n */\n load: CallbackEventListener | null = null;\n /**\n * A callback fired when the thumbnail image fails to load.\n *\n * Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).\n */\n error: OnErrorEventHandler = null;\n}" + } + }, + "TooltipSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TooltipSlots", + "description": "The tooltip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The informational text or elements displayed within the tooltip overlay, providing helpful context or explanations when users interact with the associated element.\n\nOnly accepts text, paragraph components, and raw `textContent`.", + "isOptional": true + } + ], + "value": "export interface TooltipSlots {\n /**\n * The informational text or elements displayed within the tooltip overlay, providing helpful context or explanations when users interact with the associated element.\n *\n * Only accepts text, paragraph components, and raw `textContent`.\n */\n children?: HTMLElement;\n}" + } + }, + "URLFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "URLFieldEvents", + "description": "The URL field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the URL field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the URL field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the URL field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the URL field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface URLFieldEvents {\n /**\n * A callback fired when the URL field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the URL field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the URL field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the URL field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "UnorderedListSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "UnorderedListSlots", + "description": "The unordered list component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The list entries displayed within the unordered list, where each item is marked with a bullet point. Only accepts list item components as children. Each list item represents a single bulleted entry in the list.", + "isOptional": true + } + ], + "value": "export interface UnorderedListSlots {\n /**\n * The list entries displayed within the unordered list, where each item is marked with a bullet point. Only accepts list item components as children. Each list item represents a single bulleted entry in the list.\n */\n children?: HTMLElement;\n}" + } + }, + "AdminActionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminActionSlots", + "description": "The admin action component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action button or link displayed in the admin action modal. This represents the primary or most important action that users can take in this modal context, typically displayed with high visual prominence." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Additional action buttons or links displayed in the admin action modal. These provide alternative or supporting actions, visually de-emphasized compared to the primary action to establish clear hierarchy." + } + ], + "value": "export interface AdminActionSlots {\n /**\n * The main action button or link displayed in the admin action modal.\n * This represents the primary or most important action that users can take in this modal context, typically displayed with high visual prominence.\n */\n 'primary-action': HTMLElement;\n /**\n * Additional action buttons or links displayed in the admin action modal.\n * These provide alternative or supporting actions, visually de-emphasized compared to the primary action to establish clear hierarchy.\n */\n 'secondary-actions': HTMLElement;\n}" + } + }, + "FormEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FormEvents", + "description": "The form component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "reset", + "value": "CallbackEventListener | null", + "description": "A callback that is run when the form is reset.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "CallbackExtendableEventListener | null", + "description": "A callback that is run when the form is submitted.", + "isOptional": true + } + ], + "value": "export interface FormEvents {\n /**\n * A callback that is run when the form is submitted.\n */\n submit: CallbackExtendableEventListener | null = null;\n /**\n * A callback that is run when the form is reset.\n */\n reset: CallbackEventListener | null = null;\n}" + } + }, + "FunctionSettingsEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionSettingsEvents", + "description": "The function settings component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "CallbackErrorEventListener<\n typeof tagName,\n FunctionSettingsErrorEvent['error']['errors'][0]\n > | null", + "description": "An optional callback function that will be run by the admin when committing the changes to Shopify’s servers fails. The error event you receive includes an `error` property that is an `AggregateError` object. This object includes an array of errors that were caused by data your extension provided. Network errors and user errors that are out of your control will not be reported here.\n\nIn the `onError` callback, you should update your extension’s UI to highlight the fields that caused the errors, and display the error messages to the user.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "reset", + "value": "CallbackEventListener | null", + "description": "A callback that is run when the function settings form is reset.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "CallbackExtendableEventListener | null", + "description": "An optional callback function that will be run by the admin when the user commits their changes in the admin-rendered part of the function settings experience. If `event.waitUntil` is called with a promise, the admin will wait for the promise to resolve before committing any changes to Shopify’s servers. If the promise rejects, the admin will abort the changes and display an error, using the `message` property of the error you reject with.", + "isOptional": true + } + ], + "value": "export interface FunctionSettingsEvents {\n /**\n * An optional callback function that will be run by the admin when the user\n * commits their changes in the admin-rendered part of the function settings\n * experience. If `event.waitUntil` is called with a promise, the admin will wait for the\n * promise to resolve before committing any changes to Shopify’s servers. If\n * the promise rejects, the admin will abort the changes and display an error,\n * using the `message` property of the error you reject with.\n */\n submit: CallbackExtendableEventListener | null = null;\n /**\n * An optional callback function that will be run by the admin when\n * committing the changes to Shopify’s servers fails. The error event you receive includes\n * an `error` property that is an `AggregateError` object. This object includes\n * an array of errors that were caused by data your extension provided.\n * Network errors and user errors that are out of your control will not be reported here.\n *\n * In the `onError` callback, you should update your extension’s UI to\n * highlight the fields that caused the errors, and display the error messages\n * to the user.\n */\n error: CallbackErrorEventListener<\n typeof tagName,\n FunctionSettingsErrorEvent['error']['errors'][0]\n > | null = null;\n /**\n * A callback that is run when the function settings form is reset.\n */\n reset: CallbackEventListener | null = null;\n}" + } + }, + "AppNavAttributes": { + "src/surfaces/admin/components/AppNav/AppNavTypes.ts": { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "name": "AppNavAttributes", + "description": "Configure the following properties on the app nav component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The navigation items to inject into the Shopify admin sidebar. Provide `` children where each link represents a navigation item. This component does not render any visible UI itself.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element.", + "isOptional": true + } + ], + "value": "export interface AppNavAttributes {\n /**\n * A unique identifier for the element.\n */\n id?: string;\n /**\n * The navigation items to inject into the Shopify admin sidebar.\n * Provide `` children where each link represents a navigation item.\n * This component does not render any visible UI itself.\n */\n children?: ComponentChildren;\n}" + } + }, + "AppNavLinkAttributes": { + "src/surfaces/admin/components/AppNav/AppNavTypes.ts": { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "name": "AppNavLinkAttributes", + "description": "Attributes for link elements used as children of app nav. Each link defines a navigation destination in your app's menu.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "string", + "description": "The visible label text for the navigation item. Keep labels short (1-2 words) and use nouns that describe the destination (such as \"Products\", \"Settings\", or \"Reports\"). Avoid verbs like \"Manage\" or \"View\" to maintain consistency with Shopify admin navigation patterns.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL path for the navigation item. Must be a relative path within your app, such as `/products` or `/settings`. When clicked, it navigates the app to this route without a full page reload. The path should match a route defined in your app's routing configuration." + } + ], + "value": "export interface AppNavLinkAttributes {\n /**\n * The URL path for the navigation item. Must be a relative path within your app, such as `/products` or `/settings`. When clicked, it navigates the app to this route without a full page reload. The path should match a route defined in your app's routing configuration.\n */\n href: string;\n /**\n * The visible label text for the navigation item. Keep labels short (1-2 words) and use nouns that describe the destination (such as \"Products\", \"Settings\", or \"Reports\"). Avoid verbs like \"Manage\" or \"View\" to maintain consistency with Shopify admin navigation patterns.\n */\n children?: string;\n}" + } + } +} diff --git a/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-07-rc/targets.json b/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-07-rc/targets.json new file mode 100644 index 0000000000..dfa73aa9ef --- /dev/null +++ b/packages/ui-extensions/docs/surfaces/admin/generated/admin_extensions/2026-07-rc/targets.json @@ -0,0 +1,6443 @@ +{ + "admin.product-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.order-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.discount-details.function-settings.render": { + "components": [ + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "FunctionSettings", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "DiscountFunctionSettingsApi" + ] + }, + "admin.customer-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.collection-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.draft-order-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.abandoned-checkout-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.catalog-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.company-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.company-location-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.gift-card-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.product-variant-details.block.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.product-details.reorder.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "BlockExtensionApi" + ] + }, + "admin.product-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.catalog-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.company-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.gift-card-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.order-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.customer-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.customer-segment-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.product-index.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.order-index.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.customer-index.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.discount-index.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.collection-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.collection-index.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.abandoned-checkout-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.abandoned-checkout-index.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.product-variant-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.draft-order-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.draft-order-index.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.discount-details.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.order-fulfilled-card.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.product-index.selection-action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.order-index.selection-action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.customer-index.selection-action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.discount-index.selection-action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.draft-order-index.selection-action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ActionExtensionApi" + ] + }, + "admin.product-purchase-option.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "PurchaseOptionsCardConfigurationApi" + ] + }, + "admin.product-variant-purchase-option.action.render": { + "components": [ + "AdminAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "PurchaseOptionsCardConfigurationApi" + ] + }, + "admin.order-details.print-action.render": { + "components": [ + "AdminPrintAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "PrintActionExtensionApi" + ] + }, + "admin.product-details.print-action.render": { + "components": [ + "AdminPrintAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "PrintActionExtensionApi" + ] + }, + "admin.order-index.selection-print-action.render": { + "components": [ + "AdminPrintAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "PrintActionExtensionApi" + ] + }, + "admin.product-index.selection-print-action.render": { + "components": [ + "AdminPrintAction", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "PrintActionExtensionApi" + ] + }, + "admin.product-details.configuration.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ProductDetailsConfigurationApi" + ] + }, + "admin.product-variant-details.configuration.render": { + "components": [ + "AdminBlock", + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ProductVariantDetailsConfigurationApi" + ] + }, + "admin.settings.order-routing-rule.render": { + "components": [ + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "FunctionSettings", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "OrderRoutingRuleApi" + ] + }, + "admin.settings.validation.render": { + "components": [ + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "FunctionSettings", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "ValidationSettingsApi" + ] + }, + "admin.app.intent.render": { + "components": [ + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "IntentRenderApi" + ] + }, + "admin.app.home.render": { + "components": [ + "Avatar", + "Badge", + "Banner", + "Box", + "Button", + "ButtonGroup", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ColorField", + "ColorPicker", + "DateField", + "DatePicker", + "Divider", + "DropZone", + "EmailField", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Menu", + "MoneyField", + "NumberField", + "Option", + "OptionGroup", + "OrderedList", + "Paragraph", + "PasswordField", + "QueryContainer", + "SearchField", + "Section", + "Select", + "Spinner", + "Stack", + "Switch", + "Table", + "TableBody", + "TableCell", + "TableHeader", + "TableHeaderRow", + "TableRow", + "Text", + "TextArea", + "TextField", + "Thumbnail", + "Tooltip", + "URLField", + "UnorderedList" + ], + "apis": [ + "AppHomeApi" + ] + }, + "admin.customers.segmentation-templates.data": { + "components": [], + "apis": [ + "CustomerSegmentTemplateApi" + ] + }, + "admin.product-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.catalog-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.company-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.gift-card-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.order-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.customer-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.customer-segment-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.product-index.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.order-index.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.customer-index.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.discount-index.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.collection-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.collection-index.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.abandoned-checkout-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.abandoned-checkout-index.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.product-variant-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.draft-order-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.draft-order-index.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.discount-details.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.order-fulfilled-card.action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.product-index.selection-action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.order-index.selection-action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.customer-index.selection-action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.discount-index.selection-action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.draft-order-index.selection-action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.order-details.print-action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.product-details.print-action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.order-index.selection-print-action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.product-index.selection-print-action.should-render": { + "components": [], + "apis": [ + "ShouldRenderApi" + ] + }, + "admin.app.tools.data": { + "components": [], + "apis": [ + "StandardApi" + ] + }, + "BlockExtensionApi": { + "targets": [ + "admin.abandoned-checkout-details.block.render", + "admin.catalog-details.block.render", + "admin.collection-details.block.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.block.render", + "admin.draft-order-details.block.render", + "admin.gift-card-details.block.render", + "admin.order-details.block.render", + "admin.product-details.block.render", + "admin.product-details.reorder.render", + "admin.product-variant-details.block.render" + ] + }, + "DiscountFunctionSettingsApi": { + "targets": [ + "admin.discount-details.function-settings.render" + ] + }, + "ActionExtensionApi": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-index.action.render", + "admin.catalog-details.action.render", + "admin.collection-details.action.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.customer-details.action.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.order-details.action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.product-details.action.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-variant-details.action.render" + ] + }, + "PurchaseOptionsCardConfigurationApi": { + "targets": [ + "admin.product-purchase-option.action.render", + "admin.product-variant-purchase-option.action.render" + ] + }, + "PrintActionExtensionApi": { + "targets": [ + "admin.order-details.print-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.print-action.render", + "admin.product-index.selection-print-action.render" + ] + }, + "ProductDetailsConfigurationApi": { + "targets": [ + "admin.product-details.configuration.render" + ] + }, + "ProductVariantDetailsConfigurationApi": { + "targets": [ + "admin.product-variant-details.configuration.render" + ] + }, + "OrderRoutingRuleApi": { + "targets": [ + "admin.settings.order-routing-rule.render" + ] + }, + "ValidationSettingsApi": { + "targets": [ + "admin.settings.validation.render" + ] + }, + "IntentRenderApi": { + "targets": [ + "admin.app.intent.render" + ] + }, + "AppHomeApi": { + "targets": [ + "admin.app.home.render" + ] + }, + "CustomerSegmentTemplateApi": { + "targets": [ + "admin.customers.segmentation-templates.data" + ] + }, + "ShouldRenderApi": { + "targets": [ + "admin.abandoned-checkout-details.action.should-render", + "admin.abandoned-checkout-index.action.should-render", + "admin.catalog-details.action.should-render", + "admin.collection-details.action.should-render", + "admin.collection-index.action.should-render", + "admin.company-details.action.should-render", + "admin.customer-details.action.should-render", + "admin.customer-index.action.should-render", + "admin.customer-index.selection-action.should-render", + "admin.customer-segment-details.action.should-render", + "admin.discount-details.action.should-render", + "admin.discount-index.action.should-render", + "admin.discount-index.selection-action.should-render", + "admin.draft-order-details.action.should-render", + "admin.draft-order-index.action.should-render", + "admin.draft-order-index.selection-action.should-render", + "admin.gift-card-details.action.should-render", + "admin.order-details.action.should-render", + "admin.order-details.print-action.should-render", + "admin.order-fulfilled-card.action.should-render", + "admin.order-index.action.should-render", + "admin.order-index.selection-action.should-render", + "admin.order-index.selection-print-action.should-render", + "admin.product-details.action.should-render", + "admin.product-details.print-action.should-render", + "admin.product-index.action.should-render", + "admin.product-index.selection-action.should-render", + "admin.product-index.selection-print-action.should-render", + "admin.product-variant-details.action.should-render" + ] + }, + "StandardApi": { + "targets": [ + "admin.app.tools.data" + ] + }, + "AdminBlock": { + "targets": [ + "admin.abandoned-checkout-details.block.render", + "admin.catalog-details.block.render", + "admin.collection-details.block.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.block.render", + "admin.draft-order-details.block.render", + "admin.gift-card-details.block.render", + "admin.order-details.block.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.reorder.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render" + ] + }, + "Avatar": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Badge": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Banner": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Box": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Button": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "ButtonGroup": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Checkbox": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Chip": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Choice": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "ChoiceList": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Clickable": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "ClickableChip": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "ColorField": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "ColorPicker": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "DateField": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "DatePicker": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Divider": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "DropZone": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "EmailField": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Form": { + "targets": [ + "admin.abandoned-checkout-details.block.render", + "admin.app.intent.render", + "admin.catalog-details.block.render", + "admin.collection-details.block.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.block.render", + "admin.discount-details.function-settings.render", + "admin.draft-order-details.block.render", + "admin.gift-card-details.block.render", + "admin.order-details.block.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.reorder.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Grid": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "GridItem": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Heading": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Icon": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Image": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Link": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "ListItem": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Menu": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "MoneyField": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "NumberField": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Option": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "OptionGroup": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "OrderedList": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Paragraph": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "PasswordField": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "QueryContainer": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "SearchField": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Section": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Select": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Spinner": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Stack": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Switch": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Table": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "TableBody": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "TableCell": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "TableHeader": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "TableHeaderRow": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "TableRow": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Text": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "TextArea": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "TextField": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Thumbnail": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "Tooltip": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "URLField": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "UnorderedList": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-details.block.render", + "admin.abandoned-checkout-index.action.render", + "admin.app.home.render", + "admin.app.intent.render", + "admin.catalog-details.action.render", + "admin.catalog-details.block.render", + "admin.collection-details.action.render", + "admin.collection-details.block.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.company-details.block.render", + "admin.company-location-details.block.render", + "admin.customer-details.action.render", + "admin.customer-details.block.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-details.function-settings.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-details.block.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.gift-card-details.block.render", + "admin.order-details.action.render", + "admin.order-details.block.render", + "admin.order-details.print-action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.action.render", + "admin.product-details.block.render", + "admin.product-details.configuration.render", + "admin.product-details.print-action.render", + "admin.product-details.reorder.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-index.selection-print-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-details.block.render", + "admin.product-variant-details.configuration.render", + "admin.product-variant-purchase-option.action.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "FunctionSettings": { + "targets": [ + "admin.discount-details.function-settings.render", + "admin.settings.order-routing-rule.render", + "admin.settings.validation.render" + ] + }, + "AdminAction": { + "targets": [ + "admin.abandoned-checkout-details.action.render", + "admin.abandoned-checkout-index.action.render", + "admin.catalog-details.action.render", + "admin.collection-details.action.render", + "admin.collection-index.action.render", + "admin.company-details.action.render", + "admin.customer-details.action.render", + "admin.customer-index.action.render", + "admin.customer-index.selection-action.render", + "admin.customer-segment-details.action.render", + "admin.discount-details.action.render", + "admin.discount-index.action.render", + "admin.discount-index.selection-action.render", + "admin.draft-order-details.action.render", + "admin.draft-order-index.action.render", + "admin.draft-order-index.selection-action.render", + "admin.gift-card-details.action.render", + "admin.order-details.action.render", + "admin.order-fulfilled-card.action.render", + "admin.order-index.action.render", + "admin.order-index.selection-action.render", + "admin.product-details.action.render", + "admin.product-index.action.render", + "admin.product-index.selection-action.render", + "admin.product-purchase-option.action.render", + "admin.product-variant-details.action.render", + "admin.product-variant-purchase-option.action.render" + ] + }, + "AdminPrintAction": { + "targets": [ + "admin.order-details.print-action.render", + "admin.order-index.selection-print-action.render", + "admin.product-details.print-action.render", + "admin.product-index.selection-print-action.render" + ] + } +} \ No newline at end of file diff --git a/packages/ui-extensions/docs/surfaces/admin/generated/app_home/generated_docs_data_v2.json b/packages/ui-extensions/docs/surfaces/admin/generated/app_home/generated_docs_data_v2.json new file mode 100644 index 0000000000..004e997942 --- /dev/null +++ b/packages/ui-extensions/docs/surfaces/admin/generated/app_home/generated_docs_data_v2.json @@ -0,0 +1,23449 @@ +{ + "GraphQLError": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "GraphQLError", + "description": "An error returned by the Storefront GraphQL API. Contains a human-readable `message` and an `extensions` object with the request ID and error code for debugging.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "extensions", + "value": "{ requestId: string; code: string; }", + "description": "Additional error metadata including the request ID and error code." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A human-readable description of the error." + } + ], + "value": "export interface GraphQLError {\n /**\n * A human-readable description of the error.\n */\n message: string;\n /**\n * Additional error metadata including the request ID and error code.\n */\n extensions: {\n /**\n * The unique identifier for the API request, useful for debugging with Shopify support.\n */\n requestId: string;\n /**\n * A machine-readable error code identifying the type of error.\n */\n code: string;\n };\n}" + } + }, + "Storage": { + "src/surfaces/admin/api/standard/storage.ts": { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "name": "Storage", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "clear", + "value": "() => Promise", + "description": "Clears all data from the storage. Use this to reset your extension's storage, such as when implementing a logout flow, clearing cached data, or resetting to defaults. This operation removes all stored key-value pairs." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "delete", + "value": "(key: Keys) => Promise", + "description": "Deletes a specific key from the storage. Use this to remove individual data items that are no longer needed, freeing up storage space and maintaining data hygiene." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "deleteMany", + "value": "(keys: Keys[]) => Promise>", + "description": "Deletes multiple keys from the storage at once. Use this to efficiently remove several related data items in a single operation, such as clearing expired cache entries or removing a group of related settings." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "entries", + "value": "() => Promise>", + "description": "Gets all the keys and values in the storage. Use this to iterate over all stored data, useful for debugging, data migration, or displaying all stored settings. The returned iterator provides entries as `[key, value]` tuples." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "get", + "value": "(key: Keys) => Promise", + "description": "Gets the value of a key in the storage. Use this to retrieve previously saved data when your extension loads or when you need to access stored values. The value is automatically deserialized from JSON to its original type." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "getMany", + "value": "(keys: Keys[]) => Promise", + "description": "Gets the values of multiple keys in the storage at once. Use this to efficiently retrieve related data in a single operation, reducing overhead when loading multiple stored values. The returned array is in the same order as the provided keys, with `undefined` values for keys that don't exist in storage." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "set", + "value": "(key: Keys, value: StorageTypes[Keys]) => Promise", + "description": "Sets the value of a key in the storage. Use this to save individual data items like user preferences, form state, or cached values. The value is serialized using `JSON.stringify`, so it can be any primitive type, object, or array that JSON supports." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "setMany", + "value": "(entries: Partial) => Promise", + "description": "Sets multiple key-value pairs in the storage at once. Use this for efficient batch operations when you need to save multiple related values together, such as form data or configuration settings." + } + ], + "value": "export interface Storage<\n BaseStorageTypes extends Record = Record,\n> {\n /**\n * Sets the value of a key in the storage. Use this to save individual data items like user preferences, form state, or cached values. The value is serialized using `JSON.stringify`, so it can be any primitive type, object, or array that JSON supports.\n *\n * @param key - The key to set the value for. Use descriptive keys to organize your stored data.\n * @param value - The value to set for the key. Can be any primitive type supported by `JSON.stringify`.\n *\n * @throws {StorageExceededError} Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.\n */\n set<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n key: Keys,\n value: StorageTypes[Keys],\n ): Promise;\n\n /**\n * Sets multiple key-value pairs in the storage at once. Use this for efficient batch operations when you need to save multiple related values together, such as form data or configuration settings.\n *\n * @param entries - An object containing key-value pairs to store. Values can be any primitive type supported by `JSON.stringify`.\n *\n * @throws {StorageExceededError} Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.\n */\n setMany(\n entries: Partial,\n ): Promise;\n\n /**\n * Gets the value of a key in the storage. Use this to retrieve previously saved data when your extension loads or when you need to access stored values. The value is automatically deserialized from JSON to its original type.\n *\n * @param key - The key to get the value for.\n * @returns The value of the key, or `undefined` if no value exists for the key.\n */\n get<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n key: Keys,\n ): Promise;\n\n /**\n * Gets the values of multiple keys in the storage at once. Use this to efficiently retrieve related data in a single operation, reducing overhead when loading multiple stored values. The returned array is in the same order as the provided keys, with `undefined` values for keys that don't exist in storage.\n *\n * @param keys - An array of keys to get the values for.\n * @returns An array containing values for the requested keys, in the same order as the input keys.\n */\n getMany<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n keys: Keys[],\n ): Promise<(StorageTypes[Keys] | undefined)[]>;\n\n /**\n * Clears all data from the storage. Use this to reset your extension's storage, such as when implementing a logout flow, clearing cached data, or resetting to defaults. This operation removes all stored key-value pairs.\n */\n clear(): Promise;\n\n /**\n * Deletes a specific key from the storage. Use this to remove individual data items that are no longer needed, freeing up storage space and maintaining data hygiene.\n *\n * @param key - The key to delete.\n * @returns A promise that resolves to `true` if the key existed and was deleted, or `false` if the key did not exist.\n */\n delete<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n key: Keys,\n ): Promise;\n\n /**\n * Deletes multiple keys from the storage at once. Use this to efficiently remove several related data items in a single operation, such as clearing expired cache entries or removing a group of related settings.\n *\n * @param keys - An array of keys to delete.\n * @returns A promise that resolves to an object mapping each key to a boolean value: `true` if the key existed and was deleted, or `false` if the key did not exist.\n */\n deleteMany<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n keys: Keys[],\n ): Promise>;\n\n /**\n * Gets all the keys and values in the storage. Use this to iterate over all stored data, useful for debugging, data migration, or displaying all stored settings. The returned iterator provides entries as `[key, value]` tuples.\n *\n * @returns A promise that resolves to an iterator containing all key-value pairs in the storage.\n */\n entries<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(): Promise>;\n}" + } + }, + "StorageExceededError": { + "src/surfaces/admin/api/standard/storage.ts": { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "name": "StorageExceededError", + "description": "Error thrown when storage operations exceed the available storage quota. This can occur during `set()` or `setMany()` operations when the total stored data size exceeds the limit allocated to your extension.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "'StorageExceededError'", + "description": "" + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "PropertySignature", + "name": "stack", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface StorageExceededError extends Error {\n name: 'StorageExceededError';\n}" + } + }, + "Data": { + "src/surfaces/admin/api/shared.ts": { + "filePath": "src/surfaces/admin/api/shared.ts", + "name": "Data", + "description": "The `Data` object provides access to currently viewed or selected resources in the admin context.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "{ id: string; }[]", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions." + } + ], + "value": "export interface Data {\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.\n */\n selected: {id: string}[];\n}" + } + }, + "SupportedDefinitionType": { + "src/surfaces/admin/api/shared.ts": { + "filePath": "src/surfaces/admin/api/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SupportedDefinitionType", + "value": "'boolean' | 'collection_reference' | 'color' | 'date' | 'date_time' | 'dimension' | 'file_reference' | 'json' | 'metaobject_reference' | 'mixed_reference' | 'money' | 'multi_line_text_field' | 'number_decimal' | 'number_integer' | 'page_reference' | 'product_reference' | 'rating' | 'rich_text_field' | 'single_line_text_field' | 'product_taxonomy_value_reference' | 'url' | 'variant_reference' | 'volume' | 'weight' | 'list.collection_reference' | 'list.color' | 'list.date' | 'list.date_time' | 'list.dimension' | 'list.file_reference' | 'list.metaobject_reference' | 'list.mixed_reference' | 'list.number_decimal' | 'list.number_integer' | 'list.page_reference' | 'list.product_reference' | 'list.rating' | 'list.single_line_text_field' | 'list.url' | 'list.variant_reference' | 'list.volume' | 'list.weight'", + "description": "The supported [metafield definition types](/docs/apps/build/metafields/list-of-data-types) for storing extension configuration data. Use these types to specify how metafield values should be formatted, validated, and displayed. Types prefixed with `list.` store arrays of values, while other types store single values. Choose a type that matches your data format (for example, use `'number_integer'` for whole numbers, `'single_line_text_field'` for short text, or `'json'` for complex structured data).", + "isPublicDocs": true + } + }, + "ExtensionTargets": { + "src/surfaces/admin/extension-targets.ts": { + "filePath": "src/surfaces/admin/extension-targets.ts", + "name": "ExtensionTargets", + "description": "Maps extension target identifiers to their corresponding extension types. Each target represents a specific location or context in the Shopify admin where extensions can render or execute. Use these targets to define where your extension appears and what capabilities it has access to.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the abandoned checkout details page. Use this to create workflows for cart recovery, customer engagement, or checkout analysis." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the abandoned checkout details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on checkout properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.abandoned-checkout-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the abandoned checkout details page. Use this to show cart recovery tools, abandonment analysis, or customer re-engagement options." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the abandoned checkout index page. Use this to create workflows for cart recovery, bulk customer engagement, or checkout analysis across multiple abandoned carts." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the abandoned checkout index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.app.home.render", + "value": "RenderExtension<\n AppHomeApi<'admin.app.home.render'>,\n FormExtensionComponents | 'Modal' | 'Page' | 'AppNav'\n >", + "description": "Renders an admin extension on the app home page." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.app.intent.render", + "value": "RenderExtension<\n IntentRenderApi<'admin.app.intent.render'>,\n FormExtensionComponents\n >", + "description": "Renders an admin extension for handling app intents." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.app.tools.data", + "value": "RunnableExtension<\n StandardApi<'admin.app.tools.data'>,\n undefined\n >", + "description": "A runnable target that enables your app to expose data to [Sidekick](/docs/apps/build/sidekick/build-app-data). Use this target to register tools that Sidekick can invoke to search your app's data and answer merchant questions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.catalog-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.catalog-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the catalog details page. Use this to create workflows for catalog management, market synchronization, or data exports." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.catalog-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.catalog-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the catalog details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on catalog properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.catalog-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.catalog-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the catalog details page. Use this to show catalog-specific settings, market information, or synchronization tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.collection-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the collection details page. Use this to create workflows for collection management, product operations, or merchandising tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.collection-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the collection details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on collection properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.collection-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the collection details page. Use this to show collection analytics, bulk product operations, or collection-specific tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.collection-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the collection index page. Use this to create workflows for collection management, bulk operations, or catalog organization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.collection-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the collection index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.company-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the company details page. Use this to create workflows for B2B customer management, credit operations, or company data synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.company-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the company details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on company properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.company-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the company details page. Use this to show B2B customer information, credit limits, or company-specific data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-location-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.company-location-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the company location details page. Use this to show location-specific information, shipping preferences, or location management tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the customer details page. Use this to create workflows for customer data management, loyalty operations, or CRM integrations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on customer properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.customer-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the customer details page. Use this to show customer-specific information, loyalty data, or custom customer actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the customer index page. Use this to create workflows for customer management, marketing operations, or bulk data processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the customer index page when multiple customers are selected. Use this to create workflows for bulk customer operations, mass email campaigns, or batch data updates." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-segment-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-segment-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears from the **Use segment** button on the customer segment details page. Use this to create workflows for marketing campaigns, email operations, or segment-based actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-segment-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-segment-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer segment details action appears from the **Use segment** button. Use this to conditionally show or hide your action based on segment properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customers.segmentation-templates.data", + "value": "RunnableExtension<\n CustomerSegmentTemplateApi<'admin.customers.segmentation-templates.data'>,\n {templates: CustomerSegmentTemplate[]}\n >", + "description": "A runnable target that provides [customer segment templates](/docs/apps/build/marketing-analytics/customer-segments/build-a-template-extension) in the [customer segment editor](https://help.shopify.com/manual/customers/customer-segmentation/create-customer-segments). Use this target to provide pre-built segment templates that merchants can use as starting points for creating targeted customer groups based on custom criteria." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.discount-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the discount details page. Use this to create workflows for discount management, promotion analysis, or discount synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.discount-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the discount details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on discount properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-details.function-settings.render", + "value": "RenderExtension<\n DiscountFunctionSettingsApi<'admin.discount-details.function-settings.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that appears when merchants create or edit a discount powered by your discount function, allowing them to configure function-specific settings. Use this to build custom configuration interfaces for discount function parameters." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.discount-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the discount index page. Use this to create workflows for discount management, promotional operations, or bulk discount updates." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.discount-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the discount index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.discount-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the discount index page when multiple discounts are selected. Use this to create workflows for bulk discount operations or batch data updates." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.discount-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the discount index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.draft-order-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the draft order details page. Use this to create workflows for draft order processing, custom pricing, or order preparation tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.draft-order-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the draft order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on draft order properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.draft-order-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the draft order details page. Use this to show custom pricing calculations, special order handling tools, or order-specific information." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the draft order index page. Use this to create workflows for draft order management, bulk operations, or order conversion tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the draft order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the draft order index page when multiple draft orders are selected. Use this to create workflows for bulk draft order operations, batch conversions, or mass order processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the draft order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.gift-card-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.gift-card-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the gift card details page. Use this to create workflows for gift card processing, balance adjustments, or custom gift card operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.gift-card-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.gift-card-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the gift card details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on gift card properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.gift-card-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.gift-card-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the gift card details page. Use this to show gift card balance tracking, usage history, or custom gift card metadata." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the order details page. Use this to create workflows for order processing, fulfillment operations, or external system integrations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on order properties, fulfillment status, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.order-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the order details page. Use this to show order-specific information, fulfillment tools, or custom order actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.order-details.print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the order details page. Use this to generate custom documents such as packing slips, shipping labels, or invoices." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-details.print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on order properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-fulfilled-card.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-fulfilled-card.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the actions menu inside the order fulfilled card, visible only on orders fulfilled by your app. Use this to create workflows for fulfillment operations, tracking updates, or post-fulfillment actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-fulfilled-card.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-fulfilled-card.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order fulfilled card action appears in the actions menu. Use this to conditionally show or hide your action based on fulfillment properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the order index page. Use this to create workflows for order management, reporting, or fulfillment operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the order index page when multiple orders are selected. Use this to create workflows for bulk order operations, batch fulfillment, or mass order processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.order-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the order index page when multiple orders are selected. Use this to generate batch documents such as combined packing slips, shipping manifests, or bulk invoices." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the product details page. Use this to create workflows for processing products, syncing data, or integrating with external systems." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on product properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.product-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the product details page. Use this to show product-specific information, tools, or actions directly on the product page." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.configuration.render", + "value": "RenderExtension<\n ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>,\n BlockExtensionComponents\n >", + "description": "A configuration target that renders product configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product details page. Use this to define bundle component selections, customization options, or product configuration rules." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.product-details.print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the product details page. Use this to generate custom documents such as product labels, barcode sheets, or specification sheets." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-details.print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on product properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.reorder.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.product-details.reorder.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that provides custom reordering functionality on the product details page. Use this to help merchants rearrange product data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the product index page. Use this to create workflows for product management, catalog operations, or inventory synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the product index page when multiple products are selected. Use this to create workflows for bulk product operations, batch updates, or mass data processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.product-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the product index page when multiple products are selected. Use this to generate batch documents such as combined product labels, barcode sheets, or catalog pages." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-purchase-option.action.render", + "value": "RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-purchase-option.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **Purchase Options** card on the product details page when a selling plan group is present. Use this to create workflows for subscription management, selling plan configuration, or purchase option operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-variant-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the product variant details page. Use this to create workflows for variant management, inventory operations, or data synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-variant-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product variant details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on variant properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.product-variant-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the product variant details page. Use this to show variant-specific data, inventory tools, or variant configuration options." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.configuration.render", + "value": "RenderExtension<\n ProductVariantDetailsConfigurationApi<'admin.product-variant-details.configuration.render'>,\n BlockExtensionComponents\n >", + "description": "A configuration target that renders product variant configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product variant details page. Use this to define variant-specific bundle components, customization options, or configuration rules." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-purchase-option.action.render", + "value": "RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-variant-purchase-option.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **Purchase Options** card on the product variant details page when a selling plan group is present. Use this to create workflows for variant-specific subscription management, selling plan configuration, or purchase option operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.settings.internal-order-routing-rule.render", + "value": "RenderExtension<\n OrderRoutingRuleApi<'admin.settings.internal-order-routing-rule.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.settings.order-routing-rule.render", + "value": "RenderExtension<\n OrderRoutingRuleApi<'admin.settings.order-routing-rule.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions. Use this to build custom configuration interfaces for order routing function parameters." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.settings.validation.render", + "value": "RenderExtension<\n ValidationSettingsApi<'admin.settings.validation.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that renders within a validation's add and edit views, allowing merchants to configure validation function settings. Use this to build custom configuration interfaces for validation function parameters and rules." + } + ], + "value": "export interface ExtensionTargets {\n /**\n * A runnable target that provides [customer segment templates](/docs/apps/build/marketing-analytics/customer-segments/build-a-template-extension) in the [customer segment editor](https://help.shopify.com/manual/customers/customer-segmentation/create-customer-segments). Use this target to provide pre-built segment templates that merchants can use as starting points for creating targeted customer groups based on custom criteria.\n */\n 'admin.customers.segmentation-templates.data': RunnableExtension<\n CustomerSegmentTemplateApi<'admin.customers.segmentation-templates.data'>,\n {templates: CustomerSegmentTemplate[]}\n >;\n\n // Blocks\n /**\n * A block target that displays inline content within the product details page. Use this to show product-specific information, tools, or actions directly on the product page.\n */\n 'admin.product-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.product-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the order details page. Use this to show order-specific information, fulfillment tools, or custom order actions.\n */\n 'admin.order-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.order-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A function settings target that appears when merchants create or edit a discount powered by your discount function, allowing them to configure function-specific settings. Use this to build custom configuration interfaces for discount function parameters.\n */\n 'admin.discount-details.function-settings.render': RenderExtension<\n DiscountFunctionSettingsApi<'admin.discount-details.function-settings.render'>,\n FunctionSettingsComponents\n >;\n\n /**\n * A block target that displays inline content within the customer details page. Use this to show customer-specific information, loyalty data, or custom customer actions.\n */\n 'admin.customer-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.customer-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the collection details page. Use this to show collection analytics, bulk product operations, or collection-specific tools.\n */\n 'admin.collection-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.collection-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the draft order details page. Use this to show custom pricing calculations, special order handling tools, or order-specific information.\n */\n 'admin.draft-order-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.draft-order-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the abandoned checkout details page. Use this to show cart recovery tools, abandonment analysis, or customer re-engagement options.\n */\n 'admin.abandoned-checkout-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.abandoned-checkout-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the catalog details page. Use this to show catalog-specific settings, market information, or synchronization tools.\n */\n 'admin.catalog-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.catalog-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the company details page. Use this to show B2B customer information, credit limits, or company-specific data.\n */\n 'admin.company-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.company-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the company location details page. Use this to show location-specific information, shipping preferences, or location management tools.\n */\n 'admin.company-location-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.company-location-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the gift card details page. Use this to show gift card balance tracking, usage history, or custom gift card metadata.\n */\n 'admin.gift-card-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.gift-card-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the product variant details page. Use this to show variant-specific data, inventory tools, or variant configuration options.\n */\n 'admin.product-variant-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.product-variant-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that provides custom reordering functionality on the product details page. Use this to help merchants rearrange product data.\n */\n 'admin.product-details.reorder.render': RenderExtension<\n BlockExtensionApi<'admin.product-details.reorder.render'>,\n BlockExtensionComponents\n >;\n\n // Actions\n /**\n * An action target that appears in the **More actions** menu on the product details page. Use this to create workflows for processing products, syncing data, or integrating with external systems.\n */\n 'admin.product-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.product-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the catalog details page. Use this to create workflows for catalog management, market synchronization, or data exports.\n */\n 'admin.catalog-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.catalog-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the company details page. Use this to create workflows for B2B customer management, credit operations, or company data synchronization.\n */\n 'admin.company-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.company-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the gift card details page. Use this to create workflows for gift card processing, balance adjustments, or custom gift card operations.\n */\n 'admin.gift-card-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.gift-card-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the order details page. Use this to create workflows for order processing, fulfillment operations, or external system integrations.\n */\n 'admin.order-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.order-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the customer details page. Use this to create workflows for customer data management, loyalty operations, or CRM integrations.\n */\n 'admin.customer-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears from the **Use segment** button on the customer segment details page. Use this to create workflows for marketing campaigns, email operations, or segment-based actions.\n */\n 'admin.customer-segment-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-segment-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the product index page. Use this to create workflows for product management, catalog operations, or inventory synchronization.\n */\n 'admin.product-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.product-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the order index page. Use this to create workflows for order management, reporting, or fulfillment operations.\n */\n 'admin.order-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.order-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the customer index page. Use this to create workflows for customer management, marketing operations, or bulk data processing.\n */\n 'admin.customer-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the discount index page. Use this to create workflows for discount management, promotional operations, or bulk discount updates.\n */\n 'admin.discount-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.discount-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the collection details page. Use this to create workflows for collection management, product operations, or merchandising tools.\n */\n 'admin.collection-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.collection-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the collection index page. Use this to create workflows for collection management, bulk operations, or catalog organization.\n */\n 'admin.collection-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.collection-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the abandoned checkout details page. Use this to create workflows for cart recovery, customer engagement, or checkout analysis.\n */\n 'admin.abandoned-checkout-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the abandoned checkout index page. Use this to create workflows for cart recovery, bulk customer engagement, or checkout analysis across multiple abandoned carts.\n */\n 'admin.abandoned-checkout-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the product variant details page. Use this to create workflows for variant management, inventory operations, or data synchronization.\n */\n 'admin.product-variant-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.product-variant-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the draft order details page. Use this to create workflows for draft order processing, custom pricing, or order preparation tools.\n */\n 'admin.draft-order-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.draft-order-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the draft order index page. Use this to create workflows for draft order management, bulk operations, or order conversion tools.\n */\n 'admin.draft-order-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the discount details page. Use this to create workflows for discount management, promotion analysis, or discount synchronization.\n */\n 'admin.discount-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.discount-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the actions menu inside the order fulfilled card, visible only on orders fulfilled by your app. Use this to create workflows for fulfillment operations, tracking updates, or post-fulfillment actions.\n */\n 'admin.order-fulfilled-card.action.render': RenderExtension<\n ActionExtensionApi<'admin.order-fulfilled-card.action.render'>,\n ActionExtensionComponents\n >;\n\n // Bulk Actions\n\n /**\n * A selection action target that appears in the **More actions** menu on the product index page when multiple products are selected. Use this to create workflows for bulk product operations, batch updates, or mass data processing.\n */\n 'admin.product-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.product-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * A selection action target that appears in the **More actions** menu on the order index page when multiple orders are selected. Use this to create workflows for bulk order operations, batch fulfillment, or mass order processing.\n */\n 'admin.order-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.order-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * A selection action target that appears in the **More actions** menu on the customer index page when multiple customers are selected. Use this to create workflows for bulk customer operations, mass email campaigns, or batch data updates.\n */\n 'admin.customer-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the discount index page when multiple discounts are selected. Use this to create workflows for bulk discount operations or batch data updates.\n */\n 'admin.discount-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.discount-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * A selection action target that appears in the **More actions** menu on the draft order index page when multiple draft orders are selected. Use this to create workflows for bulk draft order operations, batch conversions, or mass order processing.\n */\n 'admin.draft-order-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **Purchase Options** card on the product details page when a selling plan group is present. Use this to create workflows for subscription management, selling plan configuration, or purchase option operations.\n */\n 'admin.product-purchase-option.action.render': RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-purchase-option.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **Purchase Options** card on the product variant details page when a selling plan group is present. Use this to create workflows for variant-specific subscription management, selling plan configuration, or purchase option operations.\n */\n 'admin.product-variant-purchase-option.action.render': RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-variant-purchase-option.action.render'>,\n ActionExtensionComponents\n >;\n\n // Print actions and bulk print actions\n\n /**\n * A print action target that appears in the **Print** menu on the order details page. Use this to generate custom documents such as packing slips, shipping labels, or invoices.\n */\n 'admin.order-details.print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.order-details.print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n /**\n * A print action target that appears in the **Print** menu on the product details page. Use this to generate custom documents such as product labels, barcode sheets, or specification sheets.\n */\n 'admin.product-details.print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.product-details.print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n /**\n * A print action target that appears in the **Print** menu on the order index page when multiple orders are selected. Use this to generate batch documents such as combined packing slips, shipping manifests, or bulk invoices.\n */\n 'admin.order-index.selection-print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.order-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n /**\n * A print action target that appears in the **Print** menu on the product index page when multiple products are selected. Use this to generate batch documents such as combined product labels, barcode sheets, or catalog pages.\n */\n 'admin.product-index.selection-print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.product-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n // Other\n\n /**\n * A configuration target that renders product configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product details page. Use this to define bundle component selections, customization options, or product configuration rules.\n */\n 'admin.product-details.configuration.render': RenderExtension<\n ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A configuration target that renders product variant configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product variant details page. Use this to define variant-specific bundle components, customization options, or configuration rules.\n */\n 'admin.product-variant-details.configuration.render': RenderExtension<\n ProductVariantDetailsConfigurationApi<'admin.product-variant-details.configuration.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions.\n * @private\n */\n 'admin.settings.internal-order-routing-rule.render': RenderExtension<\n OrderRoutingRuleApi<'admin.settings.internal-order-routing-rule.render'>,\n FunctionSettingsComponents\n >;\n /**\n * A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions. Use this to build custom configuration interfaces for order routing function parameters.\n */\n 'admin.settings.order-routing-rule.render': RenderExtension<\n OrderRoutingRuleApi<'admin.settings.order-routing-rule.render'>,\n FunctionSettingsComponents\n >;\n\n /**\n * A function settings target that renders within a validation's add and edit views, allowing merchants to configure validation function settings. Use this to build custom configuration interfaces for validation function parameters and rules.\n */\n 'admin.settings.validation.render': RenderExtension<\n ValidationSettingsApi<'admin.settings.validation.render'>,\n FunctionSettingsComponents\n >;\n\n // Admin action shouldRender targets\n /**\n * A non-rendering target that controls whether the product details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on product properties, user permissions, or external data.\n */\n 'admin.product-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the catalog details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on catalog properties, user permissions, or external data.\n */\n 'admin.catalog-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.catalog-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the company details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on company properties, user permissions, or external data.\n */\n 'admin.company-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.company-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the gift card details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on gift card properties, user permissions, or external data.\n */\n 'admin.gift-card-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.gift-card-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on order properties, fulfillment status, or external data.\n */\n 'admin.order-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on customer properties, user permissions, or external data.\n */\n 'admin.customer-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer segment details action appears from the **Use segment** button. Use this to conditionally show or hide your action based on segment properties, user permissions, or external data.\n */\n 'admin.customer-segment-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-segment-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.product-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.order-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.customer-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the discount index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.discount-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.discount-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the collection details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on collection properties, user permissions, or external data.\n */\n 'admin.collection-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.collection-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the collection index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.collection-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.collection-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the abandoned checkout details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on checkout properties, user permissions, or external data.\n */\n 'admin.abandoned-checkout-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the abandoned checkout index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.abandoned-checkout-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product variant details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on variant properties, user permissions, or external data.\n */\n 'admin.product-variant-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-variant-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the draft order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on draft order properties, user permissions, or external data.\n */\n 'admin.draft-order-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.draft-order-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the draft order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.draft-order-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the discount details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on discount properties, user permissions, or external data.\n */\n 'admin.discount-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.discount-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order fulfilled card action appears in the actions menu. Use this to conditionally show or hide your action based on fulfillment properties, user permissions, or external data.\n */\n 'admin.order-fulfilled-card.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-fulfilled-card.action.should-render'>,\n ShouldRenderOutput\n >;\n\n // Admin bulk action shouldRender targets\n\n /**\n * A non-rendering target that controls whether the product index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.product-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.order-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.customer-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the discount index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.discount-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.discount-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the draft order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.draft-order-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n // Admin print action and bulk print action shouldRender targets\n\n /**\n * A non-rendering target that controls whether the order details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on order properties, user permissions, or external data.\n */\n 'admin.order-details.print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-details.print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on product properties, user permissions, or external data.\n */\n 'admin.product-details.print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-details.print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data.\n */\n 'admin.order-index.selection-print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data.\n */\n 'admin.product-index.selection-print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A runnable target that enables your app to expose data to [Sidekick](/docs/apps/build/sidekick/build-app-data). Use this target to register tools that Sidekick can invoke to search your app's data and answer merchant questions.\n */\n 'admin.app.tools.data': RunnableExtension<\n StandardApi<'admin.app.tools.data'>,\n undefined\n >;\n\n /**\n * Renders an admin extension for handling app intents.\n */\n 'admin.app.intent.render': RenderExtension<\n IntentRenderApi<'admin.app.intent.render'>,\n FormExtensionComponents\n >;\n\n /**\n * Renders an admin extension on the app home page.\n */\n 'admin.app.home.render': RenderExtension<\n AppHomeApi<'admin.app.home.render'>,\n FormExtensionComponents | 'Modal' | 'Page' | 'AppNav'\n >;\n}" + } + }, + "RenderExtension": { + "src/extension.ts": { + "filePath": "src/extension.ts", + "name": "RenderExtension", + "description": "Defines the structure of a render extension, which displays UI in the Shopify admin.", + "members": [ + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "api", + "value": "Api", + "description": "The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "components", + "value": "ComponentsSet", + "description": "The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "output", + "value": "void | Promise", + "description": "The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads." + } + ], + "value": "export interface RenderExtension {\n /**\n * The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying.\n */\n api: Api;\n /**\n * The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target.\n */\n components: ComponentsSet;\n /**\n * The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads.\n */\n output: void | Promise;\n}" + } + }, + "ActionExtensionApi": { + "src/surfaces/admin/api/action/action.ts": { + "filePath": "src/surfaces/admin/api/action/action.ts", + "name": "ActionExtensionApi", + "description": "The `ActionExtensionApi` object provides methods for action extensions that render in modal overlays. Access the following properties on the `ActionExtensionApi` object to interact with the current context, control the modal, and display picker dialogs.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "close", + "value": "() => void", + "description": "Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ActionExtensionApi\n extends StandardRenderingExtensionApi {\n /**\n * Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner.\n */\n close: () => void;\n\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.\n */\n data: Data;\n}" + } + }, + "Auth": { + "src/surfaces/admin/api/standard/standard.ts": { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "name": "Auth", + "description": "The `Auth` object provides authentication methods for secure communication with your app backend.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "idToken", + "value": "() => Promise", + "description": "Retrieves a [Shopify OpenID Connect ID token](/docs/api/app-home/apis/id-token) for the current user. Use this token to authenticate requests to your app backend and verify the user's identity. The token is a signed JWT that contains user information and can be validated using Shopify's public keys. Returns `null` if the token can't be retrieved." + } + ], + "value": "export interface Auth {\n /**\n * Retrieves a [Shopify OpenID Connect ID token](/docs/api/app-home/apis/id-token) for the current user. Use this token to authenticate requests to your app backend and verify the user's identity. The token is a signed JWT that contains user information and can be validated using Shopify's public keys. Returns `null` if the token can't be retrieved.\n */\n idToken: () => Promise;\n}" + } + }, + "ExtensionTarget": { + "src/surfaces/admin/extension-targets.ts": { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionTarget", + "value": "keyof ExtensionTargets", + "description": "A string literal union of all valid extension target identifiers. Use this type to specify where your admin UI extension should render, such as `admin.product-details.block.render` for a block on product details pages or `admin.order-details.action.render` for an action on order details pages. The target determines the extension's location, available APIs, and UI components." + } + }, + "I18n": { + "src/api.ts": { + "filePath": "src/api.ts", + "name": "I18n", + "description": "Internationalization utilities for formatting and translating content according to the user's locale. Use these methods to display numbers, currency, dates, and translated strings that match the merchant's language and regional preferences.", + "members": [ + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "formatCurrency", + "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", + "description": "Returns a localized currency value formatted according to the user's locale and currency conventions. Use this to display prices, totals, or financial amounts in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. Uses the current user's locale by default." + }, + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "formatDate", + "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", + "description": "Returns a localized date value formatted according to the user's locale and date conventions. Use this to display dates and times in the appropriate format for the merchant's region, such as order dates, timestamps, or schedule information. This function behaves like the standard `Intl.DateTimeFormat()` and uses the current user's locale by default. Formatting options can be passed to customize the date display style." + }, + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "formatNumber", + "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", + "description": "Returns a localized number formatted according to the user's locale. Use this to display numbers like quantities, percentages, or measurements in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. Uses the current user's locale by default." + }, + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "I18nTranslate", + "description": "Returns translated content in the user's locale, as supported by the extension. Use this to display localized strings from your extension's locale files. The special `options.count` property enables pluralization. Other option keys and values are treated as replacements for interpolation in your translation strings. Returns a single string when replacements are primitives, or an array when replacements contain UI components." + } + ], + "value": "export interface I18n {\n /**\n * Returns a localized number formatted according to the user's locale. Use this to display numbers like quantities, percentages, or measurements in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. Uses the current user's locale by default.\n *\n * @param number - The number to format\n * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale\n * @param options - Additional Intl.NumberFormatOptions for customizing the number format\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value formatted according to the user's locale and currency conventions. Use this to display prices, totals, or financial amounts in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. Uses the current user's locale by default.\n *\n * @param number - The currency amount to format\n * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale\n * @param options - Additional Intl.NumberFormatOptions for customizing the currency format, such as the currency code\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value formatted according to the user's locale and date conventions. Use this to display dates and times in the appropriate format for the merchant's region, such as order dates, timestamps, or schedule information. This function behaves like the standard `Intl.DateTimeFormat()` and uses the current user's locale by default. Formatting options can be passed to customize the date display style.\n *\n * @param date - The Date object to format\n * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale\n * @param options - Additional Intl.DateTimeFormatOptions for customizing the date format\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the user's locale, as supported by the extension. Use this to display localized strings from your extension's locale files. The special `options.count` property enables pluralization. Other option keys and values are treated as replacements for interpolation in your translation strings. Returns a single string when replacements are primitives, or an array when replacements contain UI components.\n */\n translate: I18nTranslate;\n}" + } + }, + "I18nTranslate": { + "src/api.ts": { + "filePath": "src/api.ts", + "name": "I18nTranslate", + "description": "The translation function signature for internationalization. Use this to translate string keys defined in your locale files into localized content for the current user's language.", + "members": [], + "value": "export interface I18nTranslate {\n /**\n * Returns a translated string matching a key in a locale file. Use this to display localized text in your extension based on the merchant's language preferences. Supports interpolation with replacement values and pluralization with the `count` option. Returns a string when replacements are primitives, or an array when replacements include UI components.\n *\n * @param key - The translation key from your locale file (for example, \"banner.title\")\n * @param options - Optional replacement values for interpolation or the special `count` property for pluralization\n *\n * @example translate(\"banner.title\")\n * @example translate(\"items.count\", { count: 5 })\n */\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" + } + }, + "Intents": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "Intents", + "description": "The `Intents` object provides methods for launching standardized Shopify workflows to create or edit resources. Intents enable your extension to trigger native admin interfaces for products, customers, discounts, and other resources, then receive the results when merchants complete the workflow.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "invoke", + "value": "IntentInvokeApi", + "description": "Launches an intent workflow for creating or editing Shopify resources. Returns a handle that resolves when the merchant completes, cancels, or encounters an error in the workflow. Use this to initiate resource creation or editing without building custom forms.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "launchUrl", + "value": "string | URL", + "description": "The URL that launched the current intent workflow, if your extension was opened through an intent. Use this to determine how your extension was invoked and access any parameters passed in the URL.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "response", + "value": "IntentResponseApi", + "description": "Resolves the current intent from within an invoked extension. This property is only present when your extension is running inside an intent workflow.", + "isOptional": true + } + ], + "value": "export interface Intents {\n /**\n * Resolves the current intent from within an invoked extension. This property is only present when your extension is running inside an intent workflow.\n */\n response?: IntentResponseApi;\n\n /**\n * The URL that launched the current intent workflow, if your extension was opened through an intent. Use this to determine how your extension was invoked and access any parameters passed in the URL.\n */\n launchUrl?: string | URL;\n /**\n * Launches an intent workflow for creating or editing Shopify resources. Returns a handle that resolves when the merchant completes, cancels, or encounters an error in the workflow. Use this to initiate resource creation or editing without building custom forms.\n */\n invoke?: IntentInvokeApi;\n}" + } + }, + "IntentInvokeApi": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentInvokeApi", + "description": "The [`invoke` method](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/intents-api#invoke-method) in the Intents API launches a Shopify admin workflow for creating, editing, or picking resources, such as products, customers, or files. It opens a native admin interface, waits for the merchant to complete the workflow, and returns the result including any created, updated, or selected resource data.", + "isPublicDocs": true, + "members": [], + "value": "export interface IntentInvokeApi {\n (query: IntentQuery): Promise;\n (intentURL: string, options?: IntentQueryOptions): Promise;\n}" + } + }, + "IntentResponseApi": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentResponseApi", + "description": "The `IntentResponseApi` object provides methods for resolving the current intent from within an invoked extension. This API is only present when your extension is running inside an intent workflow.", + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "MethodSignature", + "name": "closed", + "value": "() => Promise", + "description": "Resolves the current intent as closed without completing the workflow." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "MethodSignature", + "name": "error", + "value": "(message: string, issues?: Issue[]) => Promise", + "description": "Resolves the current intent with an error. Use `issues` to provide field-specific validation details when available." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "MethodSignature", + "name": "ok", + "value": "(data?: { [key: string]: unknown; }) => Promise", + "description": "Resolves the current intent successfully. Pass output data when your intent defines a response schema." + } + ], + "value": "export interface IntentResponseApi {\n /**\n * Resolves the current intent successfully. Pass output data when your intent defines a response schema.\n */\n ok(data?: SuccessIntentResponse['data']): Promise;\n\n /**\n * Resolves the current intent with an error. Use `issues` to provide field-specific validation details when available.\n */\n error(message: string, issues?: Issue[]): Promise;\n\n /**\n * Resolves the current intent as closed without completing the workflow.\n */\n closed(): Promise;\n}" + } + }, + "Issue": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "Issue", + "description": "A structured issue describing a validation or workflow error.", + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A machine-readable error code for this issue. Use this for programmatic error handling or logging.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A description of what's wrong with this field. Display this to help merchants understand how to fix the error.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "path", + "value": "string[]", + "description": "The path to the field that has an error (for example, `['product', 'title']`). Use this to identify which field caused the validation failure.", + "isOptional": true + } + ], + "value": "export interface Issue {\n /** The path to the field that has an error (for example, `['product', 'title']`). Use this to identify which field caused the validation failure. */\n path?: string[];\n /** A description of what's wrong with this field. Display this to help merchants understand how to fix the error. */\n message?: string;\n /** A machine-readable error code for this issue. Use this for programmatic error handling or logging. */\n code?: string;\n}" + } + }, + "PickerApi": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "PickerApi", + "description": "The `picker` function opens a custom selection dialog with your app-specific data. It accepts configuration options to define the picker's heading, items, headers, and selection behavior. It returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.", + "isPublicDocs": true, + "params": [ + { + "name": "options", + "description": "", + "value": "PickerOptions", + "filePath": "src/surfaces/admin/api/picker/picker.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "description": "", + "name": "Promise", + "value": "Promise" + }, + "value": "(options: PickerOptions) => Promise" + } + }, + "PickerOptions": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "PickerOptions", + "description": "The configuration options for the custom picker dialog. Define the picker's appearance, selection behavior, and data structure.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "headers", + "value": "Header[]", + "description": "The column headers for the picker table. Define headers to label and organize the data columns displayed for each item. The header order determines the column layout.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading displayed at the top of the picker modal. Use a clear, descriptive title that tells merchants what they're selecting." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "Item[]", + "description": "The list of items that merchants can select from. Each item appears as a row in the picker table." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean | number", + "description": "The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `3` allows up to three items).", + "isOptional": true + } + ], + "value": "export interface PickerOptions {\n /**\n * The heading displayed at the top of the picker modal. Use a clear, descriptive title that tells merchants what they're selecting.\n */\n heading: string;\n /**\n * The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `3` allows up to three items).\n */\n multiple?: boolean | number;\n /**\n * The list of items that merchants can select from. Each item appears as a row in the picker table.\n */\n items: Item[];\n /**\n * The column headers for the picker table. Define headers to label and organize the data columns displayed for each item. The header order determines the column layout.\n */\n headers?: Header[];\n}" + } + }, + "Header": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "Header", + "description": "The configuration for a table column header in the picker. Each header creates a labeled column that displays corresponding data from items.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The label text displayed at the top of the table column. Use clear, concise labels that describe the data in that column (for example, \"Price\", \"Status\", \"Last Updated\").", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'string' | 'number'", + "description": "The data type that controls column formatting and text alignment. Use `'number'` for currency, prices, or numeric values (displays right-aligned), or `'string'` for text content (displays left-aligned).", + "isOptional": true, + "defaultValue": "'string'" + } + ], + "value": "export interface Header {\n /**\n * The label text displayed at the top of the table column. Use clear, concise labels that describe the data in that column (for example, \"Price\", \"Status\", \"Last Updated\").\n */\n content?: string;\n /**\n * The data type that controls column formatting and text alignment. Use `'number'` for currency, prices, or numeric values (displays right-aligned), or `'string'` for text content (displays left-aligned).\n * @defaultValue 'string'\n */\n type?: 'string' | 'number';\n}" + } + }, + "Item": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "Item", + "description": "An individual item that merchants can select in the picker. Each item appears as a row in the picker table.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "badges", + "value": "PickerBadge[]", + "description": "Status or context badges displayed next to the heading in the first column. Use badges to highlight item state, completion status, or other important attributes (for example, \"Draft\", \"Published\", \"Incomplete\").", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "DataPoint[]", + "description": "Additional data displayed in subsequent columns after the heading. Each value appears in its own column, and the order must match the `headers` array. For example, if headers are `[\"Price\", \"Status\"]`, then data would be `[19.99, \"Active\"]`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the item can be selected. When `true`, the item is disabled and can't be selected. Disabled items appear grayed out and merchants can't choose them. Use this for items that are unavailable or don't meet selection criteria.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The primary text displayed in the first column. This is typically the item's name or title and is the most prominent text in the row." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique identifier for this item. This ID is returned in the selection array when the merchant selects this item. Use an ID that helps you identify the item in your system (for example, template IDs, review IDs, or custom option keys)." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the item is preselected when the picker opens. When `true`, the item appears selected by default. Merchants can still deselect preselected items. Use this to show current selections or suggest default choices.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "thumbnail", + "value": "{ url: string; }", + "description": "A small preview image or icon displayed at the start of the row. Thumbnails help merchants visually identify items at a glance. Provide a URL to the image file.", + "isOptional": true + } + ], + "value": "export interface Item {\n /**\n * The unique identifier for this item. This ID is returned in the selection array when the merchant selects this item. Use an ID that helps you identify the item in your system (for example, template IDs, review IDs, or custom option keys).\n */\n id: string;\n /**\n * The primary text displayed in the first column. This is typically the item's name or title and is the most prominent text in the row.\n */\n heading: string;\n /**\n * Additional data displayed in subsequent columns after the heading. Each value appears in its own column, and the order must match the `headers` array. For example, if headers are `[\"Price\", \"Status\"]`, then data would be `[19.99, \"Active\"]`.\n */\n data?: DataPoint[];\n /**\n * Whether the item can be selected. When `true`, the item is disabled and can't be selected. Disabled items appear grayed out and merchants can't choose them. Use this for items that are unavailable or don't meet selection criteria.\n * @defaultValue false\n */\n disabled?: boolean;\n /**\n * Whether the item is preselected when the picker opens. When `true`, the item appears selected by default. Merchants can still deselect preselected items. Use this to show current selections or suggest default choices.\n */\n selected?: boolean;\n /**\n * Status or context badges displayed next to the heading in the first column. Use badges to highlight item state, completion status, or other important attributes (for example, \"Draft\", \"Published\", \"Incomplete\").\n */\n badges?: PickerBadge[];\n /**\n * A small preview image or icon displayed at the start of the row. Thumbnails help merchants visually identify items at a glance. Provide a URL to the image file.\n */\n thumbnail?: {url: string};\n}" + } + }, + "PickerBadge": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "PickerBadge", + "description": "A badge displayed next to an item in the picker to show status or progress. Use badges to highlight important item attributes or states that affect selection decisions.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The text content of the badge. Keep this short and descriptive (for example, \"Draft\", \"Active\", \"Incomplete\")." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "progress", + "value": "Progress", + "description": "The progress indicator for the badge. Use this to show completion status for items that have progress states.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "Tone", + "description": "The visual tone indicating status or importance. Choose a tone that matches the badge's meaning.", + "isOptional": true + } + ], + "value": "export interface PickerBadge {\n /** The text content of the badge. Keep this short and descriptive (for example, \"Draft\", \"Active\", \"Incomplete\"). */\n content: string;\n /** The visual tone indicating status or importance. Choose a tone that matches the badge's meaning. */\n tone?: Tone;\n /** The progress indicator for the badge. Use this to show completion status for items that have progress states. */\n progress?: Progress;\n}" + } + }, + "Progress": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Progress", + "value": "'incomplete' | 'partiallyComplete' | 'complete'", + "description": "The progress state for picker badges showing completion status. Use this to indicate how complete an item is: `'incomplete'` for not started, `'partiallyComplete'` for in progress, or `'complete'` for finished.", + "isPublicDocs": true + } + }, + "Tone": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Tone", + "value": "'info' | 'success' | 'warning' | 'critical'", + "description": "The visual tone for picker badges indicating status or importance. Use different tones to communicate urgency or state: `'info'` for neutral information, `'success'` for positive states, `'warning'` for caution, or `'critical'` for urgent issues.", + "isPublicDocs": true + } + }, + "DataPoint": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DataPoint", + "value": "string | number | undefined", + "description": "A single data point that can appear in a picker table cell. Can be text, a number, or undefined if the cell should be empty.", + "isPublicDocs": true + } + }, + "Picker": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "Picker", + "description": "A handle returned when opening a picker dialog. Use this to access the merchant's selection after they confirm or cancel the picker.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "Promise", + "description": "A Promise that resolves with an array of selected item IDs when the merchant presses the **Select** button, or `undefined` if they cancel. Await this Promise to handle the selection result." + } + ], + "value": "export interface Picker {\n /**\n * A Promise that resolves with an array of selected item IDs when the merchant presses the **Select** button, or `undefined` if they cancel. Await this Promise to handle the selection result.\n */\n selected: Promise;\n}" + } + }, + "ApiVersion": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ApiVersion", + "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04' | '2026-07'", + "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." + } + }, + "ResourcePickerApi": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ResourcePickerApi", + "description": "Opens the resource picker modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel.", + "isPublicDocs": true, + "params": [ + { + "name": "options", + "description": "", + "value": "ResourcePickerOptions", + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "description": "", + "name": "Promise | undefined>", + "value": "Promise | undefined>" + }, + "value": "(\n options: ResourcePickerOptions,\n) => Promise | undefined>" + } + }, + "ResourcePickerOptions": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ResourcePickerOptions", + "description": "The `ResourcePickerOptions` object defines how the resource picker behaves, including which resource type to display, selection limits, filters, and preselected items. Access the following properties on the `ResourcePickerOptions` object to configure the resource picker's appearance and functionality.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "'add' | 'select'", + "description": "The action verb that appears in the picker's title and primary button. Use `'add'` for actions that add new items (for example, \"Add products\") or `'select'` for choosing existing items (for example, \"Select products\"). This helps merchants understand the picker's purpose.", + "isOptional": true, + "defaultValue": "'add'" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "filter", + "value": "Filters", + "description": "Filtering options that control which resources appear in the picker. Use filters to restrict resources by publication status, include or exclude variants, or apply custom search criteria. This helps merchants find relevant items faster.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean | number", + "description": "The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `5` allows up to five items). When `type` is `'product'`, merchants can still select multiple variants from a single product even if `multiple` is `false`.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "string", + "description": "An initial search query that appears in the picker's search bar when it opens. Merchants can see and edit this query. See [search syntax](/docs/api/usage/search-syntax) for the query format. For most use cases, use `filter.query` instead, which filters results without exposing the query to merchants.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "selectionIds", + "value": "BaseResource[]", + "description": "Resources that should be preselected when the picker opens. Pass an array of resource objects with IDs (and optional variant IDs) to show which items are already selected. Merchants can deselect these preselected items. Use this to show current selections or default choices.", + "isOptional": true, + "defaultValue": "[]" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'product' | 'variant' | 'collection'", + "description": "The type of Shopify resource to select: `'product'` for products, `'variant'` for specific product variants, or `'collection'` for collections. This determines what appears in the picker and what data structure is returned." + } + ], + "value": "export interface ResourcePickerOptions {\n /**\n * The type of Shopify resource to select: `'product'` for products, `'variant'` for specific product variants, or `'collection'` for collections. This determines what appears in the picker and what data structure is returned.\n */\n type: 'product' | 'variant' | 'collection';\n /**\n * The action verb that appears in the picker's title and primary button. Use `'add'` for actions that add new items (for example, \"Add products\") or `'select'` for choosing existing items (for example, \"Select products\"). This helps merchants understand the picker's purpose.\n * @defaultValue 'add'\n */\n action?: 'add' | 'select';\n /**\n * Filtering options that control which resources appear in the picker. Use filters to restrict resources by publication status, include or exclude variants, or apply custom search criteria. This helps merchants find relevant items faster.\n */\n filter?: Filters;\n /**\n * The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `5` allows up to five items). When `type` is `'product'`, merchants can still select multiple variants from a single product even if `multiple` is `false`.\n * @defaultValue false\n */\n multiple?: boolean | number;\n /**\n * An initial search query that appears in the picker's search bar when it opens. Merchants can see and edit this query. See [search syntax](/docs/api/usage/search-syntax) for the query format. For most use cases, use `filter.query` instead, which filters results without exposing the query to merchants.\n * @defaultValue ''\n */\n query?: string;\n /**\n * Resources that should be preselected when the picker opens. Pass an array of resource objects with IDs (and optional variant IDs) to show which items are already selected. Merchants can deselect these preselected items. Use this to show current selections or default choices.\n * @defaultValue []\n */\n selectionIds?: BaseResource[];\n}" + } + }, + "Filters": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Filters", + "description": "Filter options that control which resources appear in the resource picker. Use filters to restrict the available resources based on publication status, resource type, or custom search criteria.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "archived", + "value": "boolean | undefined", + "description": "Whether to include archived products in the picker. When `false`, archived products are hidden. When `undefined`, archived products appear with an archived badge. Only applies when `type` is `'product'`. Use this to prevent selecting discontinued products.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "draft", + "value": "boolean | undefined", + "description": "Whether to include draft products in the picker. When `false`, draft products are hidden. When `undefined`, draft products appear with a draft badge. Only applies when `type` is `'product'`. Use this to prevent selecting products that aren't ready for use.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Whether to include products that aren't published on any sales channels. When `false`, only products published to at least one sales channel appear in the picker. Use this to ensure merchants only select products that customers can purchase.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "string", + "description": "A GraphQL search query that filters the available resources without showing the query in the picker's search bar. Merchants won't see or edit this filter. See [search syntax](/docs/api/usage/search-syntax) for the query format. Use this to programmatically restrict resources based on attributes like tags, vendor, or product type (for example, `\"tag:featured\"` or `\"vendor:Acme\"`).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "variants", + "value": "boolean", + "description": "Whether to show product variants in the picker. When `false`, merchants can only select products, not individual variants. Only applies when `type` is `'product'`. Use this to simplify selection when you only need product-level data.", + "isOptional": true, + "defaultValue": "true" + } + ], + "value": "export interface Filters {\n /**\n * Whether to include products that aren't published on any sales channels. When `false`, only products published to at least one sales channel appear in the picker. Use this to ensure merchants only select products that customers can purchase.\n * @defaultValue true\n */\n hidden?: boolean;\n /**\n * Whether to show product variants in the picker. When `false`, merchants can only select products, not individual variants. Only applies when `type` is `'product'`. Use this to simplify selection when you only need product-level data.\n * @defaultValue true\n */\n variants?: boolean;\n /**\n * Whether to include draft products in the picker. When `false`, draft products are hidden. When `undefined`, draft products appear with a draft badge. Only applies when `type` is `'product'`. Use this to prevent selecting products that aren't ready for use.\n * @defaultValue true\n */\n draft?: boolean | undefined;\n /**\n * Whether to include archived products in the picker. When `false`, archived products are hidden. When `undefined`, archived products appear with an archived badge. Only applies when `type` is `'product'`. Use this to prevent selecting discontinued products.\n * @defaultValue true\n */\n archived?: boolean | undefined;\n /**\n * A GraphQL search query that filters the available resources without showing the query in the picker's search bar. Merchants won't see or edit this filter. See [search syntax](/docs/api/usage/search-syntax) for the query format. Use this to programmatically restrict resources based on attributes like tags, vendor, or product type (for example, `\"tag:featured\"` or `\"vendor:Acme\"`).\n */\n query?: string;\n}" + } + }, + "BaseResource": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "BaseResource", + "description": "A resource structure that can optionally include associated variants. Use this type for specifying preselected items in the resource picker when you need to include variant selections.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The resource identifier in GraphQL global ID format (for example, `gid://shopify/Product/123`)." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "variants", + "value": "Resource[]", + "description": "An array of variant resources to preselect along with the main resource. Only applicable when the main resource is a product that has variants you want to preselect.", + "isOptional": true + } + ], + "value": "export interface BaseResource extends Resource {\n /** An array of variant resources to preselect along with the main resource. Only applicable when the main resource is a product that has variants you want to preselect. */\n variants?: Resource[];\n}" + } + }, + "Resource": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Resource", + "description": "The base resource structure with a unique identifier.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The resource identifier in GraphQL global ID format (for example, `gid://shopify/Product/123`)." + } + ], + "value": "export interface Resource {\n /** The resource identifier in GraphQL global ID format (for example, `gid://shopify/Product/123`). */\n id: string;\n}" + } + }, + "SelectPayload": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SelectPayload", + "value": "SelectPayload", + "description": "The payload returned when resources are selected from the picker.", + "isPublicDocs": true + } + }, + "ActionExtensionComponents": { + "src/surfaces/admin/components/ActionExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/ActionExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionExtensionComponents", + "value": "StandardComponents | 'AdminAction'", + "description": "The components available for building action extensions. Includes all standard components plus the admin action component required for action extension setup." + } + }, + "StandardComponents": { + "src/surfaces/admin/components/StandardComponents.ts": { + "filePath": "src/surfaces/admin/components/StandardComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "StandardComponents", + "value": "'Avatar' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'ButtonGroup' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ColorField' | 'ColorPicker' | 'DateField' | 'DatePicker' | 'DropZone' | 'Divider' | 'EmailField' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Menu' | 'MoneyField' | 'NumberField' | 'Option' | 'OptionGroup' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'QueryContainer' | 'SearchField' | 'Section' | 'Select' | 'Spinner' | 'Stack' | 'Switch' | 'Table' | 'TableBody' | 'TableCell' | 'TableHeader' | 'TableHeaderRow' | 'TableRow' | 'Text' | 'TextArea' | 'TextField' | 'Thumbnail' | 'Tooltip' | 'UnorderedList' | 'URLField'", + "description": "The standard set of UI components available in most admin extensions. These components provide the building blocks for creating extension interfaces including layout elements, form inputs, data display, navigation, and interactive controls. Use these components to build consistent, accessible UIs that match the Shopify admin design system." + } + }, + "Avatar": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Avatar", + "description": "Configure the following properties on the avatar component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "initials", + "value": "string", + "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The URL or path to the avatar image. When provided, the image takes priority over `initials`. If the image fails to load or loads slowly, `initials` will be rendered as a fallback.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"small-200\" | \"base\" | \"large\" | \"large-200\"", + "description": "The size of the avatar image.\n\n- `small-200`: Extra small avatar, suitable for compact displays or lists with many items.\n- `small`: Small avatar, good for secondary contexts or tight layouts.\n- `base`: Default size that works well in most contexts.\n- `large`: Large avatar for emphasis or when the avatar is a focal point.\n- `large-200`: Extra large avatar for prominent display.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the avatar for accessibility.\n\nProvides a text description of the avatar for users with assistive technology and serves as a fallback when the avatar fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an avatar, it reads this description aloud. When an avatar fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Avatar extends PreactCustomElement implements AvatarProps {\n accessor initials: AvatarProps['initials'];\n accessor src: AvatarProps['src'];\n accessor size: AvatarProps['size'];\n accessor alt: AvatarProps['alt'];\n constructor();\n}" + } + }, + "ClickOptions": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickOptions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "sourceEvent", + "value": "ActivationEventEsque", + "description": "The event you want to influence the synthetic click.", + "isOptional": true + } + ], + "value": "export interface ClickOptions {\n /**\n * The event you want to influence the synthetic click.\n */\n sourceEvent?: ActivationEventEsque;\n}" + } + }, + "ActivationEventEsque": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ActivationEventEsque", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "button", + "value": "number", + "description": "The button number that was pressed on the mouse. 0 for left button, 1 for middle button, 2 for right button." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ctrlKey", + "value": "boolean", + "description": "Whether the Ctrl key was pressed when the event occurred." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "metaKey", + "value": "boolean", + "description": "Whether the Meta/Command key (Mac) or Windows key was pressed when the event occurred." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "shiftKey", + "value": "boolean", + "description": "Whether the Shift key was pressed when the event occurred." + } + ], + "value": "export interface ActivationEventEsque {\n /**\n * Whether the Shift key was pressed when the event occurred.\n */\n shiftKey: boolean;\n /**\n * Whether the Meta/Command key (Mac) or Windows key was pressed when the event occurred.\n */\n metaKey: boolean;\n /**\n * Whether the Ctrl key was pressed when the event occurred.\n */\n ctrlKey: boolean;\n /**\n * The button number that was pressed on the mouse. 0 for left button, 1 for middle button, 2 for right button.\n */\n button: number;\n}" + } + }, + "Badge": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Badge", + "description": "Configure the following properties on the badge component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"strong\"", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `strong`: Increased visual weight for higher emphasis and prominence.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"base\" | \"large\" | \"large-100\"", + "description": "The size of the badge.\n\n- `base`: Default size suitable for most badge use cases.\n- `large`: Larger badge for increased visibility and prominence.\n- `large-100`: Extra large badge for maximum visibility in emphasized contexts.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\" | \"neutral\" | \"caution\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `caution`: Advisory notices that need attention.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Badge extends PreactCustomElement implements BadgeProps {\n accessor color: BadgeProps['color'];\n accessor icon: BadgeProps['icon'];\n accessor size: BadgeProps['size'];\n accessor tone: BadgeProps['tone'];\n constructor();\n}" + } + }, + "Banner": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Banner", + "description": "Configure the following properties on the banner component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the banner.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hidden", + "value": "boolean", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "dismissible", + "value": "boolean", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event fires, then `hidden` is set to `true`, any animation completes, and the `afterhide` event fires.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Banner extends PreactCustomElement implements BannerProps {\n accessor heading: BannerProps['heading'];\n accessor tone: BannerProps['tone'];\n accessor hidden: BannerProps['hidden'];\n accessor dismissible: BannerProps['dismissible'];\n constructor();\n}" + } + }, + "Box": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Box", + "description": "Configure the following properties on the box component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Box extends BoxElement implements BoxProps {\n constructor();\n}" + } + }, + "AccessibilityRole": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AccessibilityRole", + "value": "'main' | 'header' | 'footer' | 'section' | 'aside' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'status' | 'alert' | 'generic' | 'presentation' | 'none'", + "description": "Defines the semantic role of a component for assistive technologies like screen readers.\n\nAccessibility roles help users with disabilities understand the purpose and structure of content. These roles map to HTML elements and ARIA roles, providing semantic meaning beyond visual presentation.\n\nUse these roles to:\n- Improve navigation for screen reader users\n- Provide semantic structure to your UI\n- Ensure proper interpretation by assistive technologies\n\nLearn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles) in the MDN web docs.\n\n- `main`: Indicates the primary content area of the page.\n- `header`: Marks a component as a header containing introductory content or navigation.\n- `footer`: Designates content containing information like copyright, navigation links, or privacy statements.\n- `section`: Defines a generic thematic grouping of content that should have a heading or accessible label.\n- `aside`: Marks supporting content that relates to but is separate from the main content.\n- `navigation`: Identifies major groups of navigation links for moving around the site or page.\n- `ordered-list`: Represents a list where the order of items is meaningful.\n- `list-item`: Identifies an individual item within a list.\n- `list-item-separator`: Acts as a visual and semantic divider between items in a list.\n- `unordered-list`: Represents a list where the order of items is not meaningful.\n- `separator`: Creates a divider that separates and distinguishes sections of content.\n- `status`: Defines a live region for advisory information that is not urgent enough to be an alert.\n- `alert`: Marks important, time-sensitive information that requires the user's immediate attention.\n- `generic`: Creates a semantically neutral container element with no inherent meaning.\n- `presentation`: Removes semantic meaning from an element while preserving its visual appearance.\n- `none`: Synonym for `presentation`, removes semantic meaning while keeping visual styling.", + "isPublicDocs": true + } + }, + "BackgroundColorKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BackgroundColorKeyword", + "value": "'transparent' | ColorKeyword", + "description": "Defines the background color intensity or emphasis level for UI elements.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isPublicDocs": true + } + }, + "ColorKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColorKeyword", + "value": "'subdued' | 'base' | 'strong'", + "description": "Defines the color intensity or emphasis level for text and UI elements.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", + "isPublicDocs": true + } + }, + "SizeUnitsOrAuto": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnitsOrAuto", + "value": "SizeUnits | 'auto'", + "description": "Represents size values that can also be set to `auto` for automatic sizing.\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isPublicDocs": true + } + }, + "SizeUnits": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnits", + "value": "`${number}px` | `${number}%` | `0`", + "description": "Represents size values in pixels, percentages, or zero.\n\n- `${number}px`: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`).\n- `${number}%`: Relative size as a percentage of the parent container (such as `50%`, `100%`).\n- `0`: Zero size, equivalent to no dimension.", + "isPublicDocs": true + } + }, + "SizeUnitsOrNone": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnitsOrNone", + "value": "SizeUnits | 'none'", + "description": "Represents size values that can also be set to `none` to remove the size constraint.\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `none`: No size constraint, allowing unlimited growth.", + "isPublicDocs": true + } + }, + "MaybeResponsive": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeResponsive", + "value": "T | `@container${string}`", + "description": "Makes a property responsive by allowing it to be set conditionally based on container query conditions. The value can be either a base value or a container query string.\n\n- `T`: Base value that applies in all conditions.\n- `@container${string}`: Container query string for conditional responsive styling based on container size.", + "isPublicDocs": true + } + }, + "MaybeAllValuesShorthandProperty": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeAllValuesShorthandProperty", + "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", + "description": "Represents CSS shorthand properties that accept one to four values. Supports specifying values for all four sides: top, right, bottom, and left.\n\n- `T`: Single value that applies to all four sides.\n- `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right).\n- `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom).\n- `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left).", + "isPublicDocs": true + } + }, + "PaddingKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PaddingKeyword", + "value": "SizeKeyword | 'none'", + "description": "Defines the padding size for elements, using the standard size scale or `none` for no padding.\n\n- `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing.\n- `none`: No padding.", + "isPublicDocs": true + } + }, + "SizeKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeKeyword", + "value": "'small-500' | 'small-400' | 'small-300' | 'small-200' | 'small-100' | 'small' | 'base' | 'large' | 'large-100' | 'large-200' | 'large-300' | 'large-400' | 'large-500'", + "description": "Defines component sizes using a consistent scale from extra small to extra large.\n\n- `small-500` through `small-100`: Extra small to small sizes, progressively increasing.\n- `small`: Standard small size.\n- `base`: Default medium size that works well in most contexts.\n- `large`: Standard large size.\n- `large-100` through `large-500`: Large to extra large sizes, progressively increasing.", + "isPublicDocs": true + } + }, + "MaybeTwoValuesShorthandProperty": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeTwoValuesShorthandProperty", + "value": "T | `${T} ${T}`", + "description": "Represents CSS shorthand properties that accept one or two values. Supports specifying the same value for both dimensions or different values.\n\n- `T`: Single value that applies to both dimensions.\n- `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal).", + "isPublicDocs": true + } + }, + "BorderShorthand": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderShorthand", + "value": "BorderSizeKeyword | `${BorderSizeKeyword} ${ColorKeyword}` | `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`", + "description": "Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style.", + "isPublicDocs": true + } + }, + "BorderSizeKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderSizeKeyword", + "value": "SizeKeyword | 'none'", + "description": "Defines the width of borders, using the standard size scale or `none` for no border.\n\n- `SizeKeyword`: Standard border widths from the size scale for consistent thickness.\n- `none`: No border width (removes the border).", + "isPublicDocs": true + } + }, + "BorderStyleKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderStyleKeyword", + "value": "'none' | 'solid' | 'dashed' | 'dotted' | 'auto'", + "description": "Defines the visual style of borders.\n\n- `none`: No border is displayed.\n- `solid`: A single solid line.\n- `dashed`: A series of short dashes.\n- `dotted`: A series of dots.\n- `auto`: Automatically determined based on context.", + "isPublicDocs": true + } + }, + "BoxBorderStyles": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BoxBorderStyles", + "value": "'auto' | 'none' | 'solid' | 'dashed'", + "description": "Represents the subset of border style values supported by the box component.\n\n- `auto`: Default border style determined by the system.\n- `none`: No border style (removes the border).\n- `solid`: Continuous line border.\n- `dashed`: Border made up of dashes.", + "isPublicDocs": true + } + }, + "BoxBorderRadii": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BoxBorderRadii", + "value": "'small' | 'small-200' | 'small-100' | 'base' | 'large' | 'large-100' | 'large-200' | 'none'", + "description": "Represents the subset of border radius values supported by the component.\n\n- `small-200`: Extra small radius for subtle rounding.\n- `small-100`: Small radius for minimal corner rounding.\n- `small`: Standard small radius.\n- `base`: Medium radius for moderate corner rounding.\n- `large`: Standard large radius for pronounced rounding.\n- `large-100`: Large radius for more prominent corner rounding.\n- `large-200`: Extra large radius for maximum rounding.\n- `none`: No border radius (sharp corners).", + "isPublicDocs": true + } + }, + "Button": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Button", + "description": "Configure the following properties on the button component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "An icon displayed inside the button, typically positioned before the button text. Use icons to help users quickly identify the button's action or to improve scannability. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "variant", + "value": "\"auto\" | \"primary\" | \"secondary\" | \"tertiary\"", + "description": "The visual appearance of the button component.\n\n- `auto`: The variant is automatically determined by the button component's context.\n- `primary`: High emphasis button for the primary action on the page. Should be used sparingly.\n- `secondary`: Medium emphasis button for secondary actions.\n- `tertiary`: Low emphasis button for less important actions.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"critical\" | \"auto\" | \"neutral\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "target", + "value": "\"auto\" | AnyString | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"button\" | \"reset\" | \"submit\"", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "defaultValue": "'button'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class Button extends Button_base implements ButtonProps {\n accessor disabled: ButtonProps['disabled'];\n accessor icon: ButtonProps['icon'];\n accessor loading: ButtonProps['loading'];\n accessor variant: ButtonProps['variant'];\n accessor tone: ButtonProps['tone'];\n accessor target: ButtonProps['target'];\n accessor href: ButtonProps['href'];\n accessor download: ButtonProps['download'];\n accessor type: ButtonProps['type'];\n accessor accessibilityLabel: ButtonProps['accessibilityLabel'];\n constructor();\n}" + } + }, + "AnyString": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyString", + "value": "string & {}", + "description": "A utility type that enables autocomplete for specific string literals while still accepting any string value. By intersecting `string` with an empty object type, this prevents TypeScript from widening literal types, preserving IDE suggestions for known values while maintaining flexibility for custom strings.", + "isPublicDocs": true + } + }, + "ButtonGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonGroup", + "description": "Configure the following properties on the button group component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gap", + "value": "\"base\" | \"none\"", + "description": "The spacing between buttons in the group.\n\n- `base`: Standard spacing that provides clear visual separation between buttons.\n- `none`: No spacing, creating a connected button group.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ButtonGroup\n extends PreactCustomElement\n implements ButtonGroupProps\n{\n accessor gap: ButtonGroupProps['gap'];\n accessor accessibilityLabel: ButtonGroupProps['accessibilityLabel'];\n constructor();\n}" + } + }, + "Checkbox": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Checkbox", + "description": "Configure the following properties on the checkbox component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "indeterminate", + "value": "boolean", + "description": "Whether the checkbox displays in an indeterminate state (neither checked nor unchecked), typically used to indicate partial selection in hierarchical lists.\n\nThis visual state takes priority over the `checked` prop in appearance only. The form submission value is still determined by the `checked` prop.\n\nIf `indeterminate` has not been explicitly set and hasn't been modified by user interaction, it returns the value of `defaultIndeterminate`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultIndeterminate", + "value": "boolean", + "description": "The initial indeterminate state for uncontrolled components. Use this when you want the checkbox to start in an indeterminate state but don't need to control it afterward.\n\nThis value applies until `indeterminate` is explicitly set or the user changes the checkbox state by clicking.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked. Use this for controlled components where you manage the checked state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The value used in form data when the checkbox is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultChecked", + "value": "boolean", + "description": "The initial checked state for uncontrolled components. Use this when you want the control to start checked but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "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.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Checkbox extends PreactCheckboxElement implements CheckboxProps {\n get indeterminate(): CheckboxProps['indeterminate'];\n set indeterminate(indeterminate: CheckboxProps['indeterminate']);\n accessor defaultIndeterminate: CheckboxProps['defaultIndeterminate'];\n constructor();\n}" + } + }, + "Chip": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Chip", + "description": "Configure the following properties on the chip component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Chip extends PreactCustomElement implements ChipProps {\n accessor color: ChipProps['color'];\n accessor accessibilityLabel: ChipProps['accessibilityLabel'];\n constructor();\n}" + } + }, + "Choice": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Choice", + "description": "The choice component creates individual selectable options within a choice list. Use choice to define each option that merchants can select, supporting both single selection (radio buttons) and multiple selection (checkboxes) modes.\n\nChoice components support labels, help text, and custom content through slots, providing flexible option presentation within choice lists.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "selected", + "value": "boolean", + "description": "Whether the option is currently selected. Use this for controlled components where you manage the selection state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultSelected", + "value": "boolean", + "description": "The initial selected state for uncontrolled components. Use this when you want the option to start selected but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Choice extends PreactCustomElement implements ChoiceProps {\n accessor disabled: ChoiceProps['disabled'];\n get selected(): boolean;\n set selected(selected: ChoiceProps['selected']);\n accessor value: ChoiceProps['value'];\n accessor accessibilityLabel: ChoiceProps['accessibilityLabel'];\n accessor defaultSelected: ChoiceProps['defaultSelected'];\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "ChoiceList": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceList", + "description": "Configure the following properties on the choice list component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction. When `true`, the `disabled` property on any child choices is ignored.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple choices can be selected.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "values", + "value": "string[]", + "description": "An array of `value` attributes for the currently selected options. When provided, this property automatically sets the `selected` state on child option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$3@2409", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ChoiceList extends BaseClass$3 implements ChoiceListProps {\n accessor disabled: ChoiceListProps['disabled'];\n accessor name: ChoiceListProps['name'];\n accessor error: ChoiceListProps['error'];\n accessor details: ChoiceListProps['details'];\n accessor multiple: ChoiceListProps['multiple'];\n accessor label: ChoiceListProps['label'];\n accessor labelAccessibilityVisibility: ChoiceListProps['labelAccessibilityVisibility'];\n get values(): ChoiceListProps['values'];\n set values(values: ChoiceListProps['values']);\n /** @private */\n formResetCallback(): void;\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "Clickable": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Clickable", + "description": "Configure the following properties on the clickable component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the component is disabled, preventing clicks and focus. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You shouldapply disabled styling as needed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether the component is in a loading state, which indicates to assistive technology that an action is in progress and prevents interaction.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "target", + "value": "\"auto\" | AnyString | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"button\" | \"reset\" | \"submit\"", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "defaultValue": "'button'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class Clickable extends Clickable_base implements ClickableProps {\n accessor disabled: ClickableProps['disabled'];\n accessor loading: ClickableProps['loading'];\n accessor target: ClickableProps['target'];\n accessor href: ClickableProps['href'];\n accessor download: ClickableProps['download'];\n accessor type: ClickableProps['type'];\n constructor();\n}" + } + }, + "ClickableChip": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableChip", + "description": "Configure the following properties on the clickable chip component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "removable", + "value": "boolean", + "description": "Whether the chip displays a remove button for dismissal. When clicked, the `remove` callback fires.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hidden", + "value": "boolean", + "description": "Whether the chip is hidden from view. When using controlled component pattern with `removable` chips, update this property when the `remove` event fires. For non-removable chips, manually toggle this property to show or hide the chip.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the chip is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class ClickableChip\n extends ClickableChip_base\n implements ClickableChipProps\n{\n accessor color: ClickableChipProps['color'];\n accessor accessibilityLabel: ClickableChipProps['accessibilityLabel'];\n accessor removable: ClickableChipProps['removable'];\n accessor hidden: ClickableChipProps['hidden'];\n accessor disabled: ClickableChipProps['disabled'];\n accessor href: ClickableChipProps['href'];\n constructor();\n}" + } + }, + "ColorField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorField", + "description": "Configure the following properties on the color field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alpha", + "value": "boolean", + "description": "Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected color value. Accepts multiple input formats:\n\n- Hex: `#RGB`, `#RRGGBB`, `#RRGGBBAA` (3, 6, or 8 digits)\n- RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)\n- HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`\n\nReturns an empty string if the value is invalid. The `change` event always emits values in hex format.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setInternalValue", + "value": "(value: string, normalize: boolean) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\"", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ColorField\n extends PreactFieldElement\n implements ColorFieldProps\n{\n accessor alpha: ColorFieldProps['alpha'];\n get value(): string;\n set value(value: string);\n /** @private */\n formResetCallback(): void;\n constructor();\n /** @private */\n setInternalValue(value: string, normalize: boolean): void;\n}" + } + }, + "ColorPicker": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorPicker", + "description": "Configure the following properties on the color picker component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alpha", + "value": "boolean", + "description": "Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial color value when the field first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts interacting, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected color value. Accepts multiple input formats:\n\n- Hex: `#RGB`, `#RRGGBB`, `#RRGGBBAA` (3, 6, or 8 digits)\n- RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)\n- HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`\n\nReturns an empty string if the value is invalid. The `change` event always emits values in hex format.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "A callback that fires when the containing form is reset (using the form's `reset()` method or a reset button). When triggered, the component's `value` reverts to its `defaultValue`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$2@2510", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ColorPicker extends BaseClass$2 implements ColorPickerProps {\n accessor alpha: boolean;\n accessor name: string;\n accessor defaultValue: string;\n get value(): string;\n set value(value: string);\n /**\n * A callback that fires when the containing form is reset (using the form's `reset()` method or a reset button). When triggered, the component's `value` reverts to its `defaultValue`.\n */\n formResetCallback(): void;\n constructor();\n}" + } + }, + "DateField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DateField", + "description": "Configure the following properties on the date field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allow", + "value": "string", + "description": "Specifies which dates can be selected as a comma-separated list. An empty string (default) allows all dates.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `2024-02--2025`: February 2024 through end of 2025\n- `2024-05-09, 2024-05-11`: Only May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallow", + "value": "string", + "description": "Specifies which dates can't be selected as a comma-separated list. These dates are excluded from those specified in `allow`. An empty string (default) has no effect.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `--2024-02`: All dates before February 2024\n- `2024-05-09, 2024-05-11`: May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allowDays", + "value": "string", + "description": "Specifies which days of the week can be selected as a comma-separated list. Further restricts dates from `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (only weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallowDays", + "value": "string", + "description": "Specifies which days of the week can't be selected as a comma-separated list. Excludes days from `allowDays` and intersects with `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (no weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "SetAccessor", + "name": "view", + "value": "string", + "description": "The currently displayed month in `YYYY-MM` format. When changed, the `viewchange` callback is triggered. Defaults to `defaultView`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultView", + "value": "string", + "description": "The default month to display in `YYYY-MM` format. Used until the `view` callback is set by user interaction or programmatically. Defaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "DateAutocompleteField", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected date in `YYYY-MM-DD` format. An empty string means no date is selected.", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class DateField\n extends PreactFieldElement\n implements DateFieldProps\n{\n accessor allow: DateFieldProps['allow'];\n accessor disallow: DateFieldProps['disallow'];\n accessor allowDays: DateFieldProps['allowDays'];\n accessor disallowDays: DateFieldProps['disallowDays'];\n set view(view: string);\n get view(): string;\n accessor defaultView: DateFieldProps['defaultView'];\n constructor();\n}" + } + }, + "DateAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DateAutocompleteField", + "value": "'bday-day' | 'bday-month' | 'bday-year' | 'bday' | 'cc-expiry-month' | 'cc-expiry-year' | 'cc-expiry'", + "description": "Represents autocomplete values that are valid for date input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for date-based inputs.\n\nAvailable values:\n- `bday` - Complete birthday date\n- `bday-day` - Day component of a birthday (1-31)\n- `bday-month` - Month component of a birthday (1-12)\n- `bday-year` - Year component of a birthday (1990)\n- `cc-expiry` - Complete credit card expiration date\n- `cc-expiry-month` - Month component of a credit card expiration date (1-12)\n- `cc-expiry-year` - Year component of a credit card expiration date (2025)", + "isPublicDocs": true + } + }, + "DatePicker": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DatePicker", + "description": "Configure the following properties on the date picker component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultView", + "value": "string", + "description": "The default month to display in `YYYY-MM` format. Used until the `view` callback is set by user interaction or programmatically. Defaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "SetAccessor", + "name": "view", + "value": "string", + "description": "The currently displayed month in `YYYY-MM` format. When changed, the `viewchange` callback is triggered. Defaults to `defaultView`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allow", + "value": "string", + "description": "Specifies which dates can be selected as a comma-separated list. An empty string (default) allows all dates.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `2024-02--2025`: February 2024 through end of 2025\n- `2024-05-09, 2024-05-11`: Only May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallow", + "value": "string", + "description": "Specifies which dates can't be selected as a comma-separated list. These dates are excluded from those specified in `allow`. An empty string (default) has no effect.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `--2024-02`: All dates before February 2024\n- `2024-05-09, 2024-05-11`: May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allowDays", + "value": "string", + "description": "Specifies which days of the week can be selected as a comma-separated list. Further restricts dates from `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (only weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallowDays", + "value": "string", + "description": "Specifies which days of the week can't be selected as a comma-separated list. Excludes days from `allowDays` and intersects with `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (no weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"single\" | \"range\"", + "description": "The type of date selection allowed.\n\n- `single`: Select a single date\n- `range`: Select a date range", + "defaultValue": "\"single\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initially selected date(s) when the component first renders. An empty string means no date is initially selected.\n\n- Single date in `YYYY-MM-DD` format when `type` is set to `\"single\"`\n- Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `\"range\"`", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "SetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected date(s). An empty string means no date is selected.\n\n- Single date in `YYYY-MM-DD` format when `type` is set to `\"single\"`\n- Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `\"range\"`", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@dirtyStateSymbol@2554", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$1@2553", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class DatePicker extends BaseClass$1 implements DatePickerProps {\n accessor defaultView: string;\n set view(view: string);\n get view(): string;\n accessor allow: DatePickerProps['allow'];\n accessor disallow: DatePickerProps['disallow'];\n accessor allowDays: DatePickerProps['allowDays'];\n accessor disallowDays: DatePickerProps['disallowDays'];\n accessor type: DatePickerProps['type'];\n accessor defaultValue: DatePickerProps['defaultValue'];\n accessor name: DatePickerProps['name'];\n set value(value: string);\n get value(): string;\n /** @private */\n [dirtyStateSymbol]: boolean;\n /** @private */\n formResetCallback(): void;\n constructor();\n}" + } + }, + "DropZone": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DropZone", + "description": "Configure the following properties on the drop zone component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accept", + "value": "string", + "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:\n- A file extension starting with a period (\".\") character (e.g. .jpg, .pdf, .doc)\n- A valid MIME type string with no extensions\n\nIf omitted, all file types are accepted.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple files can be selected or dropped at once.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "This sets the input value for a file type, which cannot be set programatically, so it can only be reset.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "files", + "value": "File[]", + "description": "An array of File objects representing the files currently selected by the user.\n\nThis property is read-only and cannot be directly modified. To clear the selected files, set the `value` prop to an empty string or null.", + "defaultValue": "[]", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@setFiles@2589", + "value": "(files: File[]) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@getFileInput@2591", + "value": "() => HTMLInputElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals@2590", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class DropZone extends BaseClass implements DropZoneProps {\n accessor accept: DropZoneProps['accept'];\n accessor accessibilityLabel: DropZoneProps['accessibilityLabel'];\n accessor disabled: DropZoneProps['disabled'];\n accessor error: DropZoneProps['error'];\n accessor label: DropZoneProps['label'];\n accessor labelAccessibilityVisibility: DropZoneProps['labelAccessibilityVisibility'];\n accessor multiple: DropZoneProps['multiple'];\n accessor name: DropZoneProps['name'];\n accessor required: DropZoneProps['required'];\n get value(): string;\n /** This sets the input value for a file type, which cannot be set programatically, so it can only be reset. */\n set value(value: '' | null);\n get files(): File[];\n set files(files: File[]);\n /** @private */\n [setFiles](files: File[]): void;\n /** @private */\n [getFileInput](): ReplaceType<\n Element | null | undefined,\n Element,\n HTMLInputElement\n >;\n\n /** @private */\n formResetCallback(): void;\n constructor();\n}" + } + }, + "Divider": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Divider", + "description": "Configure the following properties on the divider component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "direction", + "value": "\"inline\" | \"block\"", + "description": "The orientation of the divider line, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `inline`: Horizontal divider for separating vertically stacked content\n- `block`: Vertical divider for separating horizontally arranged content", + "defaultValue": "'inline'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"strong\"", + "description": "The visual prominence of the divider line.\n\n- `base`: Standard divider for most separations (default)\n- `strong`: More prominent divider for major section breaks", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Divider extends PreactCustomElement implements DividerProps {\n accessor direction: DividerProps['direction'];\n accessor color: DividerProps['color'];\n constructor();\n}" + } + }, + "EmailField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "EmailField", + "description": "Configure the following properties on the email field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | EmailAutocompleteField | `section-${string} email` | `section-${string} home email` | `section-${string} mobile email` | `section-${string} fax email` | `section-${string} pager email` | \"shipping email\" | \"shipping home email\" | \"shipping mobile email\" | ... 16 more ... | `section-${string} billing p...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current email address value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as an email address format when the user finishes editing.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class EmailField\n extends PreactFieldElement\n implements EmailFieldProps\n{\n accessor autocomplete: EmailFieldProps['autocomplete'];\n accessor maxLength: EmailFieldProps['maxLength'];\n accessor minLength: EmailFieldProps['minLength'];\n /**\n * The current email address value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as an email address format when the user finishes editing.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "EmailAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "EmailAutocompleteField", + "value": "'email' | 'home email' | 'mobile email' | 'fax email' | 'pager email'", + "description": "Represents autocomplete values that are valid for email input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for email inputs.\n\nAvailable values:\n- `email` - Primary email address\n- `home email` - Home email address\n- `mobile email` - Mobile device email address\n- `fax email` - Fax machine email address\n- `pager email` - Pager device email address", + "isPublicDocs": true + } + }, + "Grid": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Grid", + "description": "Configure the following properties on the grid component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridTemplateColumns", + "value": "string", + "description": "The columns in the grid and their sizes.\n\nAccepts:\n- [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), such as `1fr auto`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported track sizing values as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridTemplateRows", + "value": "string", + "description": "The rows in the grid and their sizes.\n\nAccepts:\n- [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), such as `1fr auto`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported track sizing values as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "justifyItems", + "value": "\"\" | JustifyItemsKeyword", + "description": "Aligns the grid items along the inline axis.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignItems", + "value": "\"\" | AlignItemsKeyword", + "description": "Aligns the grid items along the block axis.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeItems", + "value": "AlignItemsKeyword | \"normal normal\" | \"normal stretch\" | \"normal baseline\" | \"normal first baseline\" | \"normal last baseline\" | \"normal start\" | \"normal end\" | ... 188 more ... | \"safe center safe center\"", + "description": "A shorthand property for `justify-items` and `align-items`.", + "defaultValue": "'normal normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "justifyContent", + "value": "\"\" | JustifyContentKeyword", + "description": "Aligns the grid along the inline axis. This overrides the inline value of `placeContent`.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignContent", + "value": "\"\" | AlignContentKeyword", + "description": "Aligns the grid along the block axis. This overrides the block value of `placeContent`.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeContent", + "value": "\"normal normal\" | \"normal stretch\" | \"normal start\" | \"normal end\" | \"normal center\" | \"normal unsafe start\" | \"normal unsafe end\" | \"normal unsafe center\" | \"normal safe start\" | ... 229 more ... | \"space-evenly space-evenly\"", + "description": "A shorthand property for `justify-content` and `align-content`.", + "defaultValue": "'normal normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gap", + "value": "MaybeResponsive>", + "description": "Adjusts spacing between elements.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value applied to both axes, such as `large-100`\n- A pair of values, such as `large-100 large-500`, to set the inline and block axes respectively\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "rowGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "s spacing between elements in the block axis. This overrides the row value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "columnGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "Adjusts spacing between elements in the inline axis. This overrides the column value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Grid extends BoxElement implements GridProps {\n constructor();\n accessor gridTemplateColumns: GridProps['gridTemplateColumns'];\n accessor gridTemplateRows: GridProps['gridTemplateRows'];\n accessor justifyItems: GridProps['justifyItems'];\n accessor alignItems: GridProps['alignItems'];\n accessor placeItems: GridProps['placeItems'];\n accessor justifyContent: GridProps['justifyContent'];\n accessor alignContent: GridProps['alignContent'];\n accessor placeContent: GridProps['placeContent'];\n accessor gap: GridProps['gap'];\n accessor rowGap: GridProps['rowGap'];\n accessor columnGap: GridProps['columnGap'];\n}" + } + }, + "JustifyItemsKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "JustifyItemsKeyword", + "value": "'normal' | 'stretch' | BaselinePosition | OverflowPosition | ContentPosition", + "description": "Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis.\n\nLearn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).", + "isPublicDocs": true + } + }, + "BaselinePosition": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BaselinePosition", + "value": "'baseline' | 'first baseline' | 'last baseline'", + "description": "Represents baseline alignment positions used to align items relative to their baselines.\n- `baseline`: Aligns to the baseline of the parent.\n- `first baseline`: Aligns to the first baseline of the parent.\n- `last baseline`: Aligns to the last baseline of the parent.", + "isPublicDocs": true + } + }, + "OverflowPosition": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "OverflowPosition", + "value": "`unsafe ${ContentPosition}` | `safe ${ContentPosition}`", + "description": "Represents content positioning with overflow behavior control. Use `safe` to prevent content from becoming inaccessible when it overflows, or `unsafe` to allow overflow regardless of accessibility.", + "isPublicDocs": true + } + }, + "ContentPosition": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ContentPosition", + "value": "'center' | 'start' | 'end'", + "description": "Defines the position of content along an axis.\n- `center`: Centers the content.\n- `start`: Aligns content to the start.\n- `end`: Aligns content to the end.", + "isPublicDocs": true + } + }, + "AlignItemsKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AlignItemsKeyword", + "value": "'normal' | 'stretch' | BaselinePosition | OverflowPosition | ContentPosition", + "description": "Align items sets the align-self value on all direct children as a group.\n\nLearn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).", + "isPublicDocs": true + } + }, + "JustifyContentKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "JustifyContentKeyword", + "value": "'normal' | ContentDistribution | OverflowPosition | ContentPosition", + "description": "Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container.\n\nLearn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).", + "isPublicDocs": true + } + }, + "ContentDistribution": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ContentDistribution", + "value": "'space-between' | 'space-around' | 'space-evenly' | 'stretch'", + "description": "Defines how space is distributed between and around content items in flex and grid layouts.\n- `space-between`: Distributes items evenly with the first item at the start and last at the end.\n- `space-around`: Distributes items evenly with equal space around each item.\n- `space-evenly`: Distributes items evenly with equal space between them.\n- `stretch`: Stretches items to fill the container.", + "isPublicDocs": true + } + }, + "AlignContentKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AlignContentKeyword", + "value": "'normal' | BaselinePosition | ContentDistribution | OverflowPosition | ContentPosition", + "description": "Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis.\n\nLearn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).", + "isPublicDocs": true + } + }, + "SpacingKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingKeyword", + "value": "SizeKeyword | 'none'", + "description": "Defines the spacing size between elements, using the standard size scale or `none` for no spacing.", + "isPublicDocs": true + } + }, + "GridItem": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "GridItem", + "description": "The grid item component represents a single cell within a grid layout, allowing you to control how content is positioned and sized within the grid. Use grid item as a child of grid to specify column span, row span, and positioning for individual content areas.\n\nGrid item supports precise placement control through column and row properties, enabling you to create complex layouts where different items occupy varying amounts of space or appear in specific grid positions.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridColumn", + "value": "\"auto\" | `span ${number}`", + "description": "The number of columns the item will span across.\n\nLearn more about the [grid-column property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridRow", + "value": "\"auto\" | `span ${number}`", + "description": "The number of rows the item will span across.\n\nLearn more about the [grid-row property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class GridItem extends BoxElement implements GridItemProps {\n accessor gridColumn: GridItemProps['gridColumn'];\n accessor gridRow: GridItemProps['gridRow'];\n constructor();\n}" + } + }, + "Heading": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Heading", + "description": "Configure the following properties on the heading component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "\"none\" | \"presentation\" | \"heading\"", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `none`: Completely hides the element and its content from assistive technologies\n- `presentation`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.\n- `img`: Identifies the element as an image that conveys meaningful information to users.", + "defaultValue": "'heading'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "lineClamp", + "value": "number", + "description": "The maximum number of lines to display before truncating the text content.\n\nLearn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).", + "defaultValue": "Infinity - no truncation is applied", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Heading extends PreactCustomElement implements HeadingProps {\n accessor accessibilityRole: HeadingProps['accessibilityRole'];\n accessor lineClamp: HeadingProps['lineClamp'];\n accessor accessibilityVisibility: HeadingProps['accessibilityVisibility'];\n constructor();\n}" + } + }, + "Icon": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Icon", + "description": "Configure the following properties on the icon component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"subdued\"", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\" | \"neutral\" | \"caution\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `caution`: Advisory notices that need attention.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "The icon to display from the icon library.\n\nSet to a valid icon name to display that icon. To hide the icon completely, use an empty string `''`. To reserve the icon's space without displaying an icon, use `'empty'`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"base\"", + "description": "The size of the icon.\n\n- `small`: Smaller icon suitable for inline use within text or compact UI elements.\n- `base`: Default size that works well for standalone icons and standard use cases.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Icon extends PreactCustomElement implements IconProps {\n accessor color: IconProps['color'];\n accessor tone: IconProps['tone'];\n accessor type: IconProps['type'];\n accessor size: IconProps['size'];\n accessor interestFor: string;\n constructor();\n}" + } + }, + "Image": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Image", + "description": "Configure the following properties on the image component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. This overrides the `src` property.\n\nLearn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes.\n\nLearn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "defaultValue": "``", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "aspectRatio", + "value": "`${number}` | `${number}/${number}` | `${number}/ ${number}` | `${number} /${number}` | `${number} / ${number}`", + "description": "The aspect ratio of the image.\n\nThe rendering of the image will depend on the `inlineSize` value:\n\n- `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space.\n- `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored.\n\nFor 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`.\n\nLearn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).", + "defaultValue": "'1/1'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "objectFit", + "value": "\"contain\" | \"cover\"", + "description": "The image resizing behavior to fit within its container.\n\n- `contain`: Scales the image to fit within the container while maintaining its aspect ratio. The entire image is visible, but might leave empty space.\n- `cover`: Scales the image to fill the entire container while maintaining its aspect ratio. The image might be cropped to fit.\n\nThe image is always positioned in the center of the container.\n\nLearn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).", + "defaultValue": "'contain'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "\"eager\" | \"lazy\"", + "description": "The loading strategy for the image.\n\n- `eager`: Immediately loads the image, irrespective of its position within the visible viewport.\n- `lazy`: Delays loading the image until it approaches a specified distance from the viewport.\n\nLearn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).", + "defaultValue": "'eager'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "\"none\" | \"presentation\" | \"img\"", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `none`: Completely hides the element and its content from assistive technologies\n- `presentation`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.\n- `img`: Identifies the element as an image that conveys meaningful information to users.", + "defaultValue": "'img'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "\"auto\" | \"fill\"", + "description": "The displayed inline width of the image.\n\n- `fill`: the image will takes up 100% of the available inline size.\n- `auto`: the image will be displayed at its natural size.\n\nLearn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).", + "defaultValue": "'fill'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied around the image using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border around the image. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border around the image, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border around the image using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the image's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Image extends PreactCustomElement implements ImageProps {\n accessor src: ImageProps['src'];\n accessor srcSet: ImageProps['srcSet'];\n accessor sizes: ImageProps['sizes'];\n accessor alt: ImageProps['alt'];\n accessor aspectRatio: ImageProps['aspectRatio'];\n accessor objectFit: ImageProps['objectFit'];\n accessor loading: ImageProps['loading'];\n accessor accessibilityRole: ImageProps['accessibilityRole'];\n accessor inlineSize: ImageProps['inlineSize'];\n /**\n * A border applied around the image using shorthand syntax to specify width, color, and style in a single property.\n */\n accessor border: ImageProps['border'];\n /**\n * The thickness of the border around the image. When set, this overrides the width value specified in the `border` property.\n */\n accessor borderWidth: ImageProps['borderWidth'];\n /**\n * The visual style of the border around the image, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.\n */\n accessor borderStyle: ImageProps['borderStyle'];\n /**\n * The color of the border around the image using the design system's color scale. When set, this overrides the color value specified in the `border` property.\n */\n accessor borderColor: ImageProps['borderColor'];\n /**\n * The roundedness of the image's corners using the design system's radius scale.\n */\n accessor borderRadius: ImageProps['borderRadius'];\n constructor();\n}" + } + }, + "Link": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Link", + "description": "Configure the following properties on the link component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"critical\" | \"auto\" | \"neutral\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "target", + "value": "\"auto\" | AnyString | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class Link extends Link_base implements LinkProps {\n accessor tone: LinkProps['tone'];\n accessor accessibilityLabel: LinkProps['accessibilityLabel'];\n accessor href: LinkProps['href'];\n accessor target: LinkProps['target'];\n accessor download: LinkProps['download'];\n accessor lang: LinkProps['lang'];\n constructor();\n}" + } + }, + "ListItem": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ListItem", + "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ListItem extends PreactCustomElement implements ListItemProps {\n constructor();\n}" + } + }, + "Menu": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Menu", + "description": "Configure the following properties on the menu component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Menu extends PreactOverlayElement implements MenuProps {\n accessor accessibilityLabel: string;\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "MoneyField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MoneyField", + "description": "Configure the following properties on the money field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "-Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current monetary value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string representing the amount in the store's currency.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "string", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class MoneyField\n extends PreactFieldElement\n implements MoneyFieldProps\n{\n accessor max: MoneyFieldProps['max'];\n accessor min: MoneyFieldProps['min'];\n /**\n * The current monetary value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string representing the amount in the store's currency.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "NumberField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "NumberField", + "description": "Configure the following properties on the number field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current numeric value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string (decimal or integer).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inputMode", + "value": "\"decimal\" | \"numeric\"", + "description": "The type of virtual keyboard to display on mobile devices.\n\n- `decimal`: Shows a numeric keyboard with a decimal point, suitable for prices or measurements.\n- `numeric`: Shows a numeric keyboard without a decimal point, suitable for whole numbers like quantities.\n\nLearn more about the [inputmode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).", + "defaultValue": "'decimal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "step", + "value": "number", + "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.", + "defaultValue": "1", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "-Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "prefix", + "value": "string", + "description": "A non-editable text value 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`.\n\nThis text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "suffix", + "value": "string", + "description": "A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n\nThis text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | NumberAutocompleteField | `section-${string} one-time-code` | `section-${string} cc-number` | `section-${string} cc-csc` | \"shipping one-time-code\" | \"shipping cc-number\" | \"shipping cc-csc\" | \"billing one-time-code\" | ... 7 more ... | `section-${string} billing cc-csc`", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class NumberField\n extends PreactFieldElement\n implements NumberFieldProps\n{\n /**\n * The current numeric value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string (decimal or integer).\n */\n get value(): string;\n set value(value: string);\n accessor inputMode: NumberFieldProps['inputMode'];\n accessor step: NumberFieldProps['step'];\n accessor max: NumberFieldProps['max'];\n accessor min: NumberFieldProps['min'];\n accessor prefix: NumberFieldProps['prefix'];\n accessor suffix: NumberFieldProps['suffix'];\n constructor();\n}" + } + }, + "NumberAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "NumberAutocompleteField", + "value": "'one-time-code' | 'cc-number' | 'cc-csc'", + "description": "Represents autocomplete values that are valid for number input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for numeric inputs.\n\nAvailable values:\n- `one-time-code` - One-time codes for authentication (OTP, 2FA codes)\n- `cc-number` - Credit card number\n- `cc-csc` - Credit card security code (CVV/CVC)", + "isPublicDocs": true + } + }, + "Option": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Option", + "description": "Represents a single option within a select component. Use only as a child of s-select components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "selected", + "value": "boolean", + "description": "Whether the option is currently selected. Use this for controlled components where you manage the selection state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultSelected", + "value": "boolean", + "description": "The initial selected state for uncontrolled components. Use this when you want the option to start selected but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Option extends PreactCustomElement implements OptionProps {\n accessor selected: OptionProps['selected'];\n accessor defaultSelected: OptionProps['defaultSelected'];\n accessor value: OptionProps['value'];\n accessor disabled: OptionProps['disabled'];\n constructor();\n}" + } + }, + "OptionGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OptionGroup", + "description": "Represents a group of options within a select component. Use only as a child of `s-select` components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the options within this group can be selected or not.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The user-facing label for this group of options.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class OptionGroup\n extends PreactCustomElement\n implements OptionGroupProps\n{\n accessor disabled: OptionGroupProps['disabled'];\n accessor label: OptionGroupProps['label'];\n constructor();\n}" + } + }, + "OrderedList": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OrderedList", + "description": "Configure the following properties on the ordered list component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class OrderedList\n extends PreactCustomElement\n implements OrderedListProps\n{\n constructor();\n}" + } + }, + "Paragraph": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Paragraph", + "description": "Configure the following properties on the paragraph component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "fontVariantNumeric", + "value": "\"auto\" | \"normal\" | \"tabular-nums\"", + "description": "The rendering style for numbers in the font.\n\n- `auto`: Inherits the setting from the parent element.\n- `normal`: Uses the font's default numeric glyphs.\n- `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n\nLearn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "lineClamp", + "value": "number", + "description": "The maximum number of lines to display before truncating the text content.\n\nLearn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).", + "defaultValue": "Infinity - no truncation is applied", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"caution\"", + "description": "The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.\n\n- `info`: Informational content or helpful tips (blue).\n- `success`: Positive outcomes or successful states (green).\n- `warning`: Important warnings about potential issues (orange).\n- `critical`: Urgent problems or destructive actions (red).\n- `caution`: Advisory notices that need attention (yellow).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"subdued\"", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "dir", + "value": "\"\" | \"auto\" | \"ltr\" | \"rtl\"", + "description": "Indicates the directionality of the element’s text.\n\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n- `auto`: The user agent determines the direction based on the content.\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Paragraph extends PreactCustomElement implements ParagraphProps {\n accessor fontVariantNumeric: ParagraphProps['fontVariantNumeric'];\n accessor lineClamp: ParagraphProps['lineClamp'];\n /**\n * The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.\n *\n * - `info`: Informational content or helpful tips (blue).\n * - `success`: Positive outcomes or successful states (green).\n * - `warning`: Important warnings about potential issues (orange).\n * - `critical`: Urgent problems or destructive actions (red).\n * - `caution`: Advisory notices that need attention (yellow).\n */\n accessor tone: ParagraphProps['tone'];\n\n accessor color: ParagraphProps['color'];\n accessor dir: ParagraphProps['dir'];\n accessor accessibilityVisibility: ParagraphProps['accessibilityVisibility'];\n constructor();\n}" + } + }, + "PasswordField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PasswordField", + "description": "Configure the following properties on the password field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current password value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value is masked in the UI for security.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | PasswordAutocompleteField | `section-${string} current-password` | `section-${string} new-password` | \"shipping current-password\" | \"shipping new-password\" | \"billing current-password\" | \"billing new-password\" | `section-${string} shipping current-password` | `section-${string} shipping new-password` | `section-${string} billing current-password` | `section-${string} billing new-password`", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class PasswordField\n extends PreactFieldElement\n implements PasswordFieldProps\n{\n accessor maxLength: PasswordFieldProps['maxLength'];\n accessor minLength: PasswordFieldProps['minLength'];\n /**\n * The current password value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value is masked in the UI for security.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "PasswordAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PasswordAutocompleteField", + "value": "'current-password' | 'new-password'", + "description": "Represents autocomplete values that are valid for password input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for password inputs.\n\nAvailable values:\n- `current-password` - Existing password for login or authentication\n- `new-password` - New password when creating an account or changing password", + "isPublicDocs": true + } + }, + "QueryContainer": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "QueryContainer", + "description": "Configure the following properties on the query container component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "containerName", + "value": "string", + "description": "An identifier for this container that you can reference in CSS container queries to apply styles based on this specific container's size.\n\nAll query container components automatically receive a container name of `s-default`. You can omit the container name in your queries, so `@container (inline-size <= 300px)` is equivalent to `@container s-default (inline-size <= 300px)`.\n\nWhen you provide a custom `containerName`, it's added alongside `s-default`. For example, `containerName=\"product-card\"` results in `s-default product-card` being set on the `container-name` CSS property, allowing you to target this container with `@container product-card (inline-size <= 300px)`.\n\nLearn more about the [container-name property](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name).", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class QueryContainer\n extends PreactCustomElement\n implements QueryContainerProps\n{\n accessor containerName: QueryContainerProps['containerName'];\n /** @private */\n static globalStylesApplied: boolean;\n constructor();\n}" + } + }, + "SearchField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SearchField", + "description": "Configure the following properties on the search field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current search query value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | TextAutocompleteField | `section-${string} one-time-code` | \"shipping one-time-code\" | \"billing one-time-code\" | `section-${string} shipping one-time-code` | `section-${string} billing one-time-code` | `section-${string} language` | `section-${string} organization` | `section-${string} name` | ... 141...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class SearchField\n extends PreactFieldElement\n implements SearchFieldProps\n{\n accessor maxLength: SearchFieldProps['maxLength'];\n accessor minLength: SearchFieldProps['minLength'];\n /**\n * The current search query value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "TextAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextAutocompleteField", + "value": "'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'", + "description": "Represents autocomplete values that are valid for text input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for text-based inputs.\n\nAvailable values:\n- `name` - Full name\n- `given-name` - First name\n- `additional-name` - Middle name\n- `family-name` - Last name\n- `nickname` - Nickname or handle\n- `username` - Username for login\n- `honorific-prefix` - Name prefix (Mr., Mrs., Dr.)\n- `honorific-suffix` - Name suffix (Jr., Sr., III)\n- `organization` - Company or organization name\n- `organization-title` - Job title or position\n- `address-line1` - Street address (first line)\n- `address-line2` - Street address (second line)\n- `address-line3` - Street address (third line)\n- `address-level1` - State or province\n- `address-level2` - City or town\n- `address-level3` - District or locality\n- `address-level4` - Neighborhood or suburb\n- `street-address` - Complete street address (multi-line)\n- `postal-code` - Postal or ZIP code\n- `country` - Country code (US, CA, GB)\n- `country-name` - Country name (United States, Canada)\n- `language` - Preferred language\n- `sex` - Gender or sex\n- `one-time-code` - One-time codes for authentication\n- `transaction-currency` - Currency code (USD, EUR, GBP)\n- `cc-name` - Name on credit card\n- `cc-given-name` - First name on credit card\n- `cc-additional-name` - Middle name on credit card\n- `cc-family-name` - Last name on credit card\n- `cc-type` - Credit card type (Visa, Mastercard)", + "isPublicDocs": true + } + }, + "Section": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Section", + "description": "Configure the following properties on the section component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "\"base\" | \"none\"", + "description": "The padding applied to all edges of the element.\n\n- `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context.\n- `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.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Section extends PreactCustomElement implements SectionProps {\n constructor();\n /** @private */\n connectedCallback(): void;\n accessor accessibilityLabel: SectionProps['accessibilityLabel'];\n accessor heading: SectionProps['heading'];\n accessor padding: SectionProps['padding'];\n}" + } + }, + "Select": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Select", + "description": "Configure the following properties on the select component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "An icon displayed inside the field to provide visual context about the expected input or field purpose. Commonly used for search fields, currency inputs, or to indicate field type. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "A lifecycle callback that fires when the component is removed from the DOM. Performs cleanup operations.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The value of the currently selected option. When setting this property programmatically, it updates which option appears selected in the dropdown. When reading it, you get the `value` attribute of the currently selected option component.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@usedFirstOptionSymbol@3004", + "value": "boolean", + "description": "A flag used to determine if no value or defaultValue was set, in which case the first non-disabled option was used.\n\nThis is important because we need to use the placeholder in these situations, even though the first value will be submitted as part of the form.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@hasInitialValueSymbol@3005", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Select extends PreactInputElement implements SelectProps {\n accessor icon: SelectProps['icon'];\n accessor details: SelectProps['details'];\n accessor error: SelectProps['error'];\n accessor label: SelectProps['label'];\n accessor placeholder: SelectProps['placeholder'];\n accessor required: SelectProps['required'];\n accessor labelAccessibilityVisibility: SelectProps['labelAccessibilityVisibility'];\n /** @private */\n connectedCallback(): void;\n /**\n * A lifecycle callback that fires when the component is removed from the DOM. Performs cleanup operations.\n * @private\n */\n disconnectedCallback(): void;\n constructor();\n /**\n * A flag used to determine if no value or defaultValue was set, in which case the first non-disabled option was used.\n *\n * This is important because we need to use the placeholder in these situations, even though the first value will be submitted as part of the form.\n * @private\n */\n [usedFirstOptionSymbol]: boolean;\n /**\n * @private\n */\n [hasInitialValueSymbol]: boolean;\n /**\n * The value of the currently selected option. When setting this property programmatically, it updates which option appears selected in the dropdown. When reading it, you get the `value` attribute of the currently selected option component.\n */\n get value(): string;\n set value(value: string);\n /** @private */\n formResetCallback(): void;\n}" + } + }, + "Spinner": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Spinner", + "description": "Configure the following properties on the spinner component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"base\" | \"large\" | \"large-100\"", + "description": "The size of the loading spinner.\n\n- `base`: Default size suitable for inline loading indicators or standard UI contexts.\n- `large`: Larger spinner for more prominent loading states.\n- `large-100`: Extra large spinner for full-page or emphasized loading states.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Spinner extends PreactCustomElement implements SpinnerProps {\n accessor accessibilityLabel: string;\n accessor size: SpinnerProps['size'];\n constructor();\n}" + } + }, + "Stack": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Stack", + "description": "Configure the following properties on the stack component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "direction", + "value": "MaybeResponsive<\"inline\" | \"block\">", + "description": "The direction in which the stack's children are placed within the stack.\n\nAccepts:\n- A single value, either `inline` or `block`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported direction values as a query value", + "defaultValue": "'block'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "justifyContent", + "value": "JustifyContentKeyword", + "description": "Controls the distribution of children along the inline axis (horizontally in horizontal writing modes).\n\nUse this to position items along the primary axis of the stack - horizontally for inline stacks or vertically for block stacks when wrapped into multiple lines.", + "defaultValue": "'normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignItems", + "value": "AlignItemsKeyword", + "description": "Controls the alignment of children along the block axis (vertically in horizontal writing modes).\n\nUse this to align items perpendicular to the stack direction - vertically for inline stacks or horizontally for block stacks.", + "defaultValue": "'normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignContent", + "value": "AlignContentKeyword", + "description": "Controls the distribution of lines along the block axis when content wraps into multiple lines.\n\nThis property only affects stacks with wrapping content. For single-line stacks, use `alignItems` instead.", + "defaultValue": "'normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gap", + "value": "MaybeResponsive>", + "description": "Adjusts spacing between elements.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value applied to both axes, such as `large-100`\n- A pair of values, such as `large-100 large-500`, to set the inline and block axes respectively\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "rowGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "Adjusts spacing between elements in the block axis. This overrides the row value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "columnGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "Adjusts spacing between elements in the inline axis. This overrides the column value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Stack extends BoxElement implements StackProps {\n constructor();\n accessor direction: StackProps['direction'];\n accessor justifyContent: StackProps['justifyContent'];\n accessor alignItems: StackProps['alignItems'];\n accessor alignContent: StackProps['alignContent'];\n accessor gap: StackProps['gap'];\n accessor rowGap: StackProps['rowGap'];\n accessor columnGap: StackProps['columnGap'];\n}" + } + }, + "Switch": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Switch", + "description": "Configure the following properties on the switch component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked. Use this for controlled components where you manage the checked state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The value used in form data when the checkbox is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultChecked", + "value": "boolean", + "description": "The initial checked state for uncontrolled components. Use this when you want the control to start checked but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "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.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Switch extends PreactCheckboxElement implements SwitchProps {\n accessor labelAccessibilityVisibility: SwitchProps['labelAccessibilityVisibility'];\n constructor();\n}" + } + }, + "Table": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Table", + "description": "Configure the following properties on the table component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "variant", + "value": "\"auto\" | \"list\"", + "description": "The layout variant of the table component.\n\n- `list`: Always displays as a list layout.\n- `table`: Always displays as a traditional table layout.\n- `auto`: Automatically displays as a table on wide screens and as a list on narrow screens.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table. When `true`, the table might be in an inert state that prevents user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paginate", + "value": "boolean", + "description": "Whether to use pagination controls.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hasPreviousPage", + "value": "boolean", + "description": "Whether there's a previous page of data.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hasNextPage", + "value": "boolean", + "description": "Whether there's an additional page of data.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@actualTableVariantSymbol@3080", + "value": "AddedContext", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@tableHeadersSharedDataSymbol@3081", + "value": "AddedContext<{ listSlot: ListSlotType; textContent: string; format: HeaderFormat; }[]>", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Table extends PreactCustomElement implements TableProps {\n accessor variant: TableProps['variant'];\n accessor loading: TableProps['loading'];\n accessor paginate: TableProps['paginate'];\n accessor hasPreviousPage: TableProps['hasPreviousPage'];\n accessor hasNextPage: TableProps['hasNextPage'];\n /**\n * @private\n * The actual table variant, which is either 'table' or 'list'.\n */\n [actualTableVariantSymbol]: AddedContext;\n /** @private */\n [tableHeadersSharedDataSymbol]: AddedContext<\n {\n listSlot: TableHeaderProps['listSlot'];\n textContent: string;\n format: HeaderFormat;\n }[]\n >;\n\n constructor();\n}" + } + }, + "AddedContext": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AddedContext", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "T", + "description": "The current context value.\n\nThe new context value to set, which will notify all consumers." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "(type: string, callback: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions) => void", + "description": "The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "(type: string, callback: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions) => void", + "description": "The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + } + ], + "value": "declare class AddedContext extends EventTarget {\n constructor(defaultValue: T);\n /**\n * The current context value.\n */\n get value(): T;\n /**\n * The new context value to set, which will notify all consumers.\n */\n set value(value: T);\n}" + } + }, + "ActualTableVariant": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActualTableVariant", + "value": "'table' | 'list'", + "description": "Represents the actual rendered variant of a table component.\n- `table`: Displays as a traditional table layout.\n- `list`: Displays as a list layout.", + "isPublicDocs": true + } + }, + "ListSlotType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ListSlotType", + "value": "'primary' | 'secondary' | 'kicker' | 'inline' | 'labeled'", + "description": "Represents the semantic type of content slots within list items.\n\n- `primary`: The main content or title of the list item.\n- `secondary`: Supporting or descriptive content below the primary content.\n- `kicker`: A small label or tag displayed above the primary content.\n- `inline`: Content displayed inline with the primary content.\n- `labeled`: Content with an associated label.", + "isPublicDocs": true + } + }, + "HeaderFormat": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "HeaderFormat", + "value": "'base' | 'numeric' | 'currency'", + "description": "Represents the format options for table headers that control styling and alignment of column content.\n\nAvailable values:\n- `base`: Standard format for text columns\n- `currency`: Right-aligned format for monetary values\n- `numeric`: Right-aligned format for numeric values", + "isPublicDocs": true + } + }, + "TableBody": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableBody", + "description": "The table body component represents the main content area of a table, containing the data rows. Use table body as a child of table to structure your table data, with each table row within the body representing a single record or entry.\n\nTable body must contain table row components, which in turn contain table cell components for the actual data values.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableBody extends PreactCustomElement implements TableBodyProps {\n constructor();\n}" + } + }, + "TableCell": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableCell", + "description": "The table cell component represents a single data cell within a table row. Use table cell as a child of table row to display individual data values, with each cell corresponding to a column in the table.\n\nTable cell automatically inherits styling and alignment from its parent table structure and supports text content or other inline components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "__@headerFormatSymbol@3103", + "value": "HeaderFormat", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableCell extends PreactCustomElement implements TableCellProps {\n constructor();\n /** @private */\n get [headerFormatSymbol](): HeaderFormat;\n /** @private */\n set [headerFormatSymbol](format: HeaderFormat);\n}" + } + }, + "TableHeader": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeader", + "description": "The table header component represents a single column header within a table header row. Use table header as a child of table header row to define column headings and optionally enable column sorting.\n\nTable header provides semantic meaning for screen readers and can include sorting controls when configured. Each header corresponds to a column in the table body.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "listSlot", + "value": "ListSlotType", + "description": "The content designation for this column when the table displays in list variant on mobile devices.", + "defaultValue": "'labeled'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "format", + "value": "HeaderFormat", + "description": "The format of the column that controls styling and alignment of cell content.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableHeader\n extends PreactCustomElement\n implements TableHeaderProps\n{\n accessor listSlot: TableHeaderProps['listSlot'];\n accessor format: TableHeaderProps['format'];\n constructor();\n}" + } + }, + "TableHeaderRow": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeaderRow", + "description": "The table header row component represents the header row of a table, containing column headings. Use table header row as the first child of table (before table body) to define the table structure and provide column labels.\n\nTable header row must contain table header components for each column. These headers provide context for the data columns and can support sorting functionality.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableHeaderRow\n extends PreactCustomElement\n implements TableHeaderRowProps\n{\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "TableRow": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableRow", + "description": "The table row component represents a single row of data within a table body. Use table row as a child of table body to structure individual records or entries in the table.\n\nTable row must contain table cell components, with each cell representing a data value for the corresponding column. The number of cells should match the number of headers in the table.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "clickDelegate", + "value": "string", + "description": "The ID of an interactive element, such as `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.\n\nThis 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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableRow extends PreactCustomElement implements TableRowProps {\n constructor();\n accessor clickDelegate: string;\n}" + } + }, + "Text": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Text", + "description": "Configure the following properties on the text component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "fontVariantNumeric", + "value": "\"auto\" | \"normal\" | \"tabular-nums\"", + "description": "The rendering style for numbers in the font.\n\n- `auto`: Inherits the setting from the parent element.\n- `normal`: Uses the font's default numeric glyphs.\n- `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n\nLearn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"subdued\"", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\" | \"neutral\" | \"caution\"", + "description": "The semantic tone that's applied to the text, which changes its color to convey meaning.\n\n- `info`: Informational content or helpful tips (blue).\n- `success`: Positive outcomes or successful states (green).\n- `warning`: Important warnings about potential issues (orange).\n- `critical`: Urgent problems or destructive actions (red).\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent (gray).\n- `caution`: Advisory notices that need attention (yellow).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"strong\" | \"generic\" | \"address\" | \"redundant\"", + "description": "The semantic type and styling treatment for the text content.\n\n- `strong`: Emphasizes the text with strong importance, typically displayed in bold.\n- `generic`: Standard text with no special semantic meaning or styling.\n- `address`: Marks the text as contact information, such as a physical or email address.\n- `redundant`: Indicates the text is redundant or duplicated information for screen reader context.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "dir", + "value": "\"\" | \"auto\" | \"ltr\" | \"rtl\"", + "description": "Indicates the directionality of the element’s text.\n\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n- `auto`: The user agent determines the direction based on the content.\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Text extends PreactCustomElement implements TextProps {\n accessor fontVariantNumeric: TextProps['fontVariantNumeric'];\n accessor color: TextProps['color'];\n /**\n * The semantic tone that's applied to the text, which changes its color to convey meaning.\n *\n * - `info`: Informational content or helpful tips (blue).\n * - `success`: Positive outcomes or successful states (green).\n * - `warning`: Important warnings about potential issues (orange).\n * - `critical`: Urgent problems or destructive actions (red).\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent (gray).\n * - `caution`: Advisory notices that need attention (yellow).\n */\n accessor tone: TextProps['tone'];\n /**\n * The semantic type and styling treatment for the text content.\n *\n * - `strong`: Emphasizes the text with strong importance, typically displayed in bold.\n * - `generic`: Standard text with no special semantic meaning or styling.\n * - `address`: Marks the text as contact information, such as a physical or email address.\n * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context.\n */\n accessor type: TextProps['type'];\n accessor dir: TextProps['dir'];\n accessor accessibilityVisibility: TextProps['accessibilityVisibility'];\n accessor interestFor: string;\n constructor();\n}" + } + }, + "TextArea": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextArea", + "description": "Configure the following properties on the text area component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "rows", + "value": "number", + "description": "A number of visible text lines.", + "defaultValue": "2", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | TextAutocompleteField | `section-${string} one-time-code` | \"shipping one-time-code\" | \"billing one-time-code\" | `section-${string} shipping one-time-code` | `section-${string} billing one-time-code` | `section-${string} language` | `section-${string} organization` | `section-${string} name` | ... 141...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TextArea\n extends PreactFieldElement\n implements TextAreaProps\n{\n accessor maxLength: TextAreaProps['maxLength'];\n accessor minLength: TextAreaProps['minLength'];\n accessor rows: TextAreaProps['rows'];\n /**\n * The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "TextField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextField", + "description": "Configure the following properties on the text field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 542 more ... | AnyString", + "description": "An icon displayed inside the field to provide visual context about the expected input or field purpose. Commonly used for search fields, currency inputs, or to indicate field type. Accepts any icon name from the icon library or a custom string identifier.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "prefix", + "value": "string", + "description": "A non-editable text value 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`.\n\nThis text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "suffix", + "value": "string", + "description": "A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n\nThis text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | TextAutocompleteField | `section-${string} one-time-code` | \"shipping one-time-code\" | \"billing one-time-code\" | `section-${string} shipping one-time-code` | `section-${string} billing one-time-code` | `section-${string} language` | `section-${string} organization` | `section-${string} name` | ... 141...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TextField\n extends PreactFieldElement\n implements TextFieldProps\n{\n accessor icon: TextFieldProps['icon'];\n accessor maxLength: TextFieldProps['maxLength'];\n accessor minLength: TextFieldProps['minLength'];\n accessor prefix: TextFieldProps['prefix'];\n accessor suffix: TextFieldProps['suffix'];\n /**\n * The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "Thumbnail": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Thumbnail", + "description": "Configure the following properties on the thumbnail component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "defaultValue": "``", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"small-200\" | \"small-100\" | \"base\" | \"large\" | \"large-100\"", + "description": "The size of the product thumbnail image.\n\n- `small-200`: Smallest thumbnail size, ideal for compact product lists or tables.\n- `small-100`: Very small thumbnail, suitable for dense layouts.\n- `small`: Small thumbnail for space-constrained contexts.\n- `base`: Default size that balances visibility and space efficiency.\n- `large`: Larger thumbnail for featured products or detailed views.\n- `large-100`: Extra large thumbnail for prominent product display.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Thumbnail extends PreactCustomElement implements ThumbnailProps {\n accessor src: ThumbnailProps['src'];\n accessor alt: ThumbnailProps['alt'];\n accessor size: ThumbnailProps['size'];\n constructor();\n}" + } + }, + "Tooltip": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Tooltip", + "description": "Configure the following properties on the tooltip component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Tooltip extends PreactOverlayElement implements TooltipProps {\n constructor();\n}" + } + }, + "UnorderedList": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "UnorderedList", + "description": "Configure the following properties on the unordered list component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class UnorderedList\n extends PreactCustomElement\n implements UnorderedListProps\n{\n constructor();\n}" + } + }, + "URLField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "URLField", + "description": "Configure the following properties on the URL field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | `section-${string} url` | `section-${string} photo` | `section-${string} impp` | `section-${string} home impp` | `section-${string} mobile impp` | `section-${string} fax impp` | `section-${string} pager impp` | \"shipping url\" | \"shipping photo\" | \"shipping impp\" | \"shipping home impp\" | \"shipping mobi...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current URL value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as a URL format when the user finishes editing.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class URLField\n extends PreactFieldElement\n implements URLFieldProps\n{\n accessor autocomplete: URLFieldProps['autocomplete'];\n accessor maxLength: URLFieldProps['maxLength'];\n accessor minLength: URLFieldProps['minLength'];\n /**\n * The current URL value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as a URL format when the user finishes editing.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "AdminAction": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminAction", + "description": "Configure the following properties on the admin action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The text to use as the Action modal's title. If not provided, the name of the extension will be used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether the action is in a loading state, such as during initial page load or when the action is being opened. When `true`, the action might be in an inert state that prevents user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class AdminAction\n extends PreactCustomElement\n implements AdminActionProps\n{\n /**\n * The text to use as the Action modal's title. If not provided, the name of the extension will be used.\n */\n heading: string;\n /**\n * Whether the action is in a loading state, such as during initial page load or when the action is being opened.\n * When `true`, the action might be in an inert state that prevents user interaction.\n */\n loading: boolean;\n constructor();\n}" + } + }, + "RunnableExtension": { + "src/extension.ts": { + "filePath": "src/extension.ts", + "name": "RunnableExtension", + "description": "Defines the structure of a runnable extension, which executes logic and returns data without rendering UI.", + "members": [ + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "api", + "value": "Api", + "description": "The API object providing access to extension capabilities and methods. The specific API type depends on the extension target and determines what functionality is available to your extension." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "output", + "value": "Output | Promise", + "description": "The function output. Your extension function should return the expected output type or a Promise that resolves to that type. The output type is determined by your specific extension target and use case." + } + ], + "value": "export interface RunnableExtension {\n /**\n * The API object providing access to extension capabilities and methods. The specific API type depends on the extension target and determines what functionality is available to your extension.\n */\n api: Api;\n /**\n * The function output. Your extension function should return the expected output type or a Promise that resolves to that type. The output type is determined by your specific extension target and use case.\n */\n output: Output | Promise;\n}" + } + }, + "ShouldRenderApi": { + "src/surfaces/admin/api/should-render/should-render.ts": { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "name": "ShouldRenderApi", + "description": "The `ShouldRenderApi` object provides methods for controlling action extension visibility. Access the following properties on the `ShouldRenderApi` object to determine whether an associated action should appear based on the current context.", + "members": [ + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this data to determine whether the action extension should appear based on the current context." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ShouldRenderApi\n extends StandardApi {\n /**\n * An array of currently viewed or selected resource identifiers. Use this data to determine whether the action extension should appear based on the current context.\n */\n data: Data;\n}" + } + }, + "ShouldRenderOutput": { + "src/surfaces/admin/api/should-render/should-render.ts": { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "name": "ShouldRenderOutput", + "description": "The output returned by `should-render` extensions to control visibility.", + "members": [ + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "boolean", + "description": "Whether to display the associated action extension. Return `true` to show the action, `false` to hide it." + } + ], + "value": "export interface ShouldRenderOutput {\n /** Whether to display the associated action extension. Return `true` to show the action, `false` to hide it. */\n display: boolean;\n}" + } + }, + "BlockExtensionApi": { + "src/surfaces/admin/api/block/block.ts": { + "filePath": "src/surfaces/admin/api/block/block.ts", + "name": "BlockExtensionApi", + "description": "The `BlockExtensionApi` object provides methods for block extensions that render inline content on admin pages. Access the following properties on the `BlockExtensionApi` object to interact with the current context, navigate to other extensions, and display picker dialogs.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface BlockExtensionApi\n extends StandardRenderingExtensionApi {\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.\n */\n data: Data;\n\n /**\n * Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`).\n */\n navigation: Navigation;\n}" + } + }, + "Navigation": { + "src/surfaces/admin/api/block/block.ts": { + "filePath": "src/surfaces/admin/api/block/block.ts", + "name": "Navigation", + "description": "The `Navigation` object provides methods for navigating between extensions and admin pages.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "navigate", + "value": "(url: string | URL) => void", + "description": "Navigates to a specific extension or admin route. Currently supports navigating from a block extension to an action extension on the same resource page.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "navigation.navigate('extension://my-admin-action-extension-handle')", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface Navigation {\n /**\n * Navigates to a specific extension or admin route. Currently supports navigating from a block extension to an action extension on the same resource page.\n *\n * @param url - The destination URL, typically in the format 'extension://extension-handle' for other extensions\n * @example navigation.navigate('extension://my-admin-action-extension-handle')\n */\n navigate: (url: string | URL) => void;\n}" + } + }, + "BlockExtensionComponents": { + "src/surfaces/admin/components/BlockExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/BlockExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BlockExtensionComponents", + "value": "StandardComponents | 'AdminBlock' | 'Form'", + "description": "The components available for building block extensions. Includes all standard components plus the admin block component required for block extension setup and the form component for creating forms." + } + }, + "AdminBlock": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminBlock", + "description": "Configure the following properties on the admin block component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The text displayed as the block's title in the header. If not provided, the extension name will be used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "collapsedSummary", + "value": "string", + "description": "The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class AdminBlock\n extends PreactCustomElement\n implements AdminBlockProps\n{\n /**\n * The text displayed as the block's title in the header. If not provided, the extension name will be used.\n */\n heading: string;\n /**\n * The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.\n */\n collapsedSummary: string;\n constructor();\n}" + } + }, + "Form": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Form", + "description": "Configure the following properties on the form component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Form extends PreactCustomElement implements FormProps {\n constructor();\n}" + } + }, + "AppHomeApi": { + "src/surfaces/admin/api/app-home/app-home.ts": { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "name": "AppHomeApi", + "description": "The `AppHomeApi` object provides methods for app home extensions. Access the following properties on the `AppHomeApi` object to authenticate users, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, handle intents, persist data, display toast notifications, control the Admin page-level loading indicator, and access app-level data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "app", + "value": "AppApi", + "description": "Provides access to app-level data and functionality. Use this API to query information about extensions registered for the current app, including their activation status and target information." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "AppHomeIntents", + "description": "Receives [link intents](/docs/apps/build/sidekick/build-app-data) dispatched to the app home target and resolves them when complete. Subscribe to `intents.request` to be notified each time the admin navigates the merchant to your app via a link intent, and call `intents.response.ok()` / `error()` / `closed()` to resolve the active intent.\n\nWhen you run `dev`, the CLI generates typed variants for every intent declared in `shopify.extension.toml`. Use the `WithGeneratedIntents` helper type to narrow `request.value` and `response.ok` to the generated payloads in your app code." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "LoadingApi", + "description": "Sets the Admin page-level loading indicator. Call `loading(true)` to show the loading indicator while your app home extension performs an asynchronous task. Call `loading(false)`, or call `loading()` without an argument, to hide it when the task completes." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "toast", + "value": "ToastApi", + "description": "Displays brief, non-blocking notification messages at the bottom of the page. Use the Toast API to confirm successful actions, report errors, or provide contextual feedback without interrupting the merchant's workflow." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "tools", + "value": "Tools", + "description": "Registers runtime handlers for app tools declared in your extension configuration. Use this to expose app data lookups and app actions to [Sidekick](/docs/apps/build/sidekick/build-app-data), including link intents that drive the navigate modality from the app home target.\n\nWhen you run `dev`, the CLI generates typed `register` overloads for every tool declared in `shopify.extension.toml`. Use the `WithGeneratedTools` helper type to narrow this property to the generated overloads in your app code." + } + ], + "value": "export interface AppHomeApi\n extends StandardApi {\n /**\n * Displays brief, non-blocking notification messages at the bottom of the page. Use the Toast API to confirm successful actions, report errors, or provide contextual feedback without interrupting the merchant's workflow.\n */\n toast: ToastApi;\n\n /**\n * Provides access to app-level data and functionality. Use this API to query information about extensions registered for the current app, including their activation status and target information.\n */\n app: AppApi;\n\n /**\n * Sets the Admin page-level loading indicator. Call `loading(true)` to show the loading indicator while your app home extension performs an asynchronous task. Call `loading(false)`, or call `loading()` without an argument, to hide it when the task completes.\n */\n loading: LoadingApi;\n\n /**\n * Receives [link intents](/docs/apps/build/sidekick/build-app-data) dispatched to the app home target and resolves them when complete. Subscribe to `intents.request` to be notified each time the admin navigates the merchant to your app via a link intent, and call `intents.response.ok()` / `error()` / `closed()` to resolve the active intent.\n *\n * When you run `dev`, the CLI generates typed variants for every intent declared in `shopify.extension.toml`. Use the `WithGeneratedIntents` helper type to narrow `request.value` and `response.ok` to the generated payloads in your app code.\n */\n intents: AppHomeIntents;\n\n /**\n * Registers runtime handlers for app tools declared in your extension configuration. Use this to expose app data lookups and app actions to [Sidekick](/docs/apps/build/sidekick/build-app-data), including link intents that drive the navigate modality from the app home target.\n *\n * When you run `dev`, the CLI generates typed `register` overloads for every tool declared in `shopify.extension.toml`. Use the `WithGeneratedTools` helper type to narrow this property to the generated overloads in your app code.\n */\n tools: Tools;\n}" + } + }, + "AppApi": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "AppApi", + "description": "The `AppApi` object provides methods for interacting with app-level data and functionality. Use this API to query information about extensions registered for the current app.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "extensions", + "value": "() => Promise", + "description": "Returns a list of all extensions registered for the current app, including their activation status and target information. Use this to discover what extensions are available and where they are activated." + } + ], + "value": "export interface AppApi {\n /**\n * Returns a list of all extensions registered for the current app, including their activation status and target information.\n * Use this to discover what extensions are available and where they are activated.\n *\n * @returns A promise that resolves to an array of extension information objects.\n */\n extensions: () => Promise;\n}" + } + }, + "ExtensionInfo": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "ExtensionInfo", + "description": "Information about an extension registered for the current app.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "activations", + "value": "UiExtensionActivation[] | ThemeExtensionBlockActivation[]", + "description": "The list of activations for this extension. For UI extensions, this contains target information. For theme extensions, this contains detailed block activation information." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string | null", + "description": "The unique handle identifier for this extension, if available.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "ExtensionStatus", + "description": "The current status of this extension.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "ExtensionType", + "description": "The type of extension.", + "isOptional": true + } + ], + "value": "export interface ExtensionInfo {\n /**\n * The unique handle identifier for this extension, if available.\n */\n handle?: string | null;\n\n /**\n * The list of activations for this extension. For UI extensions, this contains target information.\n * For theme extensions, this contains detailed block activation information.\n */\n activations: UiExtensionActivation[] | ThemeExtensionBlockActivation[];\n\n /**\n * The current status of this extension.\n */\n status?: ExtensionStatus;\n\n /**\n * The type of extension.\n */\n type?: ExtensionType;\n}" + } + }, + "UiExtensionActivation": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "UiExtensionActivation", + "description": "Represents an activation of a UI extension at a specific target.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "string", + "description": "The extension target where this extension is activated." + } + ], + "value": "export interface UiExtensionActivation {\n /**\n * The extension target where this extension is activated.\n */\n target: string;\n}" + } + }, + "ThemeExtensionBlockActivation": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "ThemeExtensionBlockActivation", + "description": "Represents a theme extension block activation with its status and nested activations.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "activations", + "value": "ThemeBlockActivation[]", + "description": "The list of theme-specific activations for this block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The handle identifier for this theme extension block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The display name of this theme extension block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "ExtensionStatus", + "description": "The current status of this theme extension block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "ThemeAppBlockTarget | ThemeAppEmbedTarget", + "description": "The target location for this theme extension block or embed." + } + ], + "value": "export interface ThemeExtensionBlockActivation {\n /**\n * The target location for this theme extension block or embed.\n */\n target: ThemeAppBlockTarget | ThemeAppEmbedTarget;\n\n /**\n * The handle identifier for this theme extension block.\n */\n handle: string;\n\n /**\n * The display name of this theme extension block.\n */\n name: string;\n\n /**\n * The current status of this theme extension block.\n */\n status: ExtensionStatus;\n\n /**\n * The list of theme-specific activations for this block.\n */\n activations: ThemeBlockActivation[];\n}" + } + }, + "ThemeBlockActivation": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "ThemeBlockActivation", + "description": "Represents an activation of a theme block at a specific target within a theme.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "string", + "description": "The target location within the theme." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "themeId", + "value": "string", + "description": "The ID of the theme where this block is activated." + } + ], + "value": "export interface ThemeBlockActivation {\n /**\n * The target location within the theme.\n */\n target: string;\n\n /**\n * The ID of the theme where this block is activated.\n */\n themeId: string;\n}" + } + }, + "ExtensionStatus": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionStatus", + "value": "'active' | 'available' | 'unavailable'", + "description": "The status of an extension indicating whether it's active, available for activation, or unavailable.", + "isPublicDocs": true + } + }, + "ThemeAppBlockTarget": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ThemeAppBlockTarget", + "value": "'section'", + "description": "The target location for theme app blocks within a theme section.", + "isPublicDocs": true + } + }, + "ThemeAppEmbedTarget": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ThemeAppEmbedTarget", + "value": "'head' | 'body' | 'compliance_head'", + "description": "The target location for theme app embeds within the document.", + "isPublicDocs": true + } + }, + "ExtensionType": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionType", + "value": "'ui_extension' | 'theme_app_extension'", + "description": "The type of extension.", + "isPublicDocs": true + } + }, + "AppHomeIntents": { + "src/surfaces/admin/api/app-home/app-home.ts": { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "name": "AppHomeIntents", + "description": "The intents API available to app home extensions. It exposes a signal-like `request` that streams link intents into the long-running extension. Inspect `request.value` for information about the active intent.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "invoke", + "value": "IntentInvokeApi", + "description": "Launches an intent workflow for creating or editing Shopify resources.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "request", + "value": "AppHomeIntentRequest", + "description": "The current link intent delivered to the extension. Subscribe to receive new intents over the lifetime of the extension." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "response", + "value": "IntentResponseApi", + "description": "Resolves the current intent. Available only while `request.value` is non-null; the runtime swaps in a fresh handle for each new intent.", + "isOptional": true + } + ], + "value": "export interface AppHomeIntents {\n /**\n * The current link intent delivered to the extension. Subscribe to receive\n * new intents over the lifetime of the extension.\n */\n request: AppHomeIntentRequest;\n /**\n * Resolves the current intent. Available only while `request.value` is\n * non-null; the runtime swaps in a fresh handle for each new intent.\n */\n response?: IntentResponseApi;\n /**\n * Launches an intent workflow for creating or editing Shopify resources.\n */\n invoke?: IntentInvokeApi;\n}" + } + }, + "AppHomeIntentRequest": { + "src/surfaces/admin/api/app-home/app-home.ts": { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "name": "AppHomeIntentRequest", + "description": "The current link intent delivered to an app home extension. The admin pushes a new value into `request` whenever a link intent is dispatched to your app, and resets it to `null` when no intent is active.\n\nThe shape is signal-like (`value` + `subscribe`) so the running extension can observe a stream of intents over its lifetime, mirroring the behaviour the CLI's generated typings already expect via `WithGeneratedIntents`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "subscribe", + "value": "(callback: (value: IntentQueryOptions) => void) => () => void", + "description": "Subscribes to changes in the active intent. The callback is invoked with the new value whenever the admin dispatches a new intent or clears it. Returns a function that unsubscribes the callback." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "IntentQueryOptions | null", + "description": "The intent that's currently being delivered to the extension, or `null` when no intent is active." + } + ], + "value": "export interface AppHomeIntentRequest {\n /**\n * The intent that's currently being delivered to the extension, or `null`\n * when no intent is active.\n */\n readonly value: IntentQueryOptions | null;\n /**\n * Subscribes to changes in the active intent. The callback is invoked with\n * the new value whenever the admin dispatches a new intent or clears it.\n * Returns a function that unsubscribes the callback.\n */\n subscribe: (\n callback: (value: IntentQueryOptions | null) => void,\n ) => () => void;\n}" + } + }, + "IntentQueryOptions": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentQueryOptions", + "description": "Additional parameters for intent invocation when using the string query format. Use these options to provide resource IDs for editing or pass required context data for resource creation.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ [key: string]: unknown; }", + "description": "Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.", + "isOptional": true + } + ], + "value": "export interface IntentQueryOptions {\n /**\n * The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.\n */\n value?: string;\n /**\n * Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.\n */\n data?: {[key: string]: unknown};\n}" + } + }, + "LoadingApi": { + "src/surfaces/admin/api/loading/loading.ts": { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "name": "LoadingApi", + "description": "Sets the Admin page-level loading indicator for hosted app home extensions.\n\nCall with `true` to start loading. Call with `false`, or without an argument, to stop loading.", + "isPublicDocs": true, + "params": [ + { + "name": "isLoading", + "description": "", + "value": "boolean", + "isOptional": true, + "filePath": "src/surfaces/admin/api/loading/loading.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(isLoading?: boolean) => void" + } + }, + "ToastApi": { + "src/surfaces/admin/api/toast/toast.ts": { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "name": "ToastApi", + "description": "The `ToastApi` object provides methods for displaying temporary notification messages. Access these methods through `shopify.toast` to show user feedback and status updates.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "() => void", + "description": "Dismisses any currently visible toast notification. Use this to programmatically hide a toast before its duration expires." + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "(message: string, options?: ToastOptions) => void", + "description": "Displays a toast notification with the specified message. The toast appears as a temporary overlay that automatically dismisses after the specified duration. Use for providing immediate user feedback, confirming actions, or communicating status updates without interrupting the user's workflow." + } + ], + "value": "export interface ToastApi {\n /**\n * Displays a toast notification with the specified message. The toast appears as a temporary overlay that automatically dismisses after the specified duration. Use for providing immediate user feedback, confirming actions, or communicating status updates without interrupting the user's workflow.\n *\n * @param message - The text content to display in the toast notification.\n * @param options - Optional configuration for the toast behavior and appearance.\n */\n show: (message: string, options?: ToastOptions) => void;\n\n /**\n * Dismisses any currently visible toast notification. Use this to programmatically hide a toast before its duration expires.\n */\n hide: () => void;\n}" + } + }, + "ToastOptions": { + "src/surfaces/admin/api/toast/toast.ts": { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "name": "ToastOptions", + "description": "Options for configuring toast notification behavior and appearance.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "string", + "description": "The label for an optional action button displayed in the toast. When provided, an action button appears that the user can click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "duration", + "value": "number", + "description": "The duration in milliseconds to display the toast before automatically dismissing. If not specified, a default duration is used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "isError", + "value": "boolean", + "description": "Whether to display the toast as an error notification. Use for error messages or failed operations.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "onAction", + "value": "() => void", + "description": "Callback function triggered when the user clicks the action button. Only called if `action` is provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "() => void", + "description": "Callback function triggered when the toast is dismissed, either automatically after the duration expires or manually by the user.", + "isOptional": true + } + ], + "value": "export interface ToastOptions {\n /**\n * The duration in milliseconds to display the toast before automatically dismissing. If not specified, a default duration is used.\n */\n duration?: number;\n\n /**\n * Whether to display the toast as an error notification. Use for error messages or failed operations.\n * @defaultValue false\n */\n isError?: boolean;\n\n /**\n * The label for an optional action button displayed in the toast. When provided, an action button appears that the user can click.\n */\n action?: string;\n\n /**\n * Callback function triggered when the user clicks the action button. Only called if `action` is provided.\n */\n onAction?: () => void;\n\n /**\n * Callback function triggered when the toast is dismissed, either automatically after the duration expires or manually by the user.\n */\n onDismiss?: () => void;\n}" + } + }, + "Tools": { + "src/surfaces/admin/api/tools/tools.ts": { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "name": "Tools", + "description": "The `Tools` object provides methods for registering and removing runtime handlers for app tools declared in your extension configuration. Use this API to expose app data lookups and app actions that [Sidekick](/docs/apps/build/sidekick/build-app-data) can invoke on behalf of merchants.\n\nThe base `register` signature accepts any tool name and a generic handler. When you run `dev`, the CLI generates a typed `register` overload for every tool declared in `shopify.extension.toml`, narrowing both the accepted name and the handler's `input`/return types. Use the `WithGeneratedTools` helper to merge the generated typings into your target's API.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "syntaxKind": "PropertySignature", + "name": "clear", + "value": "() => void", + "description": "Unregisters every tool handler currently registered by your extension." + }, + { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "syntaxKind": "PropertySignature", + "name": "register", + "value": "(name: string, handler: ToolHandler) => () => void", + "description": "Registers a tool handler for your app. If a handler with the same name is already registered, it is replaced. Returns a cleanup function that unregisters the handler." + }, + { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "syntaxKind": "PropertySignature", + "name": "unregister", + "value": "(name: string) => void", + "description": "Unregisters a previously registered tool handler. Calling this for a tool that isn't registered is a no-op." + } + ], + "value": "export interface Tools {\n /**\n * Registers a tool handler for your app. If a handler with the same name is\n * already registered, it is replaced. Returns a cleanup function that\n * unregisters the handler.\n *\n * @param name - The tool name as declared in your extension configuration.\n * @param handler - The function invoked when the tool is called.\n * @returns A function that unregisters the handler when invoked.\n */\n register: (name: string, handler: ToolHandler) => () => void;\n\n /**\n * Unregisters a previously registered tool handler. Calling this for a tool\n * that isn't registered is a no-op.\n *\n * @param name - The tool name to unregister.\n */\n unregister: (name: string) => void;\n\n /**\n * Unregisters every tool handler currently registered by your extension.\n */\n clear: () => void;\n}" + } + }, + "ToolHandler": { + "src/surfaces/admin/api/tools/tools.ts": { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "name": "ToolHandler", + "description": "A handler function invoked by the platform when a registered tool is called. The handler receives an `input` object that matches the tool's declared input JSON schema and must return (synchronously or asynchronously) an object that matches the declared output JSON schema.\n\nGenerated tool typings narrow the `input` and return value of this handler for each registered tool name. This base signature is the generic fallback used before code generation has run, or for tools that aren't yet declared in your extension configuration.", + "isPublicDocs": true, + "params": [ + { + "name": "input", + "description": "", + "value": "Record", + "filePath": "src/surfaces/admin/api/tools/tools.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "description": "", + "name": "Record | Promise>", + "value": "Record | Promise>" + }, + "value": "(\n input: Record,\n) => Record | Promise>" + } + }, + "FormExtensionComponents": { + "src/surfaces/admin/components/FormExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/FormExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "FormExtensionComponents", + "value": "StandardComponents | 'Form'", + "description": "The components available for building form-based extensions. Includes all standard components plus the form component for creating structured data collection interfaces with submission handling and validation." + } + }, + "Modal": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Modal", + "description": "Configure the following properties on the modal component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "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.\n\nThis overrides the `heading` prop for screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "\"base\" | \"none\"", + "description": "Adjust the padding around the modal content.\n\n`base`: applies padding that is appropriate for the element.\n\n`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.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\"", + "description": "The size of the modal component, controlling its width and height. Larger sizes provide more space for content while smaller sizes are more compact.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "showOverlay", + "value": "() => void", + "description": "A method to programmatically show the overlay.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "toggleOverlay", + "value": "() => void", + "description": "A method to programmatically toggle the visibility of the overlay.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@abortController@2785", + "value": "AbortController", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@dialog@2779", + "value": "HTMLDialogElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@focusedElement@2781", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@nestedModals@2783", + "value": "Map", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@childrenRerenderObserver@2787", + "value": "MutationObserver", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@shadowDomRerenderObserver@2788", + "value": "MutationObserver", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@onEscape@2782", + "value": "(event: KeyboardEvent) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@onBackdropClick@2784", + "value": "(event: MouseEvent) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@onChildModalChange@2786", + "value": "EventListenerOrEventListenerObject", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "__@isOpen@2778", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@dismiss@2780", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "__@hasOpenChildModal@2775", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@show@2776", + "value": "() => Promise", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@hide@2777", + "value": "() => Promise", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Modal extends PreactOverlayElement implements ModalProps {\n accessor accessibilityLabel: ModalProps['accessibilityLabel'];\n accessor heading: ModalProps['heading'];\n accessor padding: ModalProps['padding'];\n accessor size: ModalProps['size'];\n /** @private */\n [abortController]: AbortController;\n /** @private */\n [dialog]: HTMLDialogElement | null;\n /** @private */\n [focusedElement]: HTMLElement | null;\n /** @private */\n [nestedModals]: Map;\n /** @private */\n [childrenRerenderObserver]: MutationObserver;\n /** @private */\n [shadowDomRerenderObserver]: MutationObserver;\n /** @private */\n [onEscape]: (event: KeyboardEvent) => void;\n /** @private */\n [onBackdropClick]: (event: MouseEvent) => void;\n /** @private */\n [onChildModalChange]: EventListenerOrEventListenerObject;\n /** @private */\n get [isOpen](): boolean;\n /** @private */\n [dismiss](): void;\n /** @private */\n get [hasOpenChildModal](): boolean;\n /** @private */\n [show](): Promise;\n /** @private */\n [hide](): Promise;\n showOverlay(): void;\n hideOverlay(): void;\n toggleOverlay(): void;\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n constructor();\n}" + } + }, + "Page": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Page", + "description": "Use as the outer wrapper of a page.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "\"small\" | \"base\" | \"large\"", + "description": "The inline size of the page\n- `base` corresponds to a set default inline size\n- `large` full width with whitespace", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The main page heading", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Page extends PreactCustomElement implements PageProps {\n accessor inlineSize: PageProps['inlineSize'];\n accessor heading: PageProps['heading'];\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "IntentRenderApi": { + "src/surfaces/admin/api/intents/intent-render.ts": { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "name": "IntentRenderApi", + "description": "The `IntentRenderApi` object provides methods for extensions that render in response to an app intent. Access the intent data to determine what action the merchant requested and use `intents.response` to resolve the intent when complete.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "IntentRenderIntents", + "description": "Provides methods for resolving the current intent. Always available for intent render extensions since they are always invoked inside an intent workflow." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface IntentRenderApi\n extends StandardRenderingExtensionApi {\n /**\n * Provides methods for resolving the current intent. Always available for intent render extensions since they are always invoked inside an intent workflow.\n */\n intents: IntentRenderIntents;\n}" + } + }, + "IntentRenderIntents": { + "src/surfaces/admin/api/intents/intent-render.ts": { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "name": "IntentRenderIntents", + "description": "The intents API available to intent render extensions. Unlike other targets where `response` is optional, intent render extensions always run inside an intent workflow so `response` is guaranteed.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "response", + "value": "IntentResponseApi", + "description": "Resolves the current intent from within the invoked extension. Use `ok()` to signal success, `error()` to report failure, or `closed()` to indicate the merchant cancelled." + } + ], + "value": "export interface IntentRenderIntents {\n /**\n * Resolves the current intent from within the invoked extension. Use `ok()` to signal success, `error()` to report failure, or `closed()` to indicate the merchant cancelled.\n */\n response: IntentResponseApi;\n}" + } + }, + "StandardApi": { + "src/surfaces/admin/api/standard/standard.ts": { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "name": "StandardApi", + "description": "The `StandardApi` object provides core methods available to all extension targets. Access the following properties on the `StandardApi` object to authenticate users, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, handle intents, and persist data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface StandardApi {\n /**\n * The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context.\n */\n extension: {\n target: ExtensionTarget;\n };\n\n /**\n * Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations.\n */\n auth: Auth;\n\n /**\n * Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience.\n */\n i18n: I18n;\n\n /**\n * Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation.\n */\n intents: Intents;\n\n /**\n * Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension.\n */\n storage: Storage;\n\n /**\n * Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query.\n */\n query: (\n query: string,\n options?: {variables?: Variables; version?: Omit},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n}" + } + }, + "CustomerSegmentTemplateApi": { + "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts": { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "name": "CustomerSegmentTemplateApi", + "description": "The `CustomerSegmentTemplateApi` object provides methods for creating customer segment templates. Access the following properties on the `CustomerSegmentTemplateApi` object to build templates with translated content.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "__enabledFeatures", + "value": "string[]", + "description": "", + "isPrivate": true + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating template content into the merchant's language." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface CustomerSegmentTemplateApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardApi {\n /** Utilities for translating template content into the merchant's language. */\n i18n: I18n;\n /** @private */\n __enabledFeatures: string[];\n}" + } + }, + "CustomerSegmentTemplate": { + "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts": { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "name": "CustomerSegmentTemplate", + "description": "Defines a customer segment template that merchants can use to create targeted customer groups.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "createdOn", + "value": "string", + "description": "The creation date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Templates created within the last month display a \"New\" badge." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "dependencies", + "value": "{ standardMetafields?: \"facts.birth_date\"[]; customMetafields?: string[]; }", + "description": "Customer metafields required by this template's query. Declare dependencies so the admin can guide merchants to set up required metafields before using the template.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string | string[]", + "description": "The template description in the merchant's language. Use an array for multiple paragraphs." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "string", + "description": "The segment query code to display in the template with syntax highlighting. This code is shown to merchants but not validated. Test your queries in the Shopify admin segment editor before including them in templates." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "queryToInsert", + "value": "string", + "description": "The segment query code to insert when the merchant selects this template. If omitted, the `query` value is used instead. This code is inserted into the editor but not validated. Test your queries in the Shopify admin segment editor before including them in templates." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The template title in the merchant's language." + } + ], + "value": "export interface CustomerSegmentTemplate {\n /**\n * The template title in the merchant's language.\n */\n title: string;\n /**\n * The template description in the merchant's language. Use an array for multiple paragraphs.\n */\n description: string | string[];\n /**\n * The segment query code to display in the template with syntax highlighting. This code is shown to merchants but not validated. Test your queries in the Shopify admin segment editor before including them in templates.\n */\n query: string;\n /**\n * The segment query code to insert when the merchant selects this template. If omitted, the `query` value is used instead. This code is inserted into the editor but not validated. Test your queries in the Shopify admin segment editor before including them in templates.\n */\n queryToInsert: string;\n /**\n * Customer metafields required by this template's query. Declare dependencies so the admin can guide merchants to set up required metafields before using the template.\n */\n dependencies?: {\n /** Standard Shopify customer metafields used in the query. */\n standardMetafields?: CustomerStandardMetafieldDependency[];\n /** Custom [metafield](/docs/apps/build/metafields) definitions used in the query. */\n customMetafields?: string[];\n };\n /**\n * The creation date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Templates created within the last month display a \"New\" badge.\n */\n createdOn: string;\n}" + } + }, + "DiscountFunctionSettingsApi": { + "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "name": "DiscountFunctionSettingsApi", + "description": "The `DiscountFunctionSettingsApi` object provides methods for configuring discount functions. Access the following properties on the `DiscountFunctionSettingsApi` object to manage function settings and metafields.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "applyMetafieldChange", + "value": "ApplyMetafieldChange", + "description": "Updates or removes [metafields](/docs/apps/build/metafields) that store discount function configuration. Use this to save merchant settings for your discount function." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "DiscountFunctionSettingsData", + "description": "The discount being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "discounts", + "value": "DiscountsApi", + "description": "The `discounts` object provides reactive access to discount configuration, including discount classes and the discount method. Use the signals to read current values and the update functions to modify discount classes in your settings UI. These values automatically update when changed by the merchant or system." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface DiscountFunctionSettingsApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends Omit, 'data'> {\n /**\n * Updates or removes [metafields](/docs/apps/build/metafields) that store discount function configuration. Use this to save merchant settings for your discount function.\n */\n applyMetafieldChange: ApplyMetafieldChange;\n /** The discount being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings. */\n data: DiscountFunctionSettingsData;\n /** The `discounts` object provides reactive access to discount configuration, including discount classes and the discount method. Use the signals to read current values and the update functions to modify discount classes in your settings UI. These values automatically update when changed by the merchant or system. */\n discounts: DiscountsApi;\n}" + } + }, + "ApplyMetafieldChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "ApplyMetafieldChange", + "description": "A function that applies metafield changes to discount function settings. Call this function with an update or removal operation, then await the Promise to receive a result indicating success or failure. Use the result to provide feedback or handle errors in your settings interface.", + "isPublicDocs": true, + "params": [ + { + "name": "change", + "description": "", + "value": "MetafieldChange", + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "description": "", + "name": "Promise", + "value": "Promise" + }, + "value": "(\n change: MetafieldChange,\n) => Promise" + } + }, + "MetafieldChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldChange", + "value": "MetafieldUpdateChange | MetafieldRemoveChange", + "description": "A metafield change operation that can either update or remove a metafield. Pass this to `applyMetafieldChange` to modify discount settings stored in metafields.", + "isPublicDocs": true + } + }, + "MetafieldUpdateChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldUpdateChange", + "description": "A metafield update or creation operation. Use this to set or modify metafield values that store discount function configuration data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The unique key identifying the metafield within its namespace. Use descriptive keys that indicate the setting's purpose (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`)." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace that organizes related metafields. When omitted, a default namespace is assigned. Use consistent namespaces to group related settings.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updateMetafield'", + "description": "Identifies this as an update operation. Always set to `'updateMetafield'` for updates." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string | number", + "description": "The metafield value to store. Can be a string or number depending on your configuration needs." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "valueType", + "value": "SupportedDefinitionType", + "description": "The [data type](/docs/apps/build/metafields/list-of-data-types) that defines how the value is formatted and validated. When omitted, preserves the existing type for updates or uses a default for new metafields. Choose a type that matches your value format.", + "isOptional": true + } + ], + "value": "export interface MetafieldUpdateChange {\n /** Identifies this as an update operation. Always set to `'updateMetafield'` for updates. */\n type: 'updateMetafield';\n /** The unique key identifying the metafield within its namespace. Use descriptive keys that indicate the setting's purpose (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`). */\n key: string;\n /** The namespace that organizes related metafields. When omitted, a default namespace is assigned. Use consistent namespaces to group related settings. */\n namespace?: string;\n /** The metafield value to store. Can be a string or number depending on your configuration needs. */\n value: string | number;\n /** The [data type](/docs/apps/build/metafields/list-of-data-types) that defines how the value is formatted and validated. When omitted, preserves the existing type for updates or uses a default for new metafields. Choose a type that matches your value format. */\n valueType?: SupportedDefinitionType;\n}" + } + }, + "MetafieldRemoveChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldRemoveChange", + "description": "A metafield removal operation. Use this to delete metafields that are no longer needed for your discount configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The unique key of the metafield to remove. Must match the key used when the metafield was created." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace containing the metafield to remove. Required to ensure the correct metafield is targeted, as the same key can exist in different namespaces." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'removeMetafield'", + "description": "Identifies this as a removal operation. Always set to `'removeMetafield'` for deletions." + } + ], + "value": "export interface MetafieldRemoveChange {\n /** Identifies this as a removal operation. Always set to `'removeMetafield'` for deletions. */\n type: 'removeMetafield';\n /** The unique key of the metafield to remove. Must match the key used when the metafield was created. */\n key: string;\n /** The namespace containing the metafield to remove. Required to ensure the correct metafield is targeted, as the same key can exist in different namespaces. */\n namespace: string;\n}" + } + }, + "MetafieldChangeResult": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldChangeResult", + "value": "MetafieldChangeSuccess | MetafieldChangeResultError", + "description": "The result returned after attempting to change a metafield. Check the `type` property to determine if the operation succeeded (`'success'`) or failed (`'error'`), then handle the result appropriately in your extension.", + "isPublicDocs": true + } + }, + "MetafieldChangeSuccess": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldChangeSuccess", + "description": "A successful metafield change operation result. The metafield was updated or removed as requested and the changes are now saved.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates the operation succeeded. When this value is `'success'`, the metafield change was applied successfully." + } + ], + "value": "export interface MetafieldChangeSuccess {\n /** Indicates the operation succeeded. When this value is `'success'`, the metafield change was applied successfully. */\n type: 'success';\n}" + } + }, + "MetafieldChangeResultError": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldChangeResultError", + "description": "A failed metafield change operation result. Use the error message to understand what went wrong and fix the issue, such as validation errors, permission problems, or invalid metafield types.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A human-readable error message explaining why the operation failed. Use this to debug issues or display feedback to merchants." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates the operation failed. Check this value to determine if you need to handle an error." + } + ], + "value": "export interface MetafieldChangeResultError {\n /** Indicates the operation failed. Check this value to determine if you need to handle an error. */\n type: 'error';\n /** A human-readable error message explaining why the operation failed. Use this to debug issues or display feedback to merchants. */\n message: string;\n}" + } + }, + "DiscountFunctionSettingsData": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "name": "DiscountFunctionSettingsData", + "description": "The `data` object exposed to discount function settings extensions in the `admin.discount-details.function-settings.render` target. Use this to access the current discount configuration and populate your settings interface with existing values.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The discount's unique global identifier (GID) in the [GraphQL Admin API](/docs/api/admin-graphql) format (for example, `gid://shopify/DiscountAutomaticApp/123`). Use this ID to associate settings with the correct discount or query discount data." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "An array of [metafields](/docs/apps/build/metafields) that store the discount function's configuration values. Use these metafields to populate your settings UI with the current discount configuration and display existing settings to merchants." + } + ], + "value": "export interface DiscountFunctionSettingsData {\n /** The discount's unique global identifier (GID) in the [GraphQL Admin API](/docs/api/admin-graphql) format (for example, `gid://shopify/DiscountAutomaticApp/123`). Use this ID to associate settings with the correct discount or query discount data. */\n id: string;\n /** An array of [metafields](/docs/apps/build/metafields) that store the discount function's configuration values. Use these metafields to populate your settings UI with the current discount configuration and display existing settings to merchants. */\n metafields: Metafield[];\n}" + } + }, + "Metafield": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "name": "Metafield", + "description": "A [metafield](/docs/apps/build/metafields) that stores discount function configuration data. Use metafields to persist settings that control how your discount function behaves, such as discount thresholds, eligibility rules, or custom discount logic parameters.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "A human-readable description explaining the metafield's purpose and how it affects discount behavior. Use this to document your settings for other developers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique global identifier (GID) for this metafield. Use this ID to reference the metafield in GraphQL queries or updates." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The unique key identifying this metafield within its namespace. This key determines how you access the metafield value (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`)." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace that organizes related metafields together. All metafields for a discount should use a consistent namespace to group related settings." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The metafield [definition type](/docs/apps/build/metafields/list-of-data-types) that specifies the value format and validation rules. Use this to determine how to parse and display the value." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The metafield value stored as a string. Parse this value according to the metafield type to use it in your settings UI." + } + ], + "value": "export interface Metafield {\n /** A human-readable description explaining the metafield's purpose and how it affects discount behavior. Use this to document your settings for other developers. */\n description?: string;\n /** The unique global identifier (GID) for this metafield. Use this ID to reference the metafield in GraphQL queries or updates. */\n id: string;\n /** The namespace that organizes related metafields together. All metafields for a discount should use a consistent namespace to group related settings. */\n namespace: string;\n /** The unique key identifying this metafield within its namespace. This key determines how you access the metafield value (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`). */\n key: string;\n /** The metafield value stored as a string. Parse this value according to the metafield type to use it in your settings UI. */\n value: string;\n /** The metafield [definition type](/docs/apps/build/metafields/list-of-data-types) that specifies the value format and validation rules. Use this to determine how to parse and display the value. */\n type: string;\n}" + } + }, + "DiscountsApi": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "name": "DiscountsApi", + "description": "The `DiscountsApi` object provides reactive access to discount configuration. Use the signals to read discount classes and method, and the update function to change which parts of the purchase (products, order, or shipping) the discount affects.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "discountClasses", + "value": "ReadonlySignalLike", + "description": "A signal that contains the discount classes (Product, Order, or Shipping). Read this to determine where the discount applies in the purchase flow. A discount can apply to multiple classes simultaneously." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "discountMethod", + "value": "ReadonlySignalLike", + "description": "A signal that contains the discount method (`'automatic'` or `'code'`). Read this to determine whether the discount applies automatically at checkout or requires a customer-entered code." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "updateDiscountClasses", + "value": "UpdateSignalFunction", + "description": "A function that updates the discount classes to change where the discount applies. Call this function with an array of `DiscountClass` values to set which parts of the purchase (products, order total, or shipping) the discount affects." + } + ], + "value": "export interface DiscountsApi {\n /**\n * A signal that contains the discount classes (Product, Order, or Shipping). Read this to determine where the discount applies in the purchase flow. A discount can apply to multiple classes simultaneously.\n */\n discountClasses: ReadonlySignalLike;\n /**\n * A function that updates the discount classes to change where the discount applies. Call this function with an array of `DiscountClass` values to set which parts of the purchase (products, order total, or shipping) the discount affects.\n */\n updateDiscountClasses: UpdateSignalFunction;\n /**\n * A signal that contains the discount method (`'automatic'` or `'code'`). Read this to determine whether the discount applies automatically at checkout or requires a customer-entered code.\n */\n discountMethod: ReadonlySignalLike;\n}" + } + }, + "ReadonlySignalLike": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "ReadonlySignalLike", + "description": "Represents a reactive signal interface that provides both immediate value access and subscription-based updates. Enables real-time synchronization with changing data through the observer pattern.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "MethodSignature", + "name": "subscribe", + "value": "(fn: (value: T) => void) => () => void", + "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "T", + "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." + } + ], + "value": "export interface ReadonlySignalLike {\n /**\n * The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup.\n */\n readonly value: T;\n /**\n * Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value.\n */\n subscribe(fn: (value: T) => void): () => void;\n}" + } + }, + "DiscountClass": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DiscountClass", + "value": "'product' | 'order' | 'shipping'", + "description": "The discount class that determines where the discount applies in the purchase flow. Use this to understand what type of discount the merchant is configuring (product-level, order-level, or shipping).", + "isPublicDocs": true + } + }, + "DiscountMethod": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DiscountMethod", + "value": "'automatic' | 'code'", + "description": "The method used to apply a discount. Use `'automatic'` for discounts that apply automatically at checkout, or `'code'` for discounts that require a code entered by the customer.", + "isPublicDocs": true + } + }, + "UpdateSignalFunction": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "UpdateSignalFunction", + "description": "A function that updates a signal and returns a result indicating success or failure. The function is typically used along with a `ReadonlySignalLike` object.", + "params": [ + { + "name": "value", + "description": "", + "value": "T", + "filePath": "src/shared.ts" + } + ], + "returns": { + "filePath": "src/shared.ts", + "description": "", + "name": "Result", + "value": "Result" + }, + "value": "(value: T) => Result" + } + }, + "Result": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Result", + "value": "{success: true; value: T} | {success: false; errors: ValidationError[]}", + "description": "A result type that indicates the success or failure of an operation." + } + }, + "ValidationError": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "ValidationError", + "description": "A validation error object that is returned when an operation fails.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A code identifier for the error." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "issues", + "value": "{ message: string; path: string[]; }[]", + "description": "Field-level validation issues", + "isOptional": true + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message describing the error." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "" + } + ], + "value": "interface ValidationError {\n type: 'error';\n /**\n * A message describing the error.\n */\n message: string;\n /**\n * A code identifier for the error.\n */\n code: string;\n /**\n * Field-level validation issues\n */\n issues?: {\n message: string;\n path: string[];\n }[];\n}" + } + }, + "FunctionSettingsComponents": { + "src/surfaces/admin/components/FunctionSettingsComponents.ts": { + "filePath": "src/surfaces/admin/components/FunctionSettingsComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "FunctionSettingsComponents", + "value": "FormExtensionComponents | 'FunctionSettings'", + "description": "The components available for building function settings extensions. Includes all form components plus the function settings component required for function settings configuration." + } + }, + "FunctionSettings": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionSettings", + "description": "Configure the following properties on the function settings component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class FunctionSettings\n extends PreactCustomElement\n implements FunctionSettingsProps\n{\n constructor();\n}" + } + }, + "PrintActionExtensionApi": { + "src/surfaces/admin/api/print-action/print-action.ts": { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "name": "PrintActionExtensionApi", + "description": "The `PrintActionExtensionApi` object provides methods for print action extensions that generate custom printable documents. Access the following properties on the `PrintActionExtensionApi` object to access selected resources and display picker dialogs for print configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items to include in the print document, such as selected orders or products." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface PrintActionExtensionApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardRenderingExtensionApi {\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items to include in the print document, such as selected orders or products.\n */\n data: Data;\n}" + } + }, + "PrintActionExtensionComponents": { + "src/surfaces/admin/components/PrintActionExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/PrintActionExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PrintActionExtensionComponents", + "value": "StandardComponents | 'AdminPrintAction'", + "description": "The components available for building print action extensions. Includes all standard components plus the admin print action component required for print action setup." + } + }, + "AdminPrintAction": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminPrintAction", + "description": "Configure the following properties on the admin print action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The `src` URL of the preview and the document to print. If not provided, the preview will show an empty state and the print button will be disabled. HTML, PDFs, and images are supported.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class AdminPrintAction\n extends PreactCustomElement\n implements AdminPrintActionProps\n{\n /**\n * The `src` URL of the preview and the document to print.\n * If not provided, the preview will show an empty state and the print button will be disabled.\n * HTML, PDFs, and images are supported.\n */\n src: string;\n constructor();\n}" + } + }, + "ProductDetailsConfigurationApi": { + "src/surfaces/admin/api/product-configuration/product-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "name": "ProductDetailsConfigurationApi", + "description": "The `ProductDetailsConfigurationApi` object provides methods for configuring product bundles and relationships. Access the following properties on the `ProductDetailsConfigurationApi` object to build product configuration interfaces.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data & { product: Product; app: { launchUrl: string; applicationUrl: string; }; }", + "description": "Product configuration data including the current product, selected items, and app URLs. Use this to access the product being configured and build your configuration interface." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ProductDetailsConfigurationApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends BlockExtensionApi {\n /** Product configuration data including the current product, selected items, and app URLs. Use this to access the product being configured and build your configuration interface. */\n data: Data & {\n /**\n * The product currently being viewed in the admin.\n * @deprecated\n */\n product: Product;\n /** URLs for launching and navigating to your app, including the launch URL and base application URL. Use these to create links or redirect merchants to your app. */\n app: {\n launchUrl: string;\n applicationUrl: string;\n };\n };\n}" + } + }, + "Product": { + "src/surfaces/admin/api/product-configuration/product-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "name": "Product", + "description": "A product configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The URL-friendly unique identifier used in product URLs (for example, `'blue-t-shirt'`)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "hasOnlyDefaultVariant", + "value": "boolean", + "description": "Whether the product has only the default variant with no custom options. When `true`, the product has no size, color, or other option variations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The product's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "onlineStoreUrl", + "value": "string", + "description": "The URL to view this product on the online store. Use this to create \"View in store\" links.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "options", + "value": "{ id: string; name: string; position: number; values: string[]; }[]", + "description": "Product options that define how variants differ (for example, Size, Color, Material). Each option has an ID, name, position, and array of possible values." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productCategory", + "value": "string", + "description": "The standardized product category taxonomy. Use this for product classification in search and organization.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productComponents", + "value": "ProductComponent[]", + "description": "An array of component products that make up this bundle. Each component represents a product included in the bundle configuration." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productType", + "value": "string", + "description": "The product category or type used for organization (for example, \"T-Shirt\", \"Shoes\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "'ACTIVE' | 'ARCHIVED' | 'DRAFT'", + "description": "The publication status indicating whether the product is active (published), archived (discontinued), or draft (unpublished)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The product's display name shown to merchants and customers." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "totalInventory", + "value": "number", + "description": "The total available inventory summed across all variants and locations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "totalVariants", + "value": "number", + "description": "The total number of variants this product has." + } + ], + "value": "export interface Product {\n /** The product's unique global identifier (GID). */\n id: string;\n /** The product's display name shown to merchants and customers. */\n title: string;\n /** The URL-friendly unique identifier used in product URLs (for example, `'blue-t-shirt'`). */\n handle: string;\n /** The publication status indicating whether the product is active (published), archived (discontinued), or draft (unpublished). */\n status: 'ACTIVE' | 'ARCHIVED' | 'DRAFT';\n /** The total number of variants this product has. */\n totalVariants: number;\n /** The total available inventory summed across all variants and locations. */\n totalInventory: number;\n /** Whether the product has only the default variant with no custom options. When `true`, the product has no size, color, or other option variations. */\n hasOnlyDefaultVariant: boolean;\n /** The URL to view this product on the online store. Use this to create \"View in store\" links. */\n onlineStoreUrl?: string;\n /** Product options that define how variants differ (for example, Size, Color, Material). Each option has an ID, name, position, and array of possible values. */\n options: {\n id: string;\n name: string;\n position: number;\n values: string[];\n }[];\n /** The product category or type used for organization (for example, \"T-Shirt\", \"Shoes\"). */\n productType: string;\n /** The standardized product category taxonomy. Use this for product classification in search and organization. */\n productCategory?: string;\n /** An array of component products that make up this bundle. Each component represents a product included in the bundle configuration. */\n productComponents: ProductComponent[];\n}" + } + }, + "ProductComponent": { + "src/surfaces/admin/api/product-configuration/product-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "name": "ProductComponent", + "description": "A component product that is part of a bundle. Represents an individual product included in a bundle configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "componentVariantsCount", + "value": "number", + "description": "The count of variants from this product that are used as bundle components. Use this to understand how many variants are configured in bundles." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "featuredImage", + "value": "{\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null", + "description": "The featured image displayed for this component product with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The component product's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "nonComponentVariantsCount", + "value": "number", + "description": "The count of variants from this product that aren't used in any bundles. Use this to identify available variants for adding to bundle configurations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productUrl", + "value": "string", + "description": "The admin URL for this component product. Use this to create links to the product's details page in the admin." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The product's display name. Use this to show which product is included in the bundle." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "totalVariants", + "value": "number", + "description": "The total number of variants this component product has. Use this to determine if variant selection is needed for this component." + } + ], + "value": "export interface ProductComponent {\n /** The component product's unique global identifier (GID). */\n id: string;\n /** The product's display name. Use this to show which product is included in the bundle. */\n title: string;\n /** The featured image displayed for this component product with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces. */\n featuredImage?: {\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null;\n /** The total number of variants this component product has. Use this to determine if variant selection is needed for this component. */\n totalVariants: number;\n /** The admin URL for this component product. Use this to create links to the product's details page in the admin. */\n productUrl: string;\n /** The count of variants from this product that are used as bundle components. Use this to understand how many variants are configured in bundles. */\n componentVariantsCount: number;\n /** The count of variants from this product that aren't used in any bundles. Use this to identify available variants for adding to bundle configurations. */\n nonComponentVariantsCount: number;\n}" + } + }, + "PurchaseOptionsCardConfigurationApi": { + "src/surfaces/admin/api/purchase-options-card-action.ts": { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "name": "PurchaseOptionsCardConfigurationApi", + "description": "The `PurchaseOptionsCardConfigurationApi` object provides methods for action extensions that interact with purchase options and selling plans. Access the following properties on the `PurchaseOptionsCardConfigurationApi` object to work with selected products and their associated subscription configurations.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "close", + "value": "() => void", + "description": "Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ selected: { id: string; sellingPlanId?: string; }[]; }", + "description": "Selected purchase option data including product and selling plan identifiers." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface PurchaseOptionsCardConfigurationApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends ActionExtensionApi {\n /** Selected purchase option data including product and selling plan identifiers. */\n data: {\n /** Array of selected items with their product IDs and optional selling plan IDs for subscription configurations. */\n selected: {\n /** The product or variant identifier. */\n id: string;\n /** The associated selling plan identifier, if a subscription option is selected. */\n sellingPlanId?: string;\n }[];\n };\n}" + } + }, + "ProductVariantDetailsConfigurationApi": { + "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "name": "ProductVariantDetailsConfigurationApi", + "description": "The `ProductVariantDetailsConfigurationApi` object provides methods for configuring product variant bundles and relationships. Access the following properties on the `ProductVariantDetailsConfigurationApi` object to build variant configuration interfaces.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data & { variant: ProductVariant; app: { launchUrl: string; applicationUrl: string; }; }", + "description": "Product variant configuration data including the current variant, selected items, and app URLs. Use this to access the variant being configured and build your configuration interface." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ProductVariantDetailsConfigurationApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends BlockExtensionApi {\n /** Product variant configuration data including the current variant, selected items, and app URLs. Use this to access the variant being configured and build your configuration interface. */\n data: Data & {\n /**\n * The product variant currently being viewed in the admin.\n * @deprecated\n */\n variant: ProductVariant;\n /** URLs for launching and navigating to your app, including the launch URL and base application URL. Use these to create links or redirect merchants to your app. */\n app: {\n launchUrl: string;\n applicationUrl: string;\n };\n };\n}" + } + }, + "ProductVariant": { + "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "name": "ProductVariant", + "description": "A product variant configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "barcode", + "value": "string", + "description": "The barcode, UPC, or ISBN number for the variant." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "compareAtPrice", + "value": "string", + "description": "The original price before any discounts or markdowns." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The variant's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "price", + "value": "string", + "description": "The current selling price for this variant." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productVariantComponents", + "value": "ProductVariantComponent[]", + "description": "An array of component variants that make up this bundle variant. Each component represents a product variant included in the bundle." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "selectedOptions", + "value": "{ name: string; value: string; }[]", + "description": "The option values that define this specific variant with name and value pairs (for example, Size: Large, Color: Blue)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "sku", + "value": "string", + "description": "The Stock Keeping Unit (SKU) identifier for inventory tracking." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "taxable", + "value": "boolean", + "description": "Whether this variant is subject to taxes. When `true`, applicable taxes are calculated at checkout." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "taxCode", + "value": "string", + "description": "The harmonized system (HS) tax code for international shipping and customs." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The display name showing only the variant's option values (for example, \"Medium / Blue\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "weight", + "value": "number", + "description": "The physical weight of the variant as a number." + } + ], + "value": "export interface ProductVariant {\n /** The variant's unique global identifier (GID). */\n id: string;\n /** The Stock Keeping Unit (SKU) identifier for inventory tracking. */\n sku: string;\n /** The barcode, UPC, or ISBN number for the variant. */\n barcode: string;\n /** The display name showing only the variant's option values (for example, \"Medium / Blue\"). */\n title: string;\n /** A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\"). */\n displayName: string;\n /** The current selling price for this variant. */\n price: string;\n /** The original price before any discounts or markdowns. */\n compareAtPrice: string;\n /** Whether this variant is subject to taxes. When `true`, applicable taxes are calculated at checkout. */\n taxable: boolean;\n /** The harmonized system (HS) tax code for international shipping and customs. */\n taxCode: string;\n /** The physical weight of the variant as a number. */\n weight: number;\n /** The option values that define this specific variant with name and value pairs (for example, Size: Large, Color: Blue). */\n selectedOptions: {\n name: string;\n value: string;\n }[];\n /** An array of component variants that make up this bundle variant. Each component represents a product variant included in the bundle. */\n productVariantComponents: ProductVariantComponent[];\n}" + } + }, + "ProductVariantComponent": { + "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "name": "ProductVariantComponent", + "description": "A component variant that is part of a product bundle. Represents an individual product variant included in a bundle configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The component variant's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "{\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null", + "description": "The image displayed for this component variant with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productVariantUrl", + "value": "string", + "description": "The admin URL for this product variant. Use this to create links to the variant's details page in the admin." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "selectedOptions", + "value": "{ name: string; value: string; }[]", + "description": "The option values that define this specific component variant with name and value pairs (for example, Size: Large, Color: Blue)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "sku", + "value": "string", + "description": "The Stock Keeping Unit (SKU) identifier for this component variant.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The display name showing only the variant's option values (for example, \"Medium / Blue\")." + } + ], + "value": "export interface ProductVariantComponent {\n /** The component variant's unique global identifier (GID). */\n id: string;\n /** A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\"). */\n displayName: string;\n /** The display name showing only the variant's option values (for example, \"Medium / Blue\"). */\n title: string;\n /** The Stock Keeping Unit (SKU) identifier for this component variant. */\n sku?: string;\n /** The image displayed for this component variant with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces. */\n image?: {\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null;\n /** The admin URL for this product variant. Use this to create links to the variant's details page in the admin. */\n productVariantUrl: string;\n /** The option values that define this specific component variant with name and value pairs (for example, Size: Large, Color: Blue). */\n selectedOptions: {\n name: string;\n value: string;\n }[];\n}" + } + }, + "OrderRoutingRuleApi": { + "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "name": "OrderRoutingRuleApi", + "description": "The `OrderRoutingRuleApi` object provides methods for configuring order routing rules. Access the following properties on the `OrderRoutingRuleApi` object to manage rule settings and metafields.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "applyMetafieldsChange", + "value": "ApplyMetafieldsChange", + "description": "Updates or removes [metafields](/docs/apps/build/metafields) that store order routing rule configuration." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "The order routing rule being configured, including its metadata and associated [metafields](/docs/apps/build/metafields)." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface OrderRoutingRuleApi\n extends StandardRenderingExtensionApi {\n /** Updates or removes [metafields](/docs/apps/build/metafields) that store order routing rule configuration. */\n applyMetafieldsChange: ApplyMetafieldsChange;\n /** The order routing rule being configured, including its metadata and associated [metafields](/docs/apps/build/metafields). */\n data: Data;\n}" + } + }, + "ApplyMetafieldsChange": { + "src/surfaces/admin/api/order-routing-rule/metafields.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts", + "name": "ApplyMetafieldsChange", + "description": "A function that applies metafield changes to order routing rule settings. Call this function with one or more change operations to update or remove metafields in batch. Use batch operations to apply multiple configuration changes efficiently.", + "isPublicDocs": true, + "params": [ + { + "name": "changes", + "description": "", + "value": "MetafieldsChange[]", + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(changes: MetafieldsChange[]) => void" + } + }, + "MetafieldsChange": { + "src/surfaces/admin/api/order-routing-rule/metafields.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldsChange", + "value": "MetafieldUpdateChange | MetafieldRemoveChange | MetafieldUpdateChange[] | MetafieldRemoveChange[]", + "description": "One or more metafield change operations to apply to order routing rule settings. Can be a single change or an array of changes for batch operations. Use arrays to apply multiple changes at once.", + "isPublicDocs": true + } + }, + "ValidationSettingsApi": { + "src/surfaces/admin/api/checkout-rules/validation-settings.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "name": "ValidationSettingsApi", + "description": "The `ValidationSettingsApi` object provides methods for configuring cart and checkout validation functions. Access the following properties on the `ValidationSettingsApi` object to manage validation settings and metafields.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "applyMetafieldChange", + "value": "ApplyMetafieldChange", + "description": "Updates or removes [metafields](/docs/apps/build/metafields) that store validation function configuration. Use this to save merchant settings for your validation function." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "ValidationData", + "description": "The validation being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ValidationSettingsApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardRenderingExtensionApi {\n /**\n * Updates or removes [metafields](/docs/apps/build/metafields) that store validation function configuration. Use this to save merchant settings for your validation function.\n */\n applyMetafieldChange: ApplyMetafieldChange;\n /** The validation being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings. */\n data: ValidationData;\n}" + } + }, + "ValidationData": { + "src/surfaces/admin/api/checkout-rules/launch-options.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "name": "ValidationData", + "description": "The `data` object exposed to validation settings extensions in the `admin.settings.validation.render` target. Use this to access the current validation configuration and populate your settings interface with existing values.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "shopifyFunction", + "value": "ShopifyFunction", + "description": "The [Shopify Function](/docs/apps/build/functions) that implements the validation logic. Use this ID to associate configuration changes with the correct function." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "validation", + "value": "Validation", + "description": "The validation configuration containing the validation ID and metafields. Present when editing an existing validation, absent when creating a new validation. Use the presence of this value to determine if you're in create or edit mode.", + "isOptional": true + } + ], + "value": "export interface ValidationData {\n /** The validation configuration containing the validation ID and metafields. Present when editing an existing validation, absent when creating a new validation. Use the presence of this value to determine if you're in create or edit mode. */\n validation?: Validation;\n /** The [Shopify Function](/docs/apps/build/functions) that implements the validation logic. Use this ID to associate configuration changes with the correct function. */\n shopifyFunction: ShopifyFunction;\n}" + } + }, + "ShopifyFunction": { + "src/surfaces/admin/api/checkout-rules/launch-options.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "name": "ShopifyFunction", + "description": "A [Shopify Function](/docs/apps/build/functions) that implements cart and checkout validation logic. This identifies which function the settings interface is configuring.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The [Shopify Function's](/docs/apps/build/functions) unique global identifier (GID). Use this ID to associate settings changes with the correct function." + } + ], + "value": "export interface ShopifyFunction {\n /** The [Shopify Function's](/docs/apps/build/functions) unique global identifier (GID). Use this ID to associate settings changes with the correct function. */\n id: string;\n}" + } + }, + "Validation": { + "src/surfaces/admin/api/checkout-rules/launch-options.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "name": "Validation", + "description": "A validation configuration that exists and is active in the shop. Use this object to access the validation's current settings and metafields when merchants edit an existing validation.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The validation's unique global identifier (GID). Use this ID to reference the validation in GraphQL operations or when saving updated settings." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "An array of [metafields](/docs/apps/build/metafields) that store the validation's configuration values. Use these metafields to populate your settings UI with the current validation configuration." + } + ], + "value": "export interface Validation {\n /** The validation's unique global identifier (GID). Use this ID to reference the validation in GraphQL operations or when saving updated settings. */\n id: string;\n /** An array of [metafields](/docs/apps/build/metafields) that store the validation's configuration values. Use these metafields to populate your settings UI with the current validation configuration. */\n metafields: Metafield[];\n}" + } + }, + "ClosedIntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "ClosedIntentResponse", + "description": "The response returned when a merchant closes or cancels the workflow without completing it. Check for this response to handle cancellation gracefully in your extension.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'closed'", + "description": "Indicates the workflow was closed without completion. When `'closed'`, the merchant exited the workflow before finishing.", + "isOptional": true + } + ], + "value": "export interface ClosedIntentResponse {\n /** Indicates the workflow was closed without completion. When `'closed'`, the merchant exited the workflow before finishing. */\n code?: 'closed';\n}" + } + }, + "SuccessIntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "SuccessIntentResponse", + "description": "The response returned when a merchant successfully completes the workflow. Use this to access the created or updated resource data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'ok'", + "description": "Indicates successful completion. When `'ok'`, the merchant completed the workflow and the resource was created or updated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ [key: string]: unknown; }", + "description": "Additional data returned by the workflow, such as the created or updated resource information with IDs and properties.", + "isOptional": true + } + ], + "value": "export interface SuccessIntentResponse {\n /** Indicates successful completion. When `'ok'`, the merchant completed the workflow and the resource was created or updated. */\n code?: 'ok';\n /** Additional data returned by the workflow, such as the created or updated resource information with IDs and properties. */\n data?: {[key: string]: unknown};\n}" + } + }, + "ErrorIntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "ErrorIntentResponse", + "description": "The response returned when the workflow fails due to validation errors or other issues. Use this to display error messages and help merchants fix problems.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'error'", + "description": "Indicates the workflow failed. When `'error'`, the workflow encountered validation errors or other issues that prevented completion.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "issues", + "value": "Issue[]", + "description": "Specific validation issues or field errors. Present when validation fails on particular fields, allowing you to show targeted error messages.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A general error message describing what went wrong. Use this to display feedback when specific field errors aren't available.", + "isOptional": true + } + ], + "value": "export interface ErrorIntentResponse {\n /** Indicates the workflow failed. When `'error'`, the workflow encountered validation errors or other issues that prevented completion. */\n code?: 'error';\n /** A general error message describing what went wrong. Use this to display feedback when specific field errors aren't available. */\n message?: string;\n /** Specific validation issues or field errors. Present when validation fails on particular fields, allowing you to show targeted error messages. */\n issues?: Issue[];\n}" + } + }, + "IntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentResponse", + "value": "SuccessIntentResponse | ErrorIntentResponse | ClosedIntentResponse", + "description": "The result of an intent workflow. Check the `code` property to determine the outcome: `'ok'` for success, `'error'` for failure, or `'closed'` if the merchant cancelled.", + "isPublicDocs": true + } + }, + "IntentActivity": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentActivity", + "description": "A handle for tracking an in-progress intent workflow.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "complete", + "value": "Promise", + "description": "A Promise that resolves when the workflow completes. Await this to get the outcome and handle success, failure, or cancellation appropriately.", + "isOptional": true + } + ], + "value": "export interface IntentActivity {\n /**\n * A Promise that resolves when the workflow completes. Await this to get the outcome and handle success, failure, or cancellation appropriately.\n */\n complete?: Promise;\n}" + } + }, + "IntentAction": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentAction", + "value": "'create' | 'edit' | 'pick'", + "description": "The type of operation to perform: creating a new resource, editing an existing one, or picking existing resources.", + "isPublicDocs": true + } + }, + "IntentType": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentType", + "value": "'shopify/Article' | 'shopify/Catalog' | 'shopify/Collection' | 'shopify/Customer' | 'shopify/Discount' | 'shopify/File' | 'shopify/Location' | 'shopify/Market' | 'shopify/Menu' | 'shopify/MetafieldDefinition' | 'shopify/Metaobject' | 'shopify/MetaobjectDefinition' | 'shopify/Page' | 'shopify/Product' | 'shopify/ProductVariant'", + "description": "The types of Shopify resources that support intent-based creation and editing workflows.", + "isPublicDocs": true + } + }, + "Collection": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Collection", + "description": "A collection resource selected from the resource picker. Collections are groups of products organized by manual curation or automated rules. Use collection data to access product groupings, organizational information, and collection metadata.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "availablePublicationCount", + "value": "number", + "description": "The number of sales channels where this collection can be published. Use this to understand the collection's potential reach across different storefronts." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "The collection description as plain text without HTML formatting. Use this when you need the description without markup." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "descriptionHtml", + "value": "string", + "description": "The collection description formatted as HTML. Use this to display rich text descriptions with formatting and styling in your UI." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The URL-friendly unique identifier used in collection URLs (for example, `'summer-collection'` in `/collections/summer-collection`). Use this to generate collection links or match URL paths." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The collection's unique global identifier (GID). Use this ID for collection-related GraphQL operations." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "ResourceImage | null", + "description": "The featured image displayed for the collection. Use this for collection thumbnails, headers, or preview images.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "productsAutomaticallySortedCount", + "value": "number", + "description": "The count of products automatically added to the collection based on automation rules. Use this to understand how many products match the collection's criteria." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "productsCount", + "value": "number", + "description": "The total number of products in the collection, including both manually added and automatically included products. Use this to show collection size or for pagination." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "productsManuallySortedCount", + "value": "number", + "description": "The count of products manually added by the merchant. Use this to understand how much manual curation the collection has." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "publicationCount", + "value": "number", + "description": "The number of sales channels where the collection is currently published. Use this to check the collection's actual visibility across storefronts." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "ruleSet", + "value": "RuleSet | null", + "description": "The automation rules that determine which products are automatically included. Present only for automated (smart) collections. When `null`, the collection is manually curated. Use this to understand the collection's filtering logic.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "seo", + "value": "{ description?: string; title?: string; }", + "description": "Search engine optimization metadata for the collection. Use this to understand how the collection appears in search engine results." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "sortOrder", + "value": "CollectionSortOrder", + "description": "The default sort order that determines how products are arranged in the collection. This controls the product sequence customers see on the storefront." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "storefrontId", + "value": "string", + "description": "The Storefront API identifier for this collection. Use this ID when making Storefront API queries for this collection." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "templateSuffix", + "value": "string | null", + "description": "The theme template suffix for using custom theme templates (for example, `'featured'` to use `collection.featured.liquid`). When `null`, uses the default collection template.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The collection's display name shown to merchants and customers. Use this as the primary collection identifier in lists and displays." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "updatedAt", + "value": "string", + "description": "ISO 8601 timestamp when the collection was last updated. Use this to track changes, sync with external systems, or show freshness indicators." + } + ], + "value": "export interface Collection extends Resource {\n /** The number of sales channels where this collection can be published. Use this to understand the collection's potential reach across different storefronts. */\n availablePublicationCount: number;\n /** The collection description as plain text without HTML formatting. Use this when you need the description without markup. */\n description: string;\n /** The collection description formatted as HTML. Use this to display rich text descriptions with formatting and styling in your UI. */\n descriptionHtml: string;\n /** The URL-friendly unique identifier used in collection URLs (for example, `'summer-collection'` in `/collections/summer-collection`). Use this to generate collection links or match URL paths. */\n handle: string;\n /** The collection's unique global identifier (GID). Use this ID for collection-related GraphQL operations. */\n id: string;\n /** The featured image displayed for the collection. Use this for collection thumbnails, headers, or preview images. */\n image?: ResourceImage | null;\n /** The count of products automatically added to the collection based on automation rules. Use this to understand how many products match the collection's criteria. */\n productsAutomaticallySortedCount: number;\n /** The total number of products in the collection, including both manually added and automatically included products. Use this to show collection size or for pagination. */\n productsCount: number;\n /** The count of products manually added by the merchant. Use this to understand how much manual curation the collection has. */\n productsManuallySortedCount: number;\n /** The number of sales channels where the collection is currently published. Use this to check the collection's actual visibility across storefronts. */\n publicationCount: number;\n /** The automation rules that determine which products are automatically included. Present only for automated (smart) collections. When `null`, the collection is manually curated. Use this to understand the collection's filtering logic. */\n ruleSet?: RuleSet | null;\n /** Search engine optimization metadata for the collection. Use this to understand how the collection appears in search engine results. */\n seo: {\n /** The SEO meta description that appears in search engine result snippets. This summarizes the collection for search engines. */\n description?: string | null;\n /** The SEO page title that appears in browser tabs and search results. When `null`, the collection's regular title is used. */\n title?: string | null;\n };\n /** The default sort order that determines how products are arranged in the collection. This controls the product sequence customers see on the storefront. */\n sortOrder: CollectionSortOrder;\n /** The Storefront API identifier for this collection. Use this ID when making Storefront API queries for this collection. */\n storefrontId: string;\n /** The theme template suffix for using custom theme templates (for example, `'featured'` to use `collection.featured.liquid`). When `null`, uses the default collection template. */\n templateSuffix?: string | null;\n /** The collection's display name shown to merchants and customers. Use this as the primary collection identifier in lists and displays. */\n title: string;\n /** ISO 8601 timestamp when the collection was last updated. Use this to track changes, sync with external systems, or show freshness indicators. */\n updatedAt: string;\n}" + } + }, + "ResourceImage": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ResourceImage", + "description": "An image associated with a product, variant, or collection. Use image data to display thumbnails, galleries, or product previews in your extension.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "altText", + "value": "string", + "description": "Alternative text describing the image for screen readers and accessibility. This text appears when images fail to load. Use descriptive alt text to make your extension accessible.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique identifier for the image file. Use this ID for image-related GraphQL operations." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "originalSrc", + "value": "string", + "description": "The full URL to the original image file. Use this URL to display the image in your extension UI." + } + ], + "value": "export interface ResourceImage {\n /** The unique identifier for the image file. Use this ID for image-related GraphQL operations. */\n id: string;\n /** Alternative text describing the image for screen readers and accessibility. This text appears when images fail to load. Use descriptive alt text to make your extension accessible. */\n altText?: string;\n /** The full URL to the original image file. Use this URL to display the image in your extension UI. */\n originalSrc: string;\n}" + } + }, + "RuleSet": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "RuleSet", + "description": "A set of rules that determine which products are automatically included in a collection. Use this to understand how an automated collection populates itself with products.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "appliedDisjunctively", + "value": "boolean", + "description": "The logical operator for combining multiple rules. When `true`, products are included if they match ANY rule (OR logic). When `false`, products must match ALL rules (AND logic). Use this to understand the collection's filtering strategy." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "rules", + "value": "CollectionRule[]", + "description": "An array of rules that define product inclusion criteria. Each rule checks a different product attribute. Products are added to the collection based on how these rules are combined (see `appliedDisjunctively`)." + } + ], + "value": "export interface RuleSet {\n /** The logical operator for combining multiple rules. When `true`, products are included if they match ANY rule (OR logic). When `false`, products must match ALL rules (AND logic). Use this to understand the collection's filtering strategy. */\n appliedDisjunctively: boolean;\n /** An array of rules that define product inclusion criteria. Each rule checks a different product attribute. Products are added to the collection based on how these rules are combined (see `appliedDisjunctively`). */\n rules: CollectionRule[];\n}" + } + }, + "CollectionRule": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "CollectionRule", + "description": "A single rule that defines product inclusion criteria for an automated collection. Rules filter products based on their attributes to automatically populate a collection.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "column", + "value": "string", + "description": "The product field to evaluate (for example, `'title'`, `'tag'`, `'vendor'`, or `'product_type'`). This determines which product attribute the rule checks." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "condition", + "value": "string", + "description": "The value to compare against. For example, if checking tags, this might be `'summer'` or `'featured'`. The product attribute must match this condition value according to the relation." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "relation", + "value": "string", + "description": "The comparison operator that determines how the field is matched (for example, `'equals'`, `'contains'`, `'starts_with'`, `'ends_with'`, `'not_equals'`). This defines the matching logic between the column and condition." + } + ], + "value": "export interface CollectionRule {\n /** The product field to evaluate (for example, `'title'`, `'tag'`, `'vendor'`, or `'product_type'`). This determines which product attribute the rule checks. */\n column: string;\n /** The value to compare against. For example, if checking tags, this might be `'summer'` or `'featured'`. The product attribute must match this condition value according to the relation. */\n condition: string;\n /** The comparison operator that determines how the field is matched (for example, `'equals'`, `'contains'`, `'starts_with'`, `'ends_with'`, `'not_equals'`). This defines the matching logic between the column and condition. */\n relation: string;\n}" + } + }, + "CollectionSortOrder": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "CollectionSortOrder", + "value": "export enum CollectionSortOrder {\n /** Products arranged in the custom order set by the merchant. Use this when merchants have manually organized products for specific merchandising. */\n Manual = 'MANUAL',\n /** Products sorted by sales volume, with best-sellers first. Use this to highlight popular products. */\n BestSelling = 'BEST_SELLING',\n /** Products sorted alphabetically by title from A to Z. Use this for easy browsing of product names. */\n AlphaAsc = 'ALPHA_ASC',\n /** Products sorted alphabetically by title from Z to A. Use this for reverse alphabetical ordering. */\n AlphaDesc = 'ALPHA_DESC',\n /** Products sorted by price from highest to lowest. Use this to show premium or expensive items first. */\n PriceDesc = 'PRICE_DESC',\n /** Products sorted by price from lowest to highest. Use this to show affordable options first. */\n PriceAsc = 'PRICE_ASC',\n /** Products sorted by creation date with newest products first. Use this to highlight recently added items. */\n CreatedDesc = 'CREATED_DESC',\n /** Products sorted by creation date with oldest products first. Use this for chronological ordering. */\n Created = 'CREATED',\n /** Products sorted by search relevance based on query terms. Use this when the collection is filtered by search. */\n MostRelevant = 'MOST_RELEVANT',\n}", + "description": "The sort order that determines how products appear in a collection. This controls the default product arrangement that customers see when viewing the collection on the storefront.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Manual", + "value": "MANUAL", + "description": "Products arranged in the custom order set by the merchant. Use this when merchants have manually organized products for specific merchandising." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "BestSelling", + "value": "BEST_SELLING", + "description": "Products sorted by sales volume, with best-sellers first. Use this to highlight popular products." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "AlphaAsc", + "value": "ALPHA_ASC", + "description": "Products sorted alphabetically by title from A to Z. Use this for easy browsing of product names." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "AlphaDesc", + "value": "ALPHA_DESC", + "description": "Products sorted alphabetically by title from Z to A. Use this for reverse alphabetical ordering." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "PriceDesc", + "value": "PRICE_DESC", + "description": "Products sorted by price from highest to lowest. Use this to show premium or expensive items first." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "PriceAsc", + "value": "PRICE_ASC", + "description": "Products sorted by price from lowest to highest. Use this to show affordable options first." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "CreatedDesc", + "value": "CREATED_DESC", + "description": "Products sorted by creation date with newest products first. Use this to highlight recently added items." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Created", + "value": "CREATED", + "description": "Products sorted by creation date with oldest products first. Use this for chronological ordering." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "MostRelevant", + "value": "MOST_RELEVANT", + "description": "Products sorted by search relevance based on query terms. Use this when the collection is filtered by search." + } + ] + } + }, + "IntentQuery": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentQuery", + "description": "A structured intent specification defining what workflow to launch. Use this format when you prefer object syntax over string query format.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "IntentAction", + "description": "The operation to perform: `'create'` for new resources or `'edit'` for existing ones." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ [key: string]: unknown; }", + "description": "Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "IntentType", + "description": "The type of resource to create or edit (for example, `'shopify/Product'`)." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.", + "isOptional": true + } + ], + "value": "export interface IntentQuery extends IntentQueryOptions {\n /**\n * The operation to perform: `'create'` for new resources or `'edit'` for existing ones.\n */\n action: IntentAction;\n /**\n * The type of resource to create or edit (for example, `'shopify/Product'`).\n */\n type: IntentType;\n}" + } + }, + "LoadingOptions": { + "src/surfaces/admin/api/loading/loading.ts": { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "name": "LoadingOptions", + "description": "Options to configure the Admin page-level loading indicator.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "syntaxKind": "PropertySignature", + "name": "isLoading", + "value": "boolean", + "description": "Pass `true` to show the loading indicator, `false` to hide it.", + "isOptional": true + } + ], + "value": "export interface LoadingOptions {\n /**\n * Pass `true` to show the loading indicator, `false` to hide it.\n */\n isLoading?: boolean;\n}" + } + }, + "Money": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Money", + "value": "string", + "description": "A monetary value represented as a string (for example, `\"19.99\"` or `\"0.00\"`). The format always includes the decimal point and cents, even for whole dollar amounts. Use this type for prices, costs, and other currency values.", + "isPublicDocs": true + } + }, + "FulfillmentServiceType": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "FulfillmentServiceType", + "value": "export enum FulfillmentServiceType {\n /** Digital gift card fulfillment with automatic delivery. No physical shipping required. */\n GiftCard = 'GIFT_CARD',\n /** Manual fulfillment handled directly by the merchant. The merchant packs and ships orders themselves. */\n Manual = 'MANUAL',\n /** Third-party fulfillment service that handles warehousing and shipping (for example, ShipBob, Amazon FBA, or custom 3PL providers). */\n ThirdParty = 'THIRD_PARTY',\n}", + "description": "The types of fulfillment services that can handle order fulfillment. This determines how products are delivered to customers.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "GiftCard", + "value": "GIFT_CARD", + "description": "Digital gift card fulfillment with automatic delivery. No physical shipping required." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Manual", + "value": "MANUAL", + "description": "Manual fulfillment handled directly by the merchant. The merchant packs and ships orders themselves." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ThirdParty", + "value": "THIRD_PARTY", + "description": "Third-party fulfillment service that handles warehousing and shipping (for example, ShipBob, Amazon FBA, or custom 3PL providers)." + } + ] + } + }, + "WeightUnit": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "WeightUnit", + "value": "export enum WeightUnit {\n /** Weight measured in kilograms (kg). Commonly used in metric system countries. */\n Kilograms = 'KILOGRAMS',\n /** Weight measured in grams (g). Used for lightweight items in metric system. */\n Grams = 'GRAMS',\n /** Weight measured in pounds (lb). Commonly used in the United States. */\n Pounds = 'POUNDS',\n /** Weight measured in ounces (oz). Used for lightweight items in imperial system. */\n Ounces = 'OUNCES',\n}", + "description": "The unit of measurement for product weight. Use this with the weight value to calculate shipping costs or display product specifications.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Kilograms", + "value": "KILOGRAMS", + "description": "Weight measured in kilograms (kg). Commonly used in metric system countries." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Grams", + "value": "GRAMS", + "description": "Weight measured in grams (g). Used for lightweight items in metric system." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Pounds", + "value": "POUNDS", + "description": "Weight measured in pounds (lb). Commonly used in the United States." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Ounces", + "value": "OUNCES", + "description": "Weight measured in ounces (oz). Used for lightweight items in imperial system." + } + ] + } + }, + "ProductVariantInventoryPolicy": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "ProductVariantInventoryPolicy", + "value": "export enum ProductVariantInventoryPolicy {\n /** Prevents purchases when inventory reaches zero. Customers can't add out-of-stock variants to their cart. Use this to avoid overselling. */\n Deny = 'DENY',\n /** Allows purchases even when inventory is zero or negative. Customers can continue buying out-of-stock variants. Use this for backorders or made-to-order products. */\n Continue = 'CONTINUE',\n}", + "description": "The inventory policy that determines whether customers can purchase a variant when it's out of stock. Use this to control checkout behavior for low or zero inventory items.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Deny", + "value": "DENY", + "description": "Prevents purchases when inventory reaches zero. Customers can't add out-of-stock variants to their cart. Use this to avoid overselling." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Continue", + "value": "CONTINUE", + "description": "Allows purchases even when inventory is zero or negative. Customers can continue buying out-of-stock variants. Use this for backorders or made-to-order products." + } + ] + } + }, + "ProductVariantInventoryManagement": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "ProductVariantInventoryManagement", + "value": "export enum ProductVariantInventoryManagement {\n /** Inventory tracked and managed by Shopify. Stock levels update through Shopify admin or API. Use this for standard inventory management. */\n Shopify = 'SHOPIFY',\n /** Inventory not tracked. The variant is always considered in stock. Use this for services, digital goods, or custom products with unlimited availability. */\n NotManaged = 'NOT_MANAGED',\n /** Inventory tracked by an external fulfillment service. The third-party system manages stock levels. Use this when a 3PL or fulfillment app controls inventory. */\n FulfillmentService = 'FULFILLMENT_SERVICE',\n}", + "description": "The system responsible for tracking inventory levels for a variant. This determines where stock counts are managed and updated.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Shopify", + "value": "SHOPIFY", + "description": "Inventory tracked and managed by Shopify. Stock levels update through Shopify admin or API. Use this for standard inventory management." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "NotManaged", + "value": "NOT_MANAGED", + "description": "Inventory not tracked. The variant is always considered in stock. Use this for services, digital goods, or custom products with unlimited availability." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "FulfillmentService", + "value": "FULFILLMENT_SERVICE", + "description": "Inventory tracked by an external fulfillment service. The third-party system manages stock levels. Use this when a 3PL or fulfillment app controls inventory." + } + ] + } + }, + "ProductStatus": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "ProductStatus", + "value": "export enum ProductStatus {\n /** The product is published and available for sale on active sales channels. Customers can view and purchase this product. */\n Active = 'ACTIVE',\n /** The product is archived and no longer available. Archived products don't appear on storefronts and can't be purchased. Use this for discontinued items. */\n Archived = 'ARCHIVED',\n /** The product is an unpublished draft not visible to customers. Draft products are still being prepared or reviewed. */\n Draft = 'DRAFT',\n}", + "description": "The publication status indicating a product's availability state. Use this to filter products or determine which products customers can see and purchase.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Active", + "value": "ACTIVE", + "description": "The product is published and available for sale on active sales channels. Customers can view and purchase this product." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Archived", + "value": "ARCHIVED", + "description": "The product is archived and no longer available. Archived products don't appear on storefronts and can't be purchased. Use this for discontinued items." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Draft", + "value": "DRAFT", + "description": "The product is an unpublished draft not visible to customers. Draft products are still being prepared or reviewed." + } + ] + } + }, + "StandardRenderingExtensionApi": { + "src/surfaces/admin/api/standard/standard-rendering.ts": { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "name": "StandardRenderingExtensionApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface StandardRenderingExtensionApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardApi {\n /**\n * Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel.\n */\n resourcePicker: ResourcePickerApi;\n\n /**\n * Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.\n */\n picker: PickerApi;\n}" + } + }, + "CustomerStandardMetafieldDependency": { + "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts": { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CustomerStandardMetafieldDependency", + "value": "'facts.birth_date'", + "description": "Standard customer metafields that can be referenced as template dependencies.", + "isPublicDocs": true + } + }, + "OrderRoutingRule": { + "src/surfaces/admin/api/order-routing-rule/data.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "name": "OrderRoutingRule", + "description": "An order routing rule configuration that determines how orders are routed to fulfillment locations. Use this to access the rule's current settings and populate your configuration interface.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "A description explaining the rule's purpose and how it routes orders. Use this to help merchants understand what the rule does." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique global identifier (GID) for the order routing rule. Use this ID to associate configuration changes with the correct rule." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The display label for the order routing rule shown to merchants in the admin. Use this to identify the rule in lists and settings pages." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "An array of [metafields](/docs/apps/build/metafields) that store the routing rule's configuration values. Use these metafields to populate your settings UI with the current rule configuration." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "priority", + "value": "number", + "description": "The priority order for rule evaluation when multiple rules exist. Lower numbers are evaluated first (for example, a rule with priority 1 runs before priority 2). Use this to understand the rule's position in the evaluation sequence.", + "isOptional": true + } + ], + "value": "export interface OrderRoutingRule {\n /** The display label for the order routing rule shown to merchants in the admin. Use this to identify the rule in lists and settings pages. */\n label: string;\n /** A description explaining the rule's purpose and how it routes orders. Use this to help merchants understand what the rule does. */\n description: string;\n /** The unique global identifier (GID) for the order routing rule. Use this ID to associate configuration changes with the correct rule. */\n id: string;\n /** The priority order for rule evaluation when multiple rules exist. Lower numbers are evaluated first (for example, a rule with priority 1 runs before priority 2). Use this to understand the rule's position in the evaluation sequence. */\n priority?: number;\n /** An array of [metafields](/docs/apps/build/metafields) that store the routing rule's configuration values. Use these metafields to populate your settings UI with the current rule configuration. */\n metafields: Metafield[];\n}" + } + }, + "ComponentChildren": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentChildren", + "value": "preact.ComponentChildren", + "description": "Represents any valid children that can be rendered within a component, including elements, strings, numbers, or arrays of these types. This is an alias for Preact's `ComponentChildren` type.", + "isPublicDocs": true + } + }, + "StringChildren": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "StringChildren", + "value": "string", + "description": "Represents string-only children for components that specifically require text content.", + "isPublicDocs": true + } + }, + "ActionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ActionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The text to use as the action modal's title. If not provided, the name of the extension will be used.", + "isOptional": true + } + ], + "value": "export interface ActionProps {\n /**\n * The text to use as the action modal's title. If not provided, the name of the extension will be used.\n */\n heading?: string;\n}" + } + }, + "ActionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ActionSlots", + "description": "The action component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + } + ], + "value": "export interface ActionSlots {\n /**\n * The primary action button or link, representing the main or most important action available in this context.\n * Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.\n */\n primaryAction?: ComponentChildren;\n /**\n * Additional action buttons or links that provide alternative or supporting actions.\n * Visually de-emphasized compared to the primary action.\n */\n secondaryActions?: ComponentChildren;\n}" + } + }, + "BaseOverlayProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseOverlayProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterShow", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + } + ], + "value": "export interface BaseOverlayProps {\n /**\n * A callback fired immediately after the overlay is shown.\n */\n onShow?: (event: Event) => void;\n /**\n * A callback fired when the overlay is shown, after any show animations have completed.\n */\n onAfterShow?: (event: Event) => void;\n /**\n * A callback fired immediately after the overlay is hidden.\n */\n onHide?: (event: Event) => void;\n /**\n * A callback fired when the overlay is hidden, after any hide animations have completed.\n */\n onAfterHide?: (event: Event) => void;\n}" + } + }, + "BaseOverlayMethods": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseOverlayMethods", + "description": "Shared interface for web component methods that control overlay visibility.\n\nAll methods are required (not optional) because components implementing this interface must provide consistent JavaScript APIs. Unlike props/attributes, methods are not rendered in HTML and consumers expect them to be available on all component instances.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "showOverlay", + "value": "() => void", + "description": "A method to programmatically show the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "toggleOverlay", + "value": "() => void", + "description": "A method to programmatically toggle the visibility of the overlay." + } + ], + "value": "export interface BaseOverlayMethods {\n /**\n * A method to programmatically show the overlay.\n *\n * @implementation This is a method to be called on the element and not a callback and should hence be camelCase\n */\n showOverlay: () => void;\n /**\n * A method to programmatically hide the overlay.\n *\n * @implementation This is a method to be called on the element and not a callback and should hence be camelCase\n */\n hideOverlay: () => void;\n /**\n * A method to programmatically toggle the visibility of the overlay.\n *\n * @implementation This is a method to be called on the element and not a callback and should hence be camelCase\n */\n toggleOverlay: () => void;\n}" + } + }, + "FocusEventProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FocusEventProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface FocusEventProps {\n /**\n * A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n onBlur?: (event: FocusEvent) => void;\n /**\n * A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n onFocus?: (event: FocusEvent) => void;\n}" + } + }, + "ToggleEventProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ToggleEventProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + } + ], + "value": "export interface ToggleEventProps {\n /**\n * A callback fired when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n onAfterToggle?: (event: ToggleEvent$1) => void;\n /**\n * A callback fired immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n onToggle?: (event: ToggleEvent$1) => void;\n}" + } + }, + "ToggleState": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ToggleState", + "value": "'open' | 'closed'", + "description": "Represents the visibility state of a toggleable element.\n\n- `open`: The element is visible or expanded.\n- `closed`: The element is hidden or collapsed.", + "isPublicDocs": true + } + }, + "ExtendableEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ExtendableEvent", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "waitUntil", + "value": "(promise: Promise) => void", + "description": "A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.\n\nCan be called multiple times to add promises to the event, but must be called synchronously during event dispatch. Cannot be called after a `setTimeout` or within a microtask.", + "isOptional": true + } + ], + "value": "export interface ExtendableEvent extends Event {\n /**\n * A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.\n *\n * Can be called multiple times to add promises to the event, but must be called synchronously during event dispatch.\n * Cannot be called after a `setTimeout` or within a microtask.\n */\n waitUntil?: (promise: Promise) => void;\n}" + } + }, + "AggregateError": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AggregateError", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "errors", + "value": "T[]", + "description": "An array of individual errors that have been aggregated together. Each error in this array represents a separate failure that occurred." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "stack", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface AggregateError extends Error {\n /**\n * An array of individual errors that have been aggregated together.\n * Each error in this array represents a separate failure that occurred.\n */\n errors: T[];\n}" + } + }, + "AggregateErrorEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AggregateErrorEvent", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "colno", + "value": "number", + "description": "The **`colno`** read-only property of the ErrorEvent interface returns an integer containing the column number of the script file on which the error occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "AggregateError", + "description": "The aggregated error object containing multiple individual errors. Access the `errors` property to retrieve the array of individual error instances." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "filename", + "value": "string", + "description": "The **`filename`** read-only property of the ErrorEvent interface returns a string containing the name of the script file in which the error occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lineno", + "value": "number", + "description": "The **`lineno`** read-only property of the ErrorEvent interface returns an integer containing the line number of the script file on which the error occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "The **`message`** read-only property of the ErrorEvent interface returns a string containing a human-readable error message describing the problem.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/message)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + } + ], + "value": "export interface AggregateErrorEvent extends ErrorEvent {\n /**\n * The aggregated error object containing multiple individual errors.\n * Access the `errors` property to retrieve the array of individual error instances.\n */\n error: AggregateError;\n}" + } + }, + "ToneKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ToneKeyword", + "value": "'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical' | 'accent' | 'custom'", + "description": "Defines the semantic color treatment of a component to convey specific intent or status.\n\nTones apply coordinated color schemes (text, background, icons) across the component. Some components, like banner, also use tone to determine accessibility attributes and screen reader announcements.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General-purpose information without specific sentiment.\n- `info`: Informational content that provides helpful details or guidance.\n- `success`: Positive outcomes, successful operations, or confirmations.\n- `caution`: Warnings about potential issues that require attention but aren't critical.\n- `warning`: Similar to caution, indicates something that needs user awareness.\n- `critical`: Errors, failures, or urgent issues that require immediate attention.\n- `accent`: Highlighted or emphasized content that doesn't fit other semantic tones.\n- `custom`: Custom color treatment defined by your theme or implementation.", + "isPublicDocs": true + } + }, + "IconType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IconType", + "value": "'replace' | 'search' | 'split' | 'link' | 'edit' | 'info' | 'incomplete' | 'complete' | 'product' | 'variant' | 'collection' | 'select' | 'color' | 'money' | 'order' | 'code' | 'adjust' | 'affiliate' | 'airplane' | 'alert-bubble' | 'alert-circle' | 'alert-diamond' | 'alert-location' | 'alert-octagon' | 'alert-octagon-filled' | 'alert-triangle' | 'alert-triangle-filled' | 'app-extension' | 'apps' | 'archive' | 'arrow-down' | 'arrow-down-circle' | 'arrow-down-right' | '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' | 'battery-low' | 'bill' | 'blank' | 'blog' | 'bolt' | 'bolt-filled' | 'book' | 'book-open' | '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-filled' | 'cart-sale' | 'cart-send' | 'cart-up' | 'cash-dollar' | 'cash-euro' | 'cash-pound' | 'cash-rupee' | 'cash-yen' | 'catalog-product' | 'categories' | 'channels' | '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-add' | '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' | 'delivered' | 'delivery' | 'desktop' | 'disabled' | 'disabled-filled' | 'discount' | 'discount-add' | 'discount-automatic' | 'discount-code' | 'discount-remove' | 'dns-settings' | 'dock-floating' | 'dock-side' | 'domain' | 'domain-landing-page' | 'domain-new' | 'domain-redirect' | 'download' | 'drag-drop' | 'drag-handle' | 'drawer' | 'duplicate' | 'email' | 'email-follow-up' | 'email-newsletter' | 'empty' | 'enabled' | 'enter' | 'envelope' | 'envelope-soft-pack' | 'eraser' | 'exchange' | 'exit' | 'export' | 'external' | 'eye-check-mark' | 'eye-dropper' | 'eye-dropper-list' | 'eye-first' | 'eyeglasses' | 'fav' | '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' | 'geolocation' | 'gift' | 'gift-card' | 'git-branch' | 'git-commit' | 'git-repository' | 'globe' | 'globe-asia' | 'globe-europe' | 'globe-lines' | 'globe-list' | 'graduation-hat' | 'grid' | 'hashtag' | 'hashtag-decimal' | 'hashtag-list' | 'heart' | 'hide' | 'hide-filled' | 'home' | 'home-filled' | 'icons' | 'identity-card' | 'image' | 'image-add' | 'image-alt' | 'image-explore' | 'image-magic' | 'image-none' | 'image-with-text-overlay' | 'images' | 'import' | 'in-progress' | 'incentive' | 'incoming' | 'info-filled' | 'inheritance' | 'inventory' | 'inventory-edit' | 'inventory-list' | 'inventory-transfer' | 'inventory-updated' | 'iq' | 'key' | 'keyboard' | 'keyboard-filled' | 'keyboard-hide' | 'keypad' | 'label-printer' | 'language' | 'language-translate' | '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-list' | 'list-bulleted' | 'list-bulleted-filled' | 'list-numbered' | 'live' | 'live-critical' | 'live-none' | '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-filled' | 'menu-horizontal' | 'menu-vertical' | 'merge' | 'metafields' | 'metaobject' | 'metaobject-list' | 'metaobject-reference' | 'microphone' | 'microphone-muted' | 'minimize' | 'minus' | 'minus-circle' | 'mobile' | 'money-none' | 'money-split' | 'moon' | 'nature' | 'note' | 'note-add' | 'notification' | 'number-one' | 'order-batches' | 'order-draft' | 'order-filled' | 'order-first' | 'order-fulfilled' | 'order-repeat' | 'order-unfulfilled' | 'orders-status' | 'organization' | 'outdent' | 'outgoing' | 'package' | 'package-cancel' | 'package-fulfilled' | 'package-on-hold' | 'package-reassign' | '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' | 'partially-complete' | 'passkey' | 'paste' | 'pause-circle' | 'payment' | 'payment-capture' | 'payout' | 'payout-dollar' | 'payout-euro' | 'payout-pound' | 'payout-rupee' | 'payout-yen' | 'person' | 'person-add' | 'person-exit' | 'person-filled' | 'person-list' | 'person-lock' | 'person-remove' | 'person-segment' | 'personalized-text' | 'phablet' | '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' | 'point-of-sale-register' | 'price-list' | 'print' | 'product-add' | 'product-cost' | 'product-filled' | '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-folded' | 'receipt-paid' | 'receipt-pound' | 'receipt-refund' | 'receipt-rupee' | 'receipt-yen' | 'receivables' | 'redo' | 'referral-code' | 'refresh' | 'remove-background' | 'reorder' | 'replay' | 'reset' | 'return' | 'reward' | 'rocket' | 'rotate-left' | 'rotate-right' | 'sandbox' | 'save' | 'savings' | 'scan-qr-code' | 'search-add' | 'search-list' | 'search-recent' | 'search-resource' | 'send' | 'settings' | 'share' | 'shield-check-mark' | 'shield-none' | 'shield-pending' | 'shield-person' | 'shipping-label' | 'shipping-label-cancel' | 'shopcodes' | 'slideshow' | 'smiley-happy' | 'smiley-joy' | 'smiley-neutral' | 'smiley-sad' | 'social-ad' | 'social-post' | 'sort' | 'sort-ascending' | 'sort-descending' | 'sound' | 'sports' | 'star' | 'star-circle' | 'star-filled' | 'star-half' | '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-indent-remove' | 'text-italic' | 'text-quote' | 'text-title' | 'text-underline' | 'text-with-image' | 'theme' | 'theme-edit' | 'theme-store' | 'theme-template' | 'three-d-environment' | 'thumbs-down' | 'thumbs-up' | 'tip-jar' | 'toggle-off' | 'toggle-on' | 'transaction' | 'transaction-fee-add' | 'transaction-fee-dollar' | 'transaction-fee-euro' | 'transaction-fee-pound' | 'transaction-fee-rupee' | 'transaction-fee-yen' | 'transfer' | 'transfer-in' | 'transfer-internal' | 'transfer-out' | 'truck' | 'undo' | 'unknown-device' | 'unlock' | 'upload' | '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' | 'x-circle-filled'", + "description": "Represents the available icon names that can be used in icon components. This is derived from the complete list of supported icons in the design system.", + "isPublicDocs": true + } + }, + "ExtractStrict": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtractStrict", + "value": "", + "description": "A type-safe version of TypeScript's `Extract` utility that constrains the second type parameter to be assignable to the first. This provides compile-time validation that you're only extracting types that actually exist within the union, catching potential errors earlier in development.", + "isPublicDocs": true + } + }, + "optionalSpace": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "optionalSpace", + "value": "'' | ' '", + "description": "A utility type representing an optional space character for use in string literal type composition. Allows flexible formatting of compound values where spacing is a matter of preference rather than semantic difference.", + "isPublicDocs": true + } + }, + "DisplayProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DisplayProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface DisplayProps {\n /**\n * The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n *\n * - `auto`: the component’s initial value. The actual value depends on the component and context.\n * - `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n *\n * Learn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).\n *\n * @default 'auto'\n */\n display?: MaybeResponsive<'auto' | 'none'>;\n}" + } + }, + "AccessibilityRoleProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AccessibilityRoleProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + } + ], + "value": "export interface AccessibilityRoleProps {\n /**\n * The semantic meaning of the component’s content. When set,\n * the role will be used by assistive technologies to help users\n * navigate the page.\n *\n * @implementation Although, in HTML hosts, this property changes the element used,\n * changing this property must not impact the visual styling of inside or outside of the box.\n *\n * @default 'generic'\n */\n accessibilityRole?: AccessibilityRole;\n}" + } + }, + "LabelAccessibilityVisibilityProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LabelAccessibilityVisibilityProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + } + ], + "value": "export interface LabelAccessibilityVisibilityProps {\n /**\n * Controls whether the label is visible to all users or only to screen readers.\n *\n * - `visible`: The label is shown to everyone (default).\n * - `exclusive`: The label is visually hidden but still announced by screen readers.\n *\n * Use `exclusive` when the surrounding context makes the label redundant visually,\n * but screen reader users still need it for clarity.\n *\n * @default 'visible'\n */\n labelAccessibilityVisibility?: ExtractStrict<\n AccessibilityVisibilityProps['accessibilityVisibility'],\n 'visible' | 'exclusive'\n >;\n}" + } + }, + "BorderRadiusKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderRadiusKeyword", + "value": "SizeKeyword | 'max' | 'none'", + "description": "Defines the radius of rounded corners, using the standard size scale, `max` for fully rounded, or `none` for sharp corners.", + "isPublicDocs": true + } + }, + "OverflowProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OverflowProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + } + ], + "value": "export interface OverflowProps {\n /**\n * The overflow behavior of the element.\n *\n * - `visible`: the content that extends beyond the element’s container is visible.\n * - `hidden`: clips the content when it is larger than the element’s container.\n * The element will not be scrollable and the users will not be able\n * to access the clipped content by dragging or using a scroll wheel on a mouse.\n *\n * @default 'visible'\n */\n overflow?: 'hidden' | 'visible';\n}" + } + }, + "BaseBoxProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseBoxProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface BaseBoxProps\n extends AccessibilityVisibilityProps,\n BackgroundProps,\n DisplayProps,\n SizingProps,\n PaddingProps,\n BorderProps,\n OverflowProps {\n /**\n * The content displayed within the box component, which serves as a flexible container for organizing and styling other components.\n */\n children?: ComponentChildren;\n /**\n * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.\n */\n accessibilityLabel?: string;\n}" + } + }, + "BaseBoxPropsWithRole": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseBoxPropsWithRole", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface BaseBoxPropsWithRole\n extends BaseBoxProps,\n AccessibilityRoleProps {}" + } + }, + "ButtonBehaviorProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonBehaviorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ], + "value": "export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {\n /**\n * The behavior of the button component.\n *\n * - `button`: Used to indicate the component acts as a button, meaning it has no default action.\n * - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n * - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n *\n * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.\n *\n * @default 'button'\n */\n type?: 'submit' | 'button' | 'reset';\n /**\n * A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n onClick?: (event: Event) => void;\n /**\n * Whether the button is disabled, preventing it from being clicked or receiving focus.\n *\n * @default false\n */\n disabled?: boolean;\n /**\n * Whether to replace the button content with a loading indicator while a background action is being performed.\n *\n * This also disables the button component.\n *\n * @default false\n */\n loading?: boolean;\n}" + } + }, + "LinkBehaviorProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LinkBehaviorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {\n /**\n * The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.\n */\n href?: string;\n /**\n * The browsing context where the linked URL should be displayed.\n *\n * - `auto`: The target is automatically determined based on the origin of the URL.\n * - `_blank`: Opens the URL in a new window or tab.\n * - `_self`: Opens the URL in the same browsing context as the current one.\n * - `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n * - `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.\n *\n * @implementation Surfaces can set specific rules on how they handle each URL.\n * @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.\n * @implementation For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n *\n * Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n *\n * @default 'auto'\n */\n target?: 'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString;\n /**\n * Prompts the browser to download the linked URL rather than navigate to it.\n * When set, the value specifies the suggested filename for the downloaded file.\n *\n * The filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes.\n * Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n *\n * Learn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).\n */\n download?: string;\n /**\n * A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n onClick?: (event: Event) => void;\n}" + } + }, + "InteractionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "InteractionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "export interface InteractionProps {\n /**\n * The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n */\n commandFor?: string;\n /**\n * The action that `commandFor` should take when this component is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the visibility of the target component.\n * - `--copy`: Copies the target `ClipboardItem`.\n *\n * Learn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n *\n * @default '--auto'\n */\n command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';\n /**\n * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.\n */\n interestFor?: string;\n}" + } + }, + "BaseClickableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseClickableProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ], + "value": "export interface BaseClickableProps\n extends ButtonBehaviorProps,\n LinkBehaviorProps {}" + } + }, + "BaseInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseInputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + } + ], + "value": "export interface BaseInputProps {\n /**\n * The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.\n */\n name?: string;\n /**\n * Whether the field is disabled, preventing any user interaction.\n *\n * @default false\n */\n disabled?: boolean;\n}" + } + }, + "InputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "InputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface InputProps extends BaseInputProps {\n /**\n * A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n onChange?: (event: Event) => void;\n /**\n * A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).\n */\n onInput?: (event: Event) => void;\n value?: string;\n /**\n * The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.\n *\n * @implementation `defaultValue` reflects to the `value` attribute.\n */\n defaultValue?: string;\n}" + } + }, + "MultipleInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MultipleInputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user selects or deselects options. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "values", + "value": "string[]", + "description": "An array of `value` attributes for the currently selected options. When provided, this property automatically sets the `selected` state on child option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.", + "isOptional": true + } + ], + "value": "export interface MultipleInputProps extends BaseInputProps {\n /**\n * A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n onChange?: (event: Event) => void;\n /**\n * A callback fired when the user selects or deselects options. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).\n */\n onInput?: (event: Event) => void;\n /**\n * An array of `value` attributes for the currently selected options. When provided, this property automatically sets the `selected` state on child option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.\n */\n values?: string[];\n}" + } + }, + "FileInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FileInputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "files", + "value": "ReadonlyArray", + "description": "An array of File objects representing the files currently selected by the user.\n\nThis property is read-only and cannot be directly modified. To clear the selected files, set the `value` prop to an empty string or null.", + "isOptional": true, + "defaultValue": "[]" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished selecting one or more files.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes to the file selection.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "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.\n\nLearn more about the [file input value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value).", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface FileInputProps extends BaseInputProps {\n /**\n * A callback fired when the user has finished selecting one or more files.\n */\n onChange?: (event: Event) => void;\n /**\n * A callback fired when the user makes any changes to the file selection.\n */\n onInput?: (event: Event) => void;\n /**\n * A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\").\n * When the user selected multiple files, the value represents the first file in the list of files they selected.\n * The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file.\n *\n * Learn more about the [file input value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value).\n *\n * @default ''\n */\n value?: string;\n /**\n * An array of File objects representing the files currently selected by the user.\n *\n * This property is read-only and cannot be directly modified.\n * To clear the selected files, set the `value` prop to an empty string or null.\n *\n * @default []\n */\n files?: ReadonlyArray;\n}" + } + }, + "FieldErrorProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldErrorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + } + ], + "value": "export interface FieldErrorProps {\n /**\n * An error message displayed below the checkbox to indicate validation problems.\n * When set, the checkbox is styled with error indicators and the message is announced to screen readers.\n */\n error?: string;\n}" + } + }, + "BasicFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BasicFieldProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface BasicFieldProps\n extends FieldErrorProps,\n LabelAccessibilityVisibilityProps {\n /**\n * Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.\n *\n * @default false\n */\n required?: boolean;\n /**\n * The text displayed as the field label, which identifies the purpose of the field to users.\n * This label is associated with the field for accessibility and helps users understand what information to provide.\n */\n label?: string;\n}" + } + }, + "FieldDetailsProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldDetailsProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + } + ], + "value": "export interface FieldDetailsProps {\n /**\n * Supplementary text displayed below the checkbox to provide additional context, instructions, or help.\n * Use this to explain what checking the box means or provide guidance to users.\n * This text is announced to screen readers.\n */\n details?: string;\n}" + } + }, + "FieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FieldProps\n extends BasicFieldProps,\n InputProps,\n FocusEventProps,\n FieldDetailsProps {\n /**\n * The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.\n */\n placeholder?: string;\n}" + } + }, + "BaseTextFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseTextFieldProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface BaseTextFieldProps extends FieldProps {\n /**\n * Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.\n *\n * @default false\n */\n readOnly?: boolean;\n}" + } + }, + "FieldDecorationProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldDecorationProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "ComponentChildren", + "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconType | AnyString", + "description": "An icon displayed inside the field to provide visual context about the expected input or field purpose. Commonly used for search fields, currency inputs, or to indicate field type. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string", + "description": "A non-editable text value 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`.\n\nThis text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "string", + "description": "A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n\nThis text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface FieldDecorationProps {\n /**\n * A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n *\n * This text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.\n *\n * @default ''\n */\n suffix?: string;\n /**\n * A non-editable text value 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`.\n *\n * This text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.\n *\n * @default ''\n */\n prefix?: string;\n /**\n * An icon displayed inside the field to provide visual context about the expected input or field purpose.\n * Commonly used for search fields, currency inputs, or to indicate field type.\n * Accepts any icon name from the icon library or a custom string identifier.\n *\n * @default ''\n */\n icon?: IconType | AnyString;\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: ComponentChildren;\n}" + } + }, + "NumberConstraintsProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "NumberConstraintsProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "controls", + "value": "'auto' | 'stepper' | 'none'", + "description": "The type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + } + ], + "value": "export interface NumberConstraintsProps {\n /**\n * The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n *\n * Users can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.\n *\n * @default Infinity\n */\n max?: number;\n /**\n * The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n *\n * Users can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.\n *\n * @default -Infinity\n */\n min?: number;\n /**\n * The amount the value can increase or decrease by. This can be an integer or decimal.\n * If a `max` or `min` is specified with `step` when increasing/decreasing the value\n * via the buttons, the final value will always round to the `max` or `min`\n * rather than the closest valid amount.\n *\n * @default 1\n */\n step?: number;\n /**\n * The type of controls displayed in the field.\n *\n * - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property.\n * Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n * - `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n * - `auto`: the presence of the controls depends on the surface and context.\n *\n * @default 'auto'\n */\n controls?: 'auto' | 'stepper' | 'none';\n}" + } + }, + "MinMaxLengthProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MinMaxLengthProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "isOptional": true, + "defaultValue": "0" + } + ], + "value": "export interface MinMaxLengthProps {\n /**\n * The maximum number of characters allowed in the field.\n *\n * @default Infinity\n */\n maxLength?: number;\n /**\n * The minimum number of characters required in the field.\n *\n * @default 0\n */\n minLength?: number;\n}" + } + }, + "BaseSelectableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseSelectableProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + } + ], + "value": "export interface BaseSelectableProps {\n /**\n * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.\n */\n accessibilityLabel?: string;\n /**\n * Whether the checkbox is disabled, preventing user interaction.\n * Disabled checkboxes appear dimmed and their values aren't submitted with forms.\n *\n * @default false\n */\n disabled?: boolean;\n /**\n * The value submitted with the form when this checkbox is checked.\n * If not specified, the default value is \"on\".\n */\n value?: string;\n}" + } + }, + "BaseOptionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseOptionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultSelected", + "value": "boolean", + "description": "The initial selected state for uncontrolled components. Use this when you want the option to start selected but don't need to control its state afterward.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the option is currently selected. Use this for controlled components where you manage the selection state.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + } + ], + "value": "export interface BaseOptionProps extends BaseSelectableProps {\n /**\n * Whether the option is currently selected. Use this for controlled components where you manage the selection state.\n *\n * @default false\n */\n selected?: boolean;\n /**\n * The initial selected state for uncontrolled components. Use this when you want the option to start selected\n * but don't need to control its state afterward.\n *\n * @implementation `defaultSelected` reflects to the `selected` attribute.\n *\n * @default false\n */\n defaultSelected?: boolean;\n}" + } + }, + "BaseCheckableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseCheckableProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked. Use this for controlled components where you manage the checked state.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "The initial checked state for uncontrolled components. Use this when you want the control to start checked but don't need to control its state afterward.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name used to identify this checkbox in form submissions. When the checkbox is checked, its `name` and `value` are included in the form data. Must be unique within the containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + } + ], + "value": "export interface BaseCheckableProps\n extends BaseSelectableProps,\n InteractionProps {\n /**\n * The text label displayed next to the checkbox that describes what the checkbox controls.\n * Clicking the label will also toggle the checkbox state.\n */\n label?: string;\n /**\n * Whether the control is currently checked. Use this for controlled components where you manage the checked state.\n *\n * @default false\n */\n checked?: boolean;\n /**\n * The initial checked state for uncontrolled components. Use this when you want the control to start checked\n * but don't need to control its state afterward.\n *\n * @implementation `defaultChecked` reflects to the `checked` attribute.\n *\n * @default false\n */\n defaultChecked?: boolean;\n /**\n * The name used to identify this checkbox in form submissions.\n * When the checkbox is checked, its `name` and `value` are included in the form data.\n * Must be unique within the containing form.\n */\n name?: string;\n /**\n * A callback that is run whenever the control is changed. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n onChange?: (event: Event) => void;\n /**\n * A callback that is run whenever the control is changed. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).\n */\n onInput?: (event: Event) => void;\n}" + } + }, + "ChipProps$1": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChipProps$1", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "ComponentChildren", + "description": "The graphic to display inside of the chip.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface ChipProps$1 extends GlobalProps {\n /**\n * The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.\n */\n children?: ComponentChildren;\n /**\n * The graphic to display inside of the chip.\n *\n * @implementation Only `s-icon` is supported.\n */\n graphic?: ComponentChildren;\n /**\n * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.\n */\n accessibilityLabel?: string;\n /**\n * The color emphasis level that controls visual intensity.\n *\n * @default 'base'\n */\n color?: ColorKeyword;\n}" + } + }, + "AutocompleteProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AutocompleteProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "| AutocompleteField\n | `${AutocompleteSection} ${AutocompleteField}`\n | `${AutocompleteGroup} ${AutocompleteField}`\n | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`\n | 'on'\n | 'off'", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on' for everything else" + } + ], + "value": "export interface AutocompleteProps<\n AutocompleteField extends AnyAutocompleteField,\n> {\n /**\n * A hint about the intended content of the field for browser autofill.\n *\n * When set to `on` (the default), this property indicates that the field should support\n * autofill, but you do not have any more semantic information on the intended\n * contents.\n *\n * When set to `off`, you are indicating that this field contains sensitive\n * information, or contents that are never saved, like one-time codes.\n *\n * Alternatively, you can provide value which describes the\n * specific data you would like to be entered into this field during autofill.\n *\n * Learn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.\n *\n * @default 'tel' for PhoneField\n * @default 'email' for EmailField\n * @default 'url' for URLField\n * @default 'on' for everything else\n */\n autocomplete?:\n | AutocompleteField\n | `${AutocompleteSection} ${AutocompleteField}`\n | `${AutocompleteGroup} ${AutocompleteField}`\n | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`\n | 'on'\n | 'off';\n}" + } + }, + "AutocompleteSection": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteSection", + "value": "`section-${string}`", + "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page.", + "isPublicDocs": true + } + }, + "AutocompleteGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteGroup", + "value": "'shipping' | 'billing'", + "description": "The contact information group the autocomplete data should be sourced from.", + "isPublicDocs": true + } + }, + "AutocompleteAddressGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteAddressGroup", + "value": "'fax' | 'home' | 'mobile' | 'pager'", + "description": "The contact information subgroup the autocomplete data should be sourced from.", + "isPublicDocs": true + } + }, + "AnyAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyAutocompleteField", + "value": "'additional-name' | 'address-level1' | 'address-level2' | 'address-level3' | 'address-level4' | 'address-line1' | 'address-line2' | 'address-line3' | 'country-name' | 'country' | 'current-password' | 'email' | 'family-name' | 'given-name' | 'honorific-prefix' | 'honorific-suffix' | 'language' | 'name' | 'new-password' | 'nickname' | 'one-time-code' | 'organization-title' | 'organization' | 'photo' | 'postal-code' | 'sex' | 'street-address' | 'transaction-amount' | 'transaction-currency' | 'url' | 'username' | 'bday-day' | 'bday-month' | 'bday-year' | 'bday' | 'cc-additional-name' | 'cc-expiry-month' | 'cc-expiry-year' | 'cc-expiry' | 'cc-family-name' | 'cc-given-name' | 'cc-name' | 'cc-number' | 'cc-csc' | 'cc-type' | `${AutocompleteAddressGroup} email` | 'impp' | `${AutocompleteAddressGroup} impp` | 'tel' | 'tel-area-code' | 'tel-country-code' | 'tel-extension' | 'tel-local-prefix' | 'tel-local-suffix' | 'tel-local' | 'tel-national' | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`", + "description": "Represents all possible autocomplete field values as defined by the HTML autocomplete specification. These values help browsers provide appropriate autofill suggestions for form fields.\n\nLearn more about [autocomplete values](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete).", + "isPublicDocs": true + } + }, + "FunctionSettingsError": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionSettingsError", + "description": "Represents an error that occurs when saving function settings data.\n\nThese errors are returned when the extension-provided data fails validation or causes issues during the commit process to Shopify's servers. Handle these errors in the `onError` callback to provide feedback to users about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A unique identifier describing the “class” of error. These will match the GraphQL error codes as closely as possible. For example the enums returned by the `metafieldsSet` mutation.\n\nLearn more about [MetafieldsSetUserErrorCode](/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode)." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "'FunctionSettingsError'", + "description": "The error type name, always set to `FunctionSettingsError`.\n\nThis helps identify errors specific to function settings, distinguishing them from other error types." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "stack", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FunctionSettingsError extends Error {\n /**\n * A unique identifier describing the “class” of error. These will match\n * the GraphQL error codes as closely as possible. For example the enums\n * returned by the `metafieldsSet` mutation.\n *\n * Learn more about [MetafieldsSetUserErrorCode](/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode).\n */\n code: string;\n /**\n * The error type name, always set to `FunctionSettingsError`.\n *\n * This helps identify errors specific to function settings, distinguishing them from other error types.\n */\n name: 'FunctionSettingsError';\n}" + } + }, + "BaseTypographyProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseTypographyProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "'ltr' | 'rtl' | 'auto' | ''", + "description": "Indicates the directionality of the element’s text.\n\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n- `auto`: The user agent determines the direction based on the content.\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "fontVariantNumeric", + "value": "'auto' | 'normal' | 'tabular-nums'", + "description": "The rendering style for numbers in the font.\n\n- `auto`: Inherits the setting from the parent element.\n- `normal`: Uses the font's default numeric glyphs.\n- `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n\nLearn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `caution`: Advisory notices that need attention.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `accent`: Highlighted or promotional content.\n- `custom`: Custom styling controlled by your theme.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface BaseTypographyProps {\n /**\n * The color emphasis level that controls visual intensity.\n *\n * - `base`: Primary color for body text, standard UI elements, and general content with good readability.\n * - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n *\n * @default 'base'\n */\n color?: ColorKeyword;\n /**\n * The semantic meaning and color treatment of the component.\n *\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent.\n * - `info`: Informational content or helpful tips.\n * - `success`: Positive outcomes or successful states.\n * - `caution`: Advisory notices that need attention.\n * - `warning`: Important warnings about potential issues.\n * - `critical`: Urgent problems or destructive actions.\n * - `accent`: Highlighted or promotional content.\n * - `custom`: Custom styling controlled by your theme.\n *\n * @default 'auto'\n */\n tone?: ToneKeyword;\n /**\n * The rendering style for numbers in the font.\n *\n * - `auto`: Inherits the setting from the parent element.\n * - `normal`: Uses the font's default numeric glyphs.\n * - `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n *\n * Learn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).\n *\n * @default 'auto'\n */\n fontVariantNumeric?: 'auto' | 'normal' | 'tabular-nums';\n /**\n * The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n *\n * The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n *\n * It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.\n *\n * @default ''\n */\n lang?: string;\n /**\n * Indicates the directionality of the element’s text.\n *\n * - `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n * - `auto`: The user agent determines the direction based on the content.\n * - `ltr`: The languages written from left to right (such as English).\n * - `rtl`: The languages written from right to left (such as Arabic).\n *\n * Learn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).\n *\n * @default ''\n */\n dir?: 'ltr' | 'rtl' | 'auto' | '';\n}" + } + }, + "BlockTypographyProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BlockTypographyProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lineClamp", + "value": "number", + "description": "The maximum number of lines to display before truncating the text content.\n\nLearn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).", + "isOptional": true, + "defaultValue": "Infinity - no truncation is applied" + } + ], + "value": "export interface BlockTypographyProps {\n /**\n * The maximum number of lines to display before truncating the text content.\n *\n * Learn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).\n *\n * @default Infinity - no truncation is applied\n */\n lineClamp?: number;\n}" + } + }, + "BaseImageProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseImageProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true, + "defaultValue": "``" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes.\n\nLearn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. This overrides the `src` property.\n\nLearn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset).", + "isOptional": true + } + ], + "value": "export interface BaseImageProps {\n /**\n * Alternative text that describes the image for accessibility.\n *\n * Provides a text description of the image for users with assistive technology\n * and serves as a fallback when the image fails to load. A well-written description\n * enables people with visual impairments to understand non-text content.\n *\n * When a screen reader encounters an image, it reads this description aloud.\n * When an image fails to load, this text displays on screen, helping all users\n * understand what content was intended.\n *\n * Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4)\n * and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).\n *\n * @default ``\n */\n alt?: string;\n /**\n * A set of media conditions and their corresponding sizes.\n *\n * Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).\n */\n sizes?: string;\n /**\n * The image source (either a remote URL or a local file resource).\n *\n * When the image is loading or no `src` is provided, a placeholder is rendered.\n *\n * @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be\n * reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare.\n *\n * Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).\n */\n src?: string;\n /**\n * A set of image sources and their width or pixel density descriptors. This overrides the `src` property.\n *\n * Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset).\n */\n srcSet?: string;\n}" + } + }, + "MoneyAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MoneyAutocompleteField", + "value": "'transaction-amount'", + "description": "Represents autocomplete values that are valid for money/currency input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for monetary inputs.", + "isPublicDocs": true + } + }, + "ParagraphType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ParagraphType", + "value": "'paragraph' | 'small'", + "description": "", + "isPublicDocs": true + } + }, + "PaginationProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PaginationProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hasNextPage", + "value": "boolean", + "description": "Whether there's an additional page of data.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hasPreviousPage", + "value": "boolean", + "description": "Whether there's a previous page of data.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table. When `true`, the table might be in an inert state that prevents user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onNextPage", + "value": "(event: Event) => void", + "description": "A callback fired when the next page button is clicked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onPreviousPage", + "value": "(event: Event) => void", + "description": "A callback fired when the previous page button is clicked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paginate", + "value": "boolean", + "description": "Whether to use pagination controls.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PaginationProps {\n /**\n * Whether to use pagination controls.\n *\n * @default false\n */\n paginate?: boolean;\n /**\n * A callback fired when the previous page button is clicked.\n */\n onPreviousPage?: (event: Event) => void;\n /**\n * A callback fired when the next page button is clicked.\n */\n onNextPage?: (event: Event) => void;\n /**\n * Whether there's an additional page of data.\n *\n * @default false\n */\n hasNextPage?: boolean;\n /**\n * Whether there's a previous page of data.\n *\n * @default false\n */\n hasPreviousPage?: boolean;\n /**\n * Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table.\n * When `true`, the table might be in an inert state that prevents user interaction.\n *\n * @default false\n */\n loading?: boolean;\n}" + } + }, + "TextType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextType", + "value": "'address' | 'redundant' | 'mark' | 'emphasis' | 'offset' | 'strong' | 'small' | 'generic'", + "description": "Defines the semantic type and styling treatment for text content. Each type maps to appropriate HTML elements and applies specific styling for different contexts.", + "isPublicDocs": true + } + }, + "URLAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "URLAutocompleteField", + "value": "'url' | 'photo' | 'impp' | 'home impp' | 'mobile impp' | 'fax impp' | 'pager impp'", + "description": "Represents autocomplete values that are valid for URL input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for URL inputs.\n\nAvailable values:\n- `url` - General URL or web address\n- `photo` - URL to a photo or image\n- `impp` - Instant messaging protocol URL\n- `home impp` - Home instant messaging protocol URL\n- `mobile impp` - Mobile instant messaging protocol URL\n- `fax impp` - Fax instant messaging protocol URL\n- `pager impp` - Pager instant messaging protocol URL", + "isPublicDocs": true + } + }, + "Key": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Key", + "value": "string | number | any", + "description": "Represents a unique key for identifying elements in lists. Can be a string, number, or any other value.", + "isPublicDocs": true + } + }, + "RefCallback": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "RefCallback", + "description": "Represents a callback function that receives a reference to a DOM element or component instance. Called when the element is mounted or unmounted.", + "isPublicDocs": true, + "params": [ + { + "name": "instance", + "description": "", + "value": "T", + "filePath": "src/surfaces/admin/components.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/components.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(instance: T | null) => void" + } + }, + "Ref": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Ref", + "value": "RefObject | RefCallback | null", + "description": "Represents a reference to a DOM element or component instance. Can be either a ref object, callback function, or null.", + "isPublicDocs": true + } + }, + "RefObject": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "RefObject", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "current", + "value": "T | null", + "description": "The current value of the ref, which holds a reference to the DOM element or component instance. Will be `null` if the element is not yet mounted or has been unmounted." + } + ], + "value": "export interface RefObject {\n /**\n * The current value of the ref, which holds a reference to the DOM element or component instance.\n * Will be `null` if the element is not yet mounted or has been unmounted.\n */\n current: T | null;\n}" + } + }, + "ComponentChild": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentChild", + "value": "VNode | object | string | number | bigint | boolean | null | undefined", + "description": "Represents a single child element that can be rendered, including VNodes, primitives, or null/undefined values.", + "isPublicDocs": true + } + }, + "VNode": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "VNode", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "endTime", + "value": "number", + "description": "The time that the rendering of this `vnode` was completed. Will only be set when the devtools are attached. Default value: `-1`", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "Key", + "description": "A unique key used to identify this element in lists for efficient reconciliation." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "props", + "value": "P & { children: ComponentChildren$1; }", + "description": "The properties passed to this component or element, including children." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "Ref | null", + "description": "A ref to the element, which is not guaranteed by React.ReactElement. For compatibility reasons with popular react libs we define it as optional too.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "startTime", + "value": "number", + "description": "The time this `vnode` started rendering. Will only be set when the devtools are attached. Default value: `0`", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "ComponentType

| string", + "description": "The component type or HTML element tag name that this VNode represents." + } + ], + "value": "export interface VNode

{\n /**\n * The component type or HTML element tag name that this VNode represents.\n */\n type: ComponentType

| string;\n /**\n * The properties passed to this component or element, including children.\n */\n props: P & {\n children: ComponentChildren$1;\n };\n /**\n * A unique key used to identify this element in lists for efficient reconciliation.\n */\n key: Key;\n /**\n * A ref to the element, which is not guaranteed by React.ReactElement. For compatibility reasons with popular react libs we define it as optional too.\n */\n ref?: Ref | null;\n /**\n * The time this `vnode` started rendering. Will only be set when\n * the devtools are attached.\n * Default value: `0`\n */\n startTime?: number;\n /**\n * The time that the rendering of this `vnode` was completed. Will only be\n * set when the devtools are attached.\n * Default value: `-1`\n */\n endTime?: number;\n}" + } + }, + "ComponentType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentType", + "value": "ComponentClass

| FunctionComponent

", + "description": "Represents any valid component type, either a class component or a function component.", + "isPublicDocs": true + } + }, + "ComponentClass": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ComponentClass", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "contextType", + "value": "Context", + "description": "The context type this component can consume. When set, the component will have access to this context's value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

", + "description": "The default values for props that will be used when props are not explicitly provided to component instances.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component class, used in debugging and dev tools.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "getDerivedStateFromError", + "value": "(error: any) => Partial", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "getDerivedStateFromProps", + "value": "(props: Readonly

, state: Readonly) => Partial", + "description": "", + "isOptional": true + } + ], + "value": "export interface ComponentClass

{\n new (props: P, context?: any): Component;\n /**\n * A human-readable name for this component class, used in debugging and dev tools.\n */\n displayName?: string;\n /**\n * The default values for props that will be used when props are not explicitly provided to component instances.\n */\n defaultProps?: Partial

;\n /**\n * The context type this component can consume. When set, the component will have access to this context's value.\n */\n contextType?: Context;\n getDerivedStateFromProps?(\n props: Readonly

,\n state: Readonly,\n ): Partial | null;\n getDerivedStateFromError?(error: any): Partial | null;\n}" + } + }, + "Context": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Context", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "Consumer", + "value": "Consumer", + "description": "A component that consumes the context value and re-renders when it changes." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "T", + "description": "The default value for this context, used when no Provider is found in the component tree." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this context, used in debugging and dev tools.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "Provider", + "value": "Provider", + "description": "A component that provides the context value to its descendants." + } + ], + "value": "export interface Context {\n /**\n * The default value for this context, used when no Provider is found in the component tree.\n */\n readonly defaultValue: T;\n}" + } + }, + "Consumer": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Consumer", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component, used in debugging and dev tools.", + "isOptional": true + } + ], + "value": "export interface Consumer\n extends FunctionComponent<{\n /**\n * A render function that receives the current context value and returns elements to render.\n * This function is called whenever the context value changes, allowing components to re-render with the updated value.\n */\n children: (value: T) => ComponentChildren$1;\n }> {}" + } + }, + "Provider": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Provider", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component, used in debugging and dev tools.", + "isOptional": true + } + ], + "value": "export interface Provider\n extends FunctionComponent<{\n /**\n * The context value to provide to consuming components.\n */\n value: T;\n /**\n * The child components that will have access to this context value.\n */\n children?: ComponentChildren$1;\n }> {}" + } + }, + "FunctionComponent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionComponent", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component, used in debugging and dev tools.", + "isOptional": true + } + ], + "value": "export interface FunctionComponent

{\n (props: RenderableProps

, context?: any): ComponentChildren$1;\n /**\n * A human-readable name for this component, used in debugging and dev tools.\n */\n displayName?: string;\n /**\n * The default values for props that will be used when props are not explicitly provided.\n */\n defaultProps?: Partial

| undefined;\n}" + } + }, + "ErrorInfo": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ErrorInfo", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "componentStack", + "value": "string", + "description": "A string representation of the component stack trace at the point where an error occurred. Useful for debugging to understand which components were rendering when the error happened.", + "isOptional": true + } + ], + "value": "export interface ErrorInfo {\n /**\n * A string representation of the component stack trace at the point where an error occurred.\n * Useful for debugging to understand which components were rendering when the error happened.\n */\n componentStack?: string;\n}" + } + }, + "RenderableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RenderableProps", + "value": "P & Readonly<\n Attributes & {\n /**\n * The child elements to be rendered within this component.\n */\n children?: ComponentChildren$1;\n /**\n * A reference to the DOM element or component instance, allowing direct access to the underlying element.\n */\n ref?: Ref;\n }\n >", + "description": "Represents the props that can be rendered by a component, combining custom props with standard attributes like children and ref.", + "isPublicDocs": true + } + }, + "Attributes": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Attributes", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "jsx", + "value": "boolean | undefined", + "description": "An internal flag indicating whether this element was created using JSX syntax.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "Key | undefined", + "description": "A unique key used to identify this element in lists for efficient reconciliation during re-renders.", + "isOptional": true + } + ], + "value": "export interface Attributes {\n /**\n * A unique key used to identify this element in lists for efficient reconciliation during re-renders.\n */\n key?: Key | undefined;\n /**\n * An internal flag indicating whether this element was created using JSX syntax.\n */\n jsx?: boolean | undefined;\n}" + } + }, + "Component": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Component", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "state", + "value": "Readonly", + "description": "The current state of the component." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "props", + "value": "RenderableProps", + "description": "The props passed to this component." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "context", + "value": "any", + "description": "The context value this component can access if a contextType is specified." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "base", + "value": "Element | Text", + "description": "The underlying DOM element or text node that this component rendered." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setState", + "value": "(state: Partial | ((prevState: Readonly, props: Readonly

) => Partial | Pick) | Pick, callback?: () => void) => void", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "forceUpdate", + "value": "(callback?: () => void) => void", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "render", + "value": "(props?: RenderableProps, state?: Readonly, context?: any) => ComponentChildren$1", + "description": "" + } + ], + "value": "declare abstract class Component {\n constructor(props?: P, context?: any);\n static displayName?: string;\n static defaultProps?: any;\n static contextType?: Context;\n // Static members cannot reference class type parameters. This is not\n // supported in TypeScript. Reusing the same type arguments from `Component`\n // will lead to an impossible state where one cannot satisfy the type\n // constraint under no circumstances, see #1356.In general type arguments\n // seem to be a bit buggy and not supported well at the time of this\n // writing with TS 3.3.3333.\n static getDerivedStateFromProps?(\n props: Readonly,\n state: Readonly,\n ): object | null;\n\n static getDerivedStateFromError?(error: any): object | null;\n /**\n * The current state of the component.\n */\n state: Readonly;\n /**\n * The props passed to this component.\n */\n props: RenderableProps

;\n /**\n * The context value this component can access if a contextType is specified.\n */\n context: any;\n /**\n * The underlying DOM element or text node that this component rendered.\n */\n base?: Element | Text;\n // From https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e836acc75a78cf0655b5dfdbe81d69fdd4d8a252/types/react/index.d.ts#L402\n // // We MUST keep setState() as a unified signature because it allows proper checking of the method return type.\n // // See: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/18365#issuecomment-351013257\n setState(\n state:\n | ((\n prevState: Readonly,\n props: Readonly

,\n ) => Pick | Partial | null)\n | (Pick | Partial | null),\n callback?: () => void,\n ): void;\n\n forceUpdate(callback?: () => void): void;\n abstract render(\n props?: RenderableProps

,\n state?: Readonly,\n context?: any,\n ): ComponentChildren$1;\n}" + } + }, + "Styles": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Styles", + "value": "string", + "description": "Represents CSS styles as a string, typically used for inline styles or style injection.", + "isPublicDocs": true + } + }, + "RenderImpl": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RenderImpl", + "value": "Omit & {\n ShadowRoot: (element: any) => ComponentChildren;\n styles?: Styles;\n}", + "description": "Represents the implementation details for rendering components within a shadow DOM. Extends `ShadowRootInit` with a render function and optional styles.", + "isPublicDocs": true + } + }, + "CallbackEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackEvent", + "value": "Event & {\n currentTarget: HTMLElementTagNameMap[T];\n}", + "description": "An event object with a strongly-typed `currentTarget` property that references the specific HTML element that triggered the event.\n\nThis type extends the standard DOM `Event` interface and ensures type safety when accessing the element that fired the event.", + "isPublicDocs": true + } + }, + "CallbackToggleEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackToggleEvent", + "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", + "description": "A toggle event with a strongly-typed `currentTarget` property. Extends the `ToggleEvent` interface with type-safe access to the element that triggered the toggle.", + "isPublicDocs": true + } + }, + "CallbackEventListener": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackEventListener", + "value": "(EventListener & {\n (event: CallbackEvent): void;\n }) | null", + "description": "A function that handles events from UI components.\n\nThis type represents an event listener callback that receives a `CallbackEvent` with a strongly-typed `currentTarget`. Use this for component event handlers like `click`, `focus`, `blur`, and other DOM events.", + "isPublicDocs": true + } + }, + "CallbackErrorEventListener": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackErrorEventListener", + "value": "(EventListener & {\n (\n event: CallbackEvent & {\n error: TError;\n },\n ): void;\n }) | null", + "description": "A function that handles error events from UI components. This type represents an event listener callback that receives both the event and an error object.", + "isPublicDocs": true + } + }, + "CallbackExtendableEventListener": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackExtendableEventListener", + "value": "(EventListener & {\n (event: CallbackExtendableEvent): void;\n }) | null", + "description": "A function that handles extendable events from UI components. This type represents an event listener callback that can use `waitUntil` to extend the event lifetime.", + "isPublicDocs": true + } + }, + "CallbackExtendableEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "CallbackExtendableEvent", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "waitUntil", + "value": "(promise: Promise) => void", + "description": "A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.\n\nCan be called multiple times to add promises to the event, but must be called synchronously during event dispatch. Cannot be called after a `setTimeout` or within a microtask.", + "isOptional": true + } + ], + "value": "export interface CallbackExtendableEvent<\n TTagName extends keyof HTMLElementTagNameMap,\n> extends CallbackEvent,\n Pick {}" + } + }, + "PreactBaseElementProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PreactBaseElementProps", + "description": "Base props for Preact custom elements without children support. Includes common properties like key, ref, and slot for elements that don't accept child content.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "preact.Key", + "description": "A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists. Essential for maintaining component state and optimizing re-renders when lists change.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "preact.Ref", + "description": "A reference to access the underlying DOM element directly. Typically created using `useRef()` to interact with the element imperatively or measure its properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "Lowercase", + "description": "The named slot to which this element is assigned in the parent component's shadow DOM.\n\nUsed for advanced component composition with web components.", + "isOptional": true + } + ], + "value": "export interface PreactBaseElementProps {\n /**\n * A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.\n * Essential for maintaining component state and optimizing re-renders when lists change.\n */\n key?: preact.Key;\n /**\n * A reference to access the underlying DOM element directly.\n * Typically created using `useRef()` to interact with the element imperatively or measure its properties.\n */\n ref?: preact.Ref;\n /**\n * The named slot to which this element is assigned in the parent component's shadow DOM.\n *\n * Used for advanced component composition with web components.\n */\n slot?: Lowercase;\n}" + } + }, + "PreactBaseElementPropsWithChildren": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PreactBaseElementPropsWithChildren", + "description": "Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "preact.ComponentChildren", + "description": "The child elements to be rendered within this component.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "preact.Key", + "description": "A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists. Essential for maintaining component state and optimizing re-renders when lists change.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "preact.Ref", + "description": "A reference to access the underlying DOM element directly. Typically created using `useRef()` to interact with the element imperatively or measure its properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "Lowercase", + "description": "The named slot to which this element is assigned in the parent component's shadow DOM.\n\nUsed for advanced component composition with web components.", + "isOptional": true + } + ], + "value": "export interface PreactBaseElementPropsWithChildren\n extends PreactBaseElementProps {\n /**\n * The child elements to be rendered within this component.\n */\n children?: preact.ComponentChildren;\n}" + } + }, + "RequiredBannerProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredBannerProps", + "value": "Required", + "description": "Represents the banner component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The main message content displayed within the banner, providing important information or guidance to users.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "collapsible", + "value": "boolean", + "description": "Whether the banner content can be collapsed. When true, child elements are initially hidden but can be revealed by the user expanding the banner.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "dismissible", + "value": "boolean", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event fires, then `hidden` is set to `true`, any animation completes, and the `afterhide` event fires.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the banner.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property will be `true` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "(event: Event) => void", + "description": "A callback fired when the banner is dismissed by the user clicking the close button. Does not fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "MakeResponsive": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MakeResponsive", + "value": "T | `@container${string}`", + "description": "Makes a type responsive by allowing it to be either the base value or a container query string. This enables conditional styling based on container dimensions.", + "isPublicDocs": true + } + }, + "MakeResponsivePick": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MakeResponsivePick", + "value": "{\n [P in TProperty]: MakeResponsive;\n}", + "description": "Makes a property's value potentially responsive.", + "isPublicDocs": true + } + }, + "RequiredBoxProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredBoxProps", + "value": "Required", + "description": "Represents the box component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ResponsiveBoxProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResponsiveBoxProps", + "value": "MakeResponsivePick<\n RequiredBoxProps,\n | 'padding'\n | 'paddingBlock'\n | 'paddingBlockStart'\n | 'paddingBlockEnd'\n | 'paddingInline'\n | 'paddingInlineStart'\n | 'paddingInlineEnd'\n | 'display'\n>", + "description": "Represents box props with responsive capabilities for layout properties.\n\nThis enables conditional styling based on container queries.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ButtonOnlyProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ButtonOnlyProps", + "value": "", + "description": "Represents button props that are specific to button-type elements only. Extracts the subset of `ButtonProps` that includes the `type` property.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The label text or elements displayed inside the button component, describing the action that will be performed when clicked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconType | AnyString", + "description": "An icon displayed inside the button, typically positioned before the button text. Use icons to help users quickly identify the button's action or to improve scannability. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The displayed inline width of the button.\n\n- `auto`: the size of the button depends on the surface and context.\n- `fill`: the button will takes up 100% of the available inline size.\n- `fit-content`: the button will take up the minimum inline-size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary' | 'tertiary'", + "description": "The visual appearance of the button component.\n\n- `auto`: The variant is automatically determined by the button component's context.\n- `primary`: High emphasis button for the primary action on the page. Should be used sparingly.\n- `secondary`: Medium emphasis button for secondary actions.\n- `tertiary`: Low emphasis button for less important actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "ButtonBaseProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ButtonBaseProps", + "value": "Required<\n Pick<\n ButtonOnlyProps,\n | 'accessibilityLabel'\n | 'disabled'\n | 'command'\n | 'commandFor'\n | 'icon'\n | 'interestFor'\n | 'lang'\n | 'loading'\n | 'type'\n | 'tone'\n | 'variant'\n | 'target'\n | 'href'\n | 'download'\n >\n>", + "description": "Represents the base button props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconType | AnyString", + "description": "An icon displayed inside the button, typically positioned before the button text. Use icons to help users quickly identify the button's action or to improve scannability. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary' | 'tertiary'", + "description": "The visual appearance of the button component.\n\n- `auto`: The variant is automatically determined by the button component's context.\n- `primary`: High emphasis button for the primary action on the page. Should be used sparingly.\n- `secondary`: Medium emphasis button for secondary actions.\n- `tertiary`: Low emphasis button for less important actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "PreactInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PreactInputProps", + "value": "Required<\n Pick\n>", + "description": "Represents the essential input props required for Preact-based input elements. Includes properties like `disabled`, `id`, `name`, and `value`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ] + } + }, + "ClickableBaseProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ClickableBaseProps", + "value": "Required<\n Pick<\n ClickableProps$1,\n | 'command'\n | 'commandFor'\n | 'interestFor'\n | 'disabled'\n | 'download'\n | 'href'\n | 'lang'\n | 'loading'\n | 'overflow'\n | 'target'\n | 'type'\n >\n>", + "description": "Represents the base clickable props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the component is disabled, preventing clicks and focus. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You shouldapply disabled styling as needed.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content.\n\nUse this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the component is in a loading state, which indicates to assistive technology that an action is in progress and prevents interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ] + } + }, + "PreactFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PreactFieldProps", + "value": "PreactInputProps & Required<\n Pick<\n TextFieldProps$1,\n | 'defaultValue'\n | 'details'\n | 'error'\n | 'label'\n | 'labelAccessibilityVisibility'\n | 'placeholder'\n | 'readOnly'\n | 'required'\n >\n > & {\n /**\n * Controls browser autofill behavior for the field.\n *\n * Basic values:\n * - `on` - Enables autofill without specifying content type (default)\n * - `off` - Disables autofill for sensitive data or one-time codes\n *\n * Specific field values describe the expected data type. You can optionally prefix these with:\n * - `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n * - `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n * - Both section and group (for example, `section-primary shipping email`)\n *\n * Providing a specific autofill token helps browsers suggest more relevant saved data.\n *\n * Learn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.\n *\n * @default 'tel' for PhoneField\n * @default 'email' for EmailField\n * @default 'url' for URLField\n * @default 'on' for everything else\n */\n autocomplete: Autocomplete;\n }", + "description": "Represents the props for Preact-based form field components with autocomplete support. The generic type parameter allows specifying the valid autocomplete values for the field.", + "isPublicDocs": true + } + }, + "TextFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextFieldProps", + "value": "PreactFieldProps<\n /** @default 'on' */\n Required['autocomplete']\n> & Required<\n Pick<\n TextFieldProps$1,\n 'icon' | 'maxLength' | 'minLength' | 'prefix' | 'suffix'\n >\n >", + "description": "Represents the props for text input field components. Extends `PreactFieldProps` with autocomplete support for text-related fields.", + "isPublicDocs": true + } + }, + "ColorFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColorFieldProps", + "value": "Omit<\n PreactFieldProps['autocomplete']>,\n 'value' | 'defaultValue'\n> & Required>", + "description": "Represents the props for color input field components. Extends `PreactFieldProps` with autocomplete support for color-related fields.", + "isPublicDocs": true + } + }, + "ReplaceType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReplaceType", + "value": "Exclude | TTo", + "description": "A utility type that replaces occurrences of one type with another within a union type. Useful for type transformations where you need to swap out specific types.", + "isPublicDocs": true + } + }, + "EmailFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "EmailFieldProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required>", + "description": "Represents the props for email input field components. Extends `PreactFieldProps` with autocomplete support for email-related fields.", + "isPublicDocs": true + } + }, + "RequiredAlignedProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredAlignedProps", + "value": "Required", + "description": "Represents the grid component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive", + "description": "The vertical alignment of the entire grid within its container (in horizontal layouts).\n\nUse this to distribute grid rows along the block axis (vertical in left-to-right/right-to-left layouts, horizontal in vertical writing modes). This property overrides the block value set by `placeContent`.\n\nLearn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive", + "description": "The vertical alignment of grid items within their grid areas (in horizontal layouts).\n\nUse this to position items along the block axis (vertical in left-to-right/right-to-left layouts, horizontal in vertical writing modes). This property overrides the block value set by `placeItems`.\n\nLearn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateColumns", + "value": "MaybeResponsive", + "description": "The columns in the grid and their sizes.\n\nUse values like `1fr 2fr` to create fluid columns, `200px 1fr` to mix fixed and flexible columns, or `repeat(3, 1fr)` to create equal-width columns.\n\nLearn more about the [grid-template-columns property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateRows", + "value": "MaybeResponsive", + "description": "The rows in the grid and their sizes.\n\nUse values like `100px auto` to create rows with fixed and automatic heights, or `repeat(3, 100px)` to create equal-height rows.\n\nLearn more about the [grid-template-rows property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive", + "description": "The horizontal alignment of the entire grid within its container (in horizontal layouts).\n\nUse this to distribute grid columns along the inline axis (horizontal in left-to-right/right-to-left layouts, vertical in vertical writing modes). This property overrides the inline value set by `placeContent`.\n\nLearn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "justifyItems", + "value": "MaybeResponsive", + "description": "The horizontal alignment of grid items within their grid areas (in horizontal layouts).\n\nUse this to position items along the inline axis (horizontal in left-to-right/right-to-left layouts, vertical in vertical writing modes). This property overrides the inline value set by `placeItems`.\n\nLearn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeContent", + "value": "MaybeResponsive<\n `${AlignContentKeyword} ${JustifyContentKeyword}` | AlignContentKeyword\n >", + "description": "A shorthand property for `justify-content` and `align-content`.\n\nLearn more about the [place-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-content).", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeItems", + "value": "MaybeResponsive<\n `${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword\n >", + "description": "A shorthand for setting both `justify-items` and `align-items` in a single declaration.\n\nAccepts either a single value (applied to both axes) or two space-separated values (align-items justify-items).\n\nLearn more about the [place-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-items).", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ResponsiveGridProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResponsiveGridProps", + "value": "MakeResponsivePick<\n RequiredAlignedProps,\n 'rowGap' | 'columnGap' | 'gap' | 'gridTemplateColumns' | 'gridTemplateRows'\n>", + "description": "Represents grid props with responsive capabilities for layout properties.\n\nThis enables conditional styling based on container queries.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateColumns", + "value": "MaybeResponsive", + "description": "The columns in the grid and their sizes.\n\nUse values like `1fr 2fr` to create fluid columns, `200px 1fr` to mix fixed and flexible columns, or `repeat(3, 1fr)` to create equal-width columns.\n\nLearn more about the [grid-template-columns property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateRows", + "value": "MaybeResponsive", + "description": "The rows in the grid and their sizes.\n\nUse values like `100px auto` to create rows with fixed and automatic heights, or `repeat(3, 100px)` to create equal-height rows.\n\nLearn more about the [grid-template-rows property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "RequiredGridItemProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredGridItemProps", + "value": "Required", + "description": "Represents the grid item component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridColumn", + "value": "`span ${number}` | 'auto'", + "description": "The number of columns the item will span across.\n\nLearn more about the [grid-column property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridRow", + "value": "`span ${number}` | 'auto'", + "description": "The number of rows the item will span across.\n\nLearn more about the [grid-row property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "RequiredLinkProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredLinkProps", + "value": "Required", + "description": "Represents the link component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The text or elements displayed within the link component, which navigates users to a different location when activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "LinkBaseProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "LinkBaseProps", + "value": "Required<\n Pick<\n LinkProps$1,\n | 'accessibilityLabel'\n | 'command'\n | 'commandFor'\n | 'interestFor'\n | 'download'\n | 'href'\n | 'lang'\n | 'target'\n | 'tone'\n >\n>", + "description": "Represents the base link props with all core properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "PolyfillCommandEventInit": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PolyfillCommandEventInit", + "value": "EventInit & {\n source: HTMLElement | null | undefined;\n command: PreactOverlayControlProps['command'];\n}", + "description": "Represents the initialization object for creating a polyfill command event. Used for overlay control commands in environments that require polyfills.", + "isPublicDocs": true + } + }, + "PreactOverlayControlProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PreactOverlayControlProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information." + } + ], + "value": "export interface PreactOverlayControlProps\n extends Pick {\n /**\n * The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the visibility of the target component.\n *\n * @default '--auto'\n */\n command: Extract<\n InteractionProps['command'],\n '--show' | '--hide' | '--toggle' | '--auto'\n >;\n /**\n * The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.\n */\n commandFor: Extract;\n /**\n * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.\n */\n interestFor: Extract;\n}" + } + }, + "PolyfillCommandEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PolyfillCommandEvent", + "value": "Event & {\n source: PolyfillCommandEventInit['source'];\n command: PolyfillCommandEventInit['command'];\n /** Have to use `_s_shadowSource` because `source` is retargeted to the shadow host by browsers */\n _s_shadowSource: PolyfillCommandEventInit['source'];\n}", + "description": "Represents a polyfill command event for overlay controls. Used in environments where native command events are not available.", + "isPublicDocs": true + } + }, + "RequiredAlignedModalProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredAlignedModalProps", + "value": "Required", + "description": "Represents the modal component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.\n\nThis overrides the `heading` prop for screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterShow", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "Adjust the padding around the modal content.\n\n`base`: applies padding that is appropriate for the element.\n\n`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.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "showOverlay", + "value": "() => void", + "description": "A method to programmatically show the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "SizeKeyword | 'max'", + "description": "Adjust the size of the modal.\n\n`max`: expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "toggleOverlay", + "value": "() => void", + "description": "A method to programmatically toggle the visibility of the overlay." + } + ] + } + }, + "ContextCallback": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ContextCallback", + "description": "A callback which is provided by a context requester and is called with the value satisfying the request. This callback can be called multiple times by context providers as the requested value is changed.", + "isPublicDocs": true, + "params": [ + { + "name": "value", + "description": "", + "value": "T", + "filePath": "src/surfaces/admin/components.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/components.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(value: T) => void" + } + }, + "RequiredMoneyFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredMoneyFieldProps", + "value": "Required", + "description": "Represents the money field component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "| AutocompleteField\n | `${AutocompleteSection} ${AutocompleteField}`\n | `${AutocompleteGroup} ${AutocompleteField}`\n | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`\n | 'on'\n | 'off'", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on' for everything else" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "controls", + "value": "'auto' | 'stepper' | 'none'", + "description": "The type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ] + } + }, + "PasswordFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PasswordFieldProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required<\n Pick<\n PasswordFieldProps$1,\n | 'defaultValue'\n | 'details'\n | 'disabled'\n | 'error'\n | 'labelAccessibilityVisibility'\n | 'minLength'\n | 'maxLength'\n | 'label'\n | 'name'\n | 'placeholder'\n | 'readOnly'\n | 'required'\n | 'value'\n >\n >", + "description": "Represents the props for password input field components. Extends `PreactFieldProps` with autocomplete support for password-related fields.", + "isPublicDocs": true + } + }, + "Popover": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Popover", + "description": "Configure the following properties on the popover component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Popover\n extends PreactPopoverElement\n implements PopoverProps\n{\n constructor();\n}" + } + }, + "SearchFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SearchFieldProps", + "value": "PreactFieldProps<\n /**\n * @default 'on'\n */\n Required['autocomplete']\n> & Required<\n Pick<\n TextFieldProps$1,\n | 'defaultValue'\n | 'details'\n | 'disabled'\n | 'error'\n | 'labelAccessibilityVisibility'\n | 'minLength'\n | 'maxLength'\n | 'label'\n | 'name'\n | 'placeholder'\n | 'readOnly'\n | 'required'\n | 'value'\n >\n >", + "description": "Represents the props for search input field components. Extends `PreactFieldProps` for search-specific functionality.", + "isPublicDocs": true + } + }, + "RequiredSectionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredSectionProps", + "value": "Required", + "description": "Represents the section component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "The padding applied to all edges of the element.\n\n- `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context.\n- `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.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + } + ] + } + }, + "AlignedStackProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AlignedStackProps", + "value": "Required", + "description": "Represents the stack component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive", + "description": "The alignment of multiple lines of content along the stack component's cross axis.\n\nThis only applies when content wraps to multiple lines (typically in inline direction).\n\nLearn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive", + "description": "The alignment of individual children along the stack component's cross axis (perpendicular to the stacking direction).\n\nFor example, in a vertical stack (block direction), this controls horizontal alignment of each child.\n\nLearn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "MaybeResponsive<'block' | 'inline'>", + "description": "The direction in which children are arranged within the stack.\n\n- `block`: Arranges children vertically in a column (in horizontal writing modes). Children will not wrap.\n- `inline`: Arranges children horizontally in a row (in horizontal writing modes). Children will wrap to the next line if needed.\n\nThis uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values) to ensure proper behavior across different writing modes.", + "isOptional": true, + "defaultValue": "'block'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive", + "description": "The distribution of children along the stack component's main axis (the direction of stacking).\n\nFor example, in a vertical stack (block direction), this controls vertical distribution. Use this to space out children or align them to the start, center, or end.\n\nLearn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ResponsiveStackProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResponsiveStackProps", + "value": "MakeResponsivePick<\n AlignedStackProps,\n 'gap' | 'rowGap' | 'columnGap' | 'direction'\n>", + "description": "Represents stack props with responsive capabilities for layout properties.\n\nThis enables conditional styling based on container queries.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "MaybeResponsive<'block' | 'inline'>", + "description": "The direction in which children are arranged within the stack.\n\n- `block`: Arranges children vertically in a column (in horizontal writing modes). Children will not wrap.\n- `inline`: Arranges children horizontally in a row (in horizontal writing modes). Children will wrap to the next line if needed.\n\nThis uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values) to ensure proper behavior across different writing modes.", + "isOptional": true, + "defaultValue": "'block'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "TextAreaProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextAreaProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required>", + "description": "Represents the props for textarea components. Extends `PreactFieldProps` for multi-line text input functionality.", + "isPublicDocs": true + } + }, + "URLFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "URLFieldProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required>", + "description": "Represents the props for URL input field components. Extends `PreactFieldProps` with autocomplete support for URL-related fields.", + "isPublicDocs": true + } + }, + "AdminActionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminActionProps", + "description": "Configure the following properties on the admin action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The text to use as the action modal's title. If not provided, the name of the extension will be used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the action is in a loading state, such as during initial page load or when the action is being opened. When `true`, the action is in an inert state that prevents user interaction.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface AdminActionProps\n extends Pick {}" + } + }, + "AdminBlockProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminBlockProps", + "description": "Configure the following properties on the admin block component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "collapsedSummary", + "value": "string", + "description": "The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The text displayed as the block's title in the header. If not provided, the extension name will be used.", + "isOptional": true + } + ], + "value": "export interface AdminBlockProps\n extends Pick {}" + } + }, + "AdminPrintActionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminPrintActionProps", + "description": "Configure the following properties on the admin print action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The URL of the document to preview and print. Supports HTML, PDF, and image formats. If not provided, the preview will show an empty state and the print button will be disabled.", + "isOptional": true + } + ], + "value": "export interface AdminPrintActionProps\n extends Pick {}" + } + }, + "FunctionSettingsErrorEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "FunctionSettingsErrorEvent", + "value": "AggregateErrorEvent", + "description": "Represents the event type for function settings errors. Extracted from the parameters of the `onFunctionSettingsError` callback.", + "isPublicDocs": true + } + }, + "AvatarEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AvatarEvents", + "description": "The avatar component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "OnErrorEventHandler", + "description": "A callback fired when the avatar image fails to load.\n\nLearn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "load", + "value": "CallbackEventListener | null", + "description": "A callback fired when the avatar image successfully loads.\n\nLearn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).", + "isOptional": true + } + ], + "value": "export interface AvatarEvents {\n /**\n * A callback fired when the avatar image successfully loads.\n *\n * Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).\n */\n load: CallbackEventListener | null = null;\n /**\n * A callback fired when the avatar image fails to load.\n *\n * Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).\n */\n error: OnErrorEventHandler = null;\n}" + } + }, + "BadgeSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BadgeSlots", + "description": "The badge component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text label displayed within the badge component, typically a short status indicator or category label.", + "isOptional": true + } + ], + "value": "export interface BadgeSlots {\n /**\n * The text label displayed within the badge component, typically a short status indicator or category label.\n */\n children?: HTMLElement;\n}" + } + }, + "BannerEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BannerEvents", + "description": "The banner component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the banner is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "dismiss", + "value": "CallbackEventListener | null", + "description": "A callback fired when the banner is dismissed.", + "isOptional": true + } + ], + "value": "export interface BannerEvents {\n /**\n * A callback fired when the banner is dismissed.\n */\n dismiss: CallbackEventListener | null = null;\n /**\n * A callback fired after the banner is hidden.\n */\n afterhide: CallbackEventListener | null = null;\n}" + } + }, + "BannerSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BannerSlots", + "description": "The banner component supports slots for additional content placement within the banner. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The main message content displayed within the banner component, providing important information or guidance to users.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Action buttons displayed at the bottom of the banner that let users respond to the message. Accepts up to two button components with `variant=\"secondary\"` or `variant=\"auto\"`.", + "isOptional": true + } + ], + "value": "export interface BannerSlots {\n /**\n * The main message content displayed within the banner component, providing important information or guidance to users.\n */\n children?: HTMLElement;\n /**\n * Action buttons displayed at the bottom of the banner that let users respond to the message.\n * Accepts up to two button components with `variant=\"secondary\"` or `variant=\"auto\"`.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "BoxSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BoxSlots", + "description": "The box component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + } + ], + "value": "export interface BoxSlots {\n /**\n * The content displayed within the box component, which serves as a flexible container for organizing and styling other components.\n */\n children?: HTMLElement;\n}" + } + }, + "ButtonEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonEvents", + "description": "The button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener | null", + "description": "A callback fired when the button loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the button is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener | null", + "description": "A callback fired when the button receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface ButtonEvents {\n /**\n * A callback fired when the button is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n /**\n * A callback fired when the button loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener | null = null;\n /**\n * A callback fired when the button receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener | null = null;\n}" + } + }, + "ButtonSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonSlots", + "description": "The button component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The label text or elements displayed inside the button component, describing the action that will be performed when clicked.", + "isOptional": true + } + ], + "value": "export interface ButtonSlots {\n /**\n * The label text or elements displayed inside the button component, describing the action that will be performed when clicked.\n */\n children?: HTMLElement;\n}" + } + }, + "ButtonGroupSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonGroupSlots", + "description": "The button group component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The buttons displayed within the button group component, which are arranged together as a cohesive set of related actions.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action for this group, displayed with high visual emphasis. Accepts a single button with `variant=\"primary\"`.\n\nUse this for the primary action you want users to take. This can't be used when `gap=\"none\"`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Supporting actions displayed with less emphasis than the primary action. Accepts one or more button components with `variant=\"secondary\"` or `variant=\"auto\"`.\n\nUse these for alternative or less critical actions.", + "isOptional": true + } + ], + "value": "export interface ButtonGroupSlots {\n /**\n * The buttons displayed within the button group component, which are arranged together as a cohesive set of related actions.\n */\n children?: HTMLElement;\n /**\n * The main action for this group, displayed with high visual emphasis.\n * Accepts a single button with `variant=\"primary\"`.\n *\n * Use this for the primary action you want users to take. This can't be used when `gap=\"none\"`.\n */\n 'primary-action'?: HTMLElement;\n /**\n * Supporting actions displayed with less emphasis than the primary action.\n * Accepts one or more button components with `variant=\"secondary\"` or `variant=\"auto\"`.\n *\n * Use these for alternative or less critical actions.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "CheckboxEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "CheckboxEvents", + "description": "The checkbox component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the checkbox.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface CheckboxEvents {\n /**\n * A callback fired when the checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the checkbox.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n}" + } + }, + "ChipSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChipSlots", + "description": "The chip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "HTMLElement", + "description": "An optional icon to display at the start of the chip. Accepts only icon components.", + "isOptional": true + } + ], + "value": "export interface ChipSlots {\n /**\n * The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.\n */\n children?: HTMLElement;\n /**\n * An optional icon to display at the start of the chip. Accepts only icon components.\n */\n graphic?: HTMLElement;\n}" + } + }, + "ChoiceSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceSlots", + "description": "The choice list component supports slots for additional content placement within each choice. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The label text or elements that identify this selectable choice to users.\n\nThe label is produced by extracting and concatenating the text nodes from the provided content; any markup or element structure is ignored.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "HTMLElement", + "description": "Additional text to provide context or guidance for the input.\n\nThis text is displayed along with the input and its label to offer more information or instructions to the user.", + "isOptional": true + } + ], + "value": "export interface ChoiceSlots {\n /**\n * The label text or elements that identify this selectable choice to users.\n *\n * The label is produced by extracting and\n * concatenating the text nodes from the provided content;\n * any markup or element structure is ignored.\n */\n children?: HTMLElement;\n /**\n * Additional text to provide context or guidance for the input.\n *\n * This text is displayed along with the input and its label\n * to offer more information or instructions to the user.\n *\n * @implementation this content should be linked to the input with an `aria-describedby` attribute.\n */\n details?: HTMLElement;\n}" + } + }, + "ChoiceListEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceListEvents", + "description": "The choice list component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener | null", + "description": "A callback fired when the choice list selection changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user inputs data into the choice list.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ChoiceListEvents {\n /**\n * A callback fired when the choice list selection changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener | null = null;\n /**\n * A callback fired when the user inputs data into the choice list.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener | null = null;\n}" + } + }, + "ChoiceListSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceListSlots", + "description": "The choice list component supports slots for additional content placement within each choice. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The choices a user can select from.\n\nAccepts choice components.", + "isOptional": true + } + ], + "value": "export interface ChoiceListSlots {\n /**\n * The choices a user can select from.\n *\n * Accepts choice components.\n */\n children?: HTMLElement;\n}" + } + }, + "ClickableEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableEvents", + "description": "The clickable component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener | null", + "description": "A callback fired when the component loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the component is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener | null", + "description": "A callback fired when the component receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface ClickableEvents {\n /**\n * A callback fired when the component is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n /**\n * A callback fired when the component loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener | null = null;\n /**\n * A callback fired when the component receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener | null = null;\n}" + } + }, + "ClickableSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableSlots", + "description": "The clickable component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the clickable component, which makes any content interactive and clickable without the semantic meaning of a button or link.", + "isOptional": true + } + ], + "value": "export interface ClickableSlots {\n /**\n * The content displayed within the clickable component, which makes any content interactive and clickable without the semantic meaning of a button or link.\n */\n children?: HTMLElement;\n}" + } + }, + "ClickableChipEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableChipEvents", + "description": "The clickable chip component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the chip is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the chip is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "remove", + "value": "CallbackEventListener | null", + "description": "A callback fired when the chip is removed.", + "isOptional": true + } + ], + "value": "export interface ClickableChipEvents {\n /**\n * A callback fired when the chip is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n /**\n * A callback fired when the chip is removed.\n */\n remove: CallbackEventListener | null = null;\n /**\n * A callback fired after the chip is hidden.\n */\n afterhide: CallbackEventListener | null = null;\n}" + } + }, + "ClickableChipSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableChipSlots", + "description": "The clickable chip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text label displayed within the chip, which represents an interactive filter, tag, or selectable item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "HTMLElement", + "description": "An optional icon to display at the start of the chip. Accepts only icon components.", + "isOptional": true + } + ], + "value": "export interface ClickableChipSlots {\n /**\n * The text label displayed within the chip, which represents an interactive filter, tag, or selectable item.\n */\n children?: HTMLElement;\n /**\n * An optional icon to display at the start of the chip. Accepts only icon components.\n */\n graphic?: HTMLElement;\n}" + } + }, + "ColorFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorFieldEvents", + "description": "The color field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the color field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the color field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the color field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the color field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ColorFieldEvents {\n /**\n * A callback fired when the color field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the color field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the color field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the color field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "ColorPickerEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorPickerEvents", + "description": "The color picker component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener | null", + "description": "A callback fired when the color picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user inputs data into the color picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ColorPickerEvents {\n /**\n * A callback fired when the color picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener | null = null;\n /**\n * A callback fired when the user inputs data into the color picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener | null = null;\n}" + } + }, + "DateFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DateFieldEvents", + "description": "The date field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the date field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the date field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the date field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the date field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "invalid", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date field value is invalid.\n\nLearn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "viewchange", + "value": "CallbackEventListener | null", + "description": "A callback fired when the calendar view changes (such as when navigating between months).", + "isOptional": true + } + ], + "value": "export interface DateFieldEvents {\n /**\n * A callback fired when the date field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the date field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the date field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the date field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n /**\n * A callback fired when the calendar view changes (such as when navigating between months).\n */\n viewchange: CallbackEventListener | null = null;\n /**\n * A callback fired when the date field value is invalid.\n *\n * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).\n */\n invalid: CallbackEventListener | null = null;\n}" + } + }, + "DatePickerEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DatePickerEvents", + "description": "The date picker component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date picker loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date picker receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user inputs data into the date picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "viewchange", + "value": "CallbackEventListener | null", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", + "isOptional": true + } + ], + "value": "export interface DatePickerEvents {\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewchange: CallbackEventListener | null = null;\n /**\n * A callback fired when the date picker receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener | null = null;\n /**\n * A callback fired when the date picker loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener | null = null;\n /**\n * A callback fired when the user inputs data into the date picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener | null = null;\n /**\n * A callback fired when the date picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener | null = null;\n}" + } + }, + "DropZoneEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DropZoneEvents", + "description": "The drop zone component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the drop zone value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "droprejected", + "value": "CallbackEventListener", + "description": "A callback fired when a dropped file is rejected due to file type or size restrictions.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the drop zone.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface DropZoneEvents {\n /**\n * A callback fired when the drop zone value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener = null;\n /**\n * A callback fired when the user inputs data into the drop zone.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener = null;\n /**\n * A callback fired when a dropped file is rejected due to file type or size restrictions.\n */\n droprejected: CallbackEventListener = null;\n}" + } + }, + "DropZoneSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DropZoneSlots", + "description": "The drop zone component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content to include inside the drop zone container", + "isOptional": true + } + ], + "value": "export interface DropZoneSlots {\n /**\n * The content to include inside the drop zone container\n */\n children?: HTMLElement;\n}" + } + }, + "EmailFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "EmailFieldEvents", + "description": "The email field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the email field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the email field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the email field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the email field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface EmailFieldEvents {\n /**\n * A callback fired when the email field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the email field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the email field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "GridSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "GridSlots", + "description": "The grid component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The child elements displayed within the grid component, which are arranged in a flexible grid layout with configurable columns, rows, and spacing.", + "isOptional": true + } + ], + "value": "export interface GridSlots {\n /**\n * The child elements displayed within the grid component, which are arranged in a flexible grid layout with configurable columns, rows, and spacing.\n */\n children?: HTMLElement;\n}" + } + }, + "GridItemSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "GridItemSlots", + "description": "The grid item component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the grid item component, which represents a single cell in the grid layout and can span multiple columns or rows.", + "isOptional": true + } + ], + "value": "export interface GridItemSlots {\n /**\n * The content displayed within the grid item component, which represents a single cell in the grid layout and can span multiple columns or rows.\n */\n children?: HTMLElement;\n}" + } + }, + "HeadingSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "HeadingSlots", + "description": "The heading component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The heading text displayed within the heading component, which provides a title or section header for content.", + "isOptional": true + } + ], + "value": "export interface HeadingSlots {\n /**\n * The heading text displayed within the heading component, which provides a title or section header for content.\n */\n children?: HTMLElement;\n}" + } + }, + "ImageEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ImageEvents", + "description": "The image component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "OnErrorEventHandler", + "description": "A callback fired when the image fails to load.\n\nLearn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "load", + "value": "CallbackEventListener | null", + "description": "A callback fired when the image successfully loads.\n\nLearn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).", + "isOptional": true + } + ], + "value": "export interface ImageEvents {\n /**\n * A callback fired when the image successfully loads.\n *\n * Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).\n */\n load: CallbackEventListener | null = null;\n /**\n * A callback fired when the image fails to load.\n *\n * Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).\n */\n error: OnErrorEventHandler = null;\n}" + } + }, + "LinkEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LinkEvents", + "description": "The link component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the link is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + } + ], + "value": "export interface LinkEvents {\n /**\n * A callback fired when the link is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n}" + } + }, + "LinkSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LinkSlots", + "description": "The link component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text or elements displayed within the link component, which navigates users to a different location when activated.", + "isOptional": true + } + ], + "value": "export interface LinkSlots {\n /**\n * The text or elements displayed within the link component, which navigates users to a different location when activated.\n */\n children?: HTMLElement;\n}" + } + }, + "ListItemSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ListItemSlots", + "description": "The list item component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the list item, which represents a single entry in an ordered or unordered list.", + "isOptional": true + } + ], + "value": "export interface ListItemSlots {\n /**\n * The content displayed within the list item, which represents a single entry in an ordered or unordered list.\n */\n children?: HTMLElement;\n}" + } + }, + "MenuSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MenuSlots", + "description": "The menu component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The items displayed within the menu. Only accepts button and section components. Use button for individual menu actions and section to group related items.", + "isOptional": true + } + ], + "value": "export interface MenuSlots {\n /**\n * The items displayed within the menu. Only accepts button and section components. Use button for individual menu actions and section to group related items.\n */\n children?: HTMLElement;\n}" + } + }, + "ModalEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ModalEvents", + "description": "The modal component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the modal is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aftershow", + "value": "CallbackEventListener | null", + "description": "A callback fired after the modal is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "CallbackEventListener | null", + "description": "A callback fired when the modal is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "CallbackEventListener | null", + "description": "A callback fired when the modal is shown.", + "isOptional": true + } + ], + "value": "export interface ModalEvents {\n /**\n * A callback fired when the modal is hidden.\n */\n hide: CallbackEventListener | null = null;\n /**\n * A callback fired when the modal is shown.\n */\n show: CallbackEventListener | null = null;\n /**\n * A callback fired after the modal is hidden.\n */\n afterhide: CallbackEventListener | null = null;\n /**\n * A callback fired after the modal is shown.\n */\n aftershow: CallbackEventListener | null = null;\n}" + } + }, + "ModalSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ModalSlots", + "description": "The modal component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the modal component, typically including form fields, information, or interactive elements.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action button displayed in the modal footer, representing the primary action users should take.\n\nOnly accepts a single button component with a `variant` of `primary`. This action should align with the modal's main purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Additional action buttons displayed in the modal footer, providing alternative or supporting actions.\n\nOnly accepts button components with a `variant` of `secondary` or `auto`. These are visually de-emphasized to establish clear hierarchy.", + "isOptional": true + } + ], + "value": "export interface ModalSlots {\n /**\n * The content displayed within the modal component, typically including form fields, information, or interactive elements.\n */\n children?: HTMLElement;\n /**\n * The main action button displayed in the modal footer, representing the primary action users should take.\n *\n * Only accepts a single button component with a `variant` of `primary`. This action should align with the modal's main purpose.\n */\n 'primary-action'?: HTMLElement;\n /**\n * Additional action buttons displayed in the modal footer, providing alternative or supporting actions.\n *\n * Only accepts button components with a `variant` of `secondary` or `auto`. These are visually de-emphasized to establish clear hierarchy.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "MoneyFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MoneyFieldEvents", + "description": "The money field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the money field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the money field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the money field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the money field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface MoneyFieldEvents {\n /**\n * A callback fired when the money field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the money field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the money field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "NumberFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "NumberFieldEvents", + "description": "The number field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the number field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the number field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the number field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the number field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface NumberFieldEvents {\n /**\n * A callback fired when the number field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the number field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the number field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "OptionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OptionSlots", + "description": "The option component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text or elements displayed as the option label, which identifies the selectable choice to users in a dropdown or selection list.", + "isOptional": true + } + ], + "value": "export interface OptionSlots {\n /**\n * The text or elements displayed as the option label, which identifies the selectable choice to users in a dropdown or selection list.\n */\n children?: HTMLElement;\n}" + } + }, + "OptionGroupSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OptionGroupSlots", + "description": "The option group component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.", + "isOptional": true + } + ], + "value": "export interface OptionGroupSlots {\n /**\n * The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.\n */\n children?: HTMLElement;\n}" + } + }, + "OrderedListSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OrderedListSlots", + "description": "The ordered list component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The list entries displayed within the ordered list, where each item is numbered sequentially. Only accepts list item components as children. Each list item represents a single numbered entry in the sequence.", + "isOptional": true + } + ], + "value": "export interface OrderedListSlots {\n /**\n * The list entries displayed within the ordered list, where each item is numbered sequentially. Only accepts list item components as children. Each list item represents a single numbered entry in the sequence.\n */\n children?: HTMLElement;\n}" + } + }, + "PageSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PageSlots", + "description": "The page component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aside", + "value": "HTMLElement", + "description": "The content to display in the aside section of the page.\n\nThis slot is only rendered when `inlineSize` is \"base\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "breadcrumb-actions", + "value": "HTMLElement", + "description": "The navigation back actions for the page.\n\nOnly accepts link components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The main page content displayed within the page component, which serves as the primary container for the page's information and interface elements.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The primary action for the page.\n\nOnly accepts a single button component with a `variant` of `primary`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "The secondary actions for the page.\n\nOnly accepts button group and button components with a `variant` of `secondary` or `auto`.", + "isOptional": true + } + ], + "value": "export interface PageSlots {\n /**\n * The main page content displayed within the page component, which serves as the primary container for the page's information and interface elements.\n */\n children?: HTMLElement;\n /**\n * The content to display in the aside section of the page.\n *\n * This slot is only rendered when `inlineSize` is \"base\".\n */\n aside?: HTMLElement;\n /**\n * The primary action for the page.\n *\n * Only accepts a single button component with a `variant` of `primary`.\n *\n */\n 'primary-action'?: HTMLElement;\n /**\n * The secondary actions for the page.\n *\n * Only accepts button group and button components with a `variant` of `secondary` or `auto`.\n */\n 'secondary-actions'?: HTMLElement;\n /**\n * The navigation back actions for the page.\n *\n * Only accepts link components.\n */\n 'breadcrumb-actions'?: HTMLElement;\n}" + } + }, + "ParagraphSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ParagraphSlots", + "description": "The paragraph component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling.", + "isOptional": true + } + ], + "value": "export interface ParagraphSlots {\n /**\n * The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling.\n */\n children?: HTMLElement;\n}" + } + }, + "PasswordFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PasswordFieldEvents", + "description": "The password field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the password field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the password field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the password field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the password field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface PasswordFieldEvents {\n /**\n * A callback fired when the password field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the password field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the password field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "PopoverEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PopoverEvents", + "description": "The popover component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the popover is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aftershow", + "value": "CallbackEventListener | null", + "description": "A callback fired after the popover is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aftertoggle", + "value": "CallbackEventListener | null", + "description": "A callback fired after the popover is toggled.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "CallbackEventListener | null", + "description": "A callback fired when the popover is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "CallbackEventListener | null", + "description": "A callback fired when the popover is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "toggle", + "value": "CallbackEventListener | null", + "description": "A callback fired when the popover is toggled.", + "isOptional": true + } + ], + "value": "export interface PopoverEvents {\n /**\n * A callback fired when the popover is shown.\n */\n show: CallbackEventListener | null;\n /**\n * A callback fired when the popover is hidden.\n */\n hide: CallbackEventListener | null;\n /**\n * A callback fired after the popover is shown.\n */\n aftershow: CallbackEventListener | null;\n /**\n * A callback fired after the popover is hidden.\n */\n afterhide: CallbackEventListener | null;\n /**\n * A callback fired when the popover is toggled.\n */\n toggle: CallbackEventListener | null;\n /**\n * A callback fired after the popover is toggled.\n */\n aftertoggle: CallbackEventListener | null;\n}" + } + }, + "PopoverSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PopoverSlots", + "description": "The popover component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the popover component, which appears in an overlay positioned relative to its trigger element.", + "isOptional": true + } + ], + "value": "export interface PopoverSlots {\n /**\n * The content displayed within the popover component, which appears in an overlay positioned relative to its trigger element.\n */\n children?: HTMLElement;\n}" + } + }, + "QueryContainerSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "QueryContainerSlots", + "description": "The query container component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the query container component, which enables container queries for responsive styling based on the container's size rather than the viewport.", + "isOptional": true + } + ], + "value": "export interface QueryContainerSlots {\n /**\n * The content displayed within the query container component, which enables container queries for responsive styling based on the container's size rather than the viewport.\n */\n children?: HTMLElement;\n}" + } + }, + "SearchFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SearchFieldEvents", + "description": "The search field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the search field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the search field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the search field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the search field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface SearchFieldEvents {\n /**\n * A callback fired when the search field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the search field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the search field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the search field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "SectionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SectionSlots", + "description": "The section component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.", + "isOptional": true + } + ], + "value": "export interface SectionSlots {\n /**\n * The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.\n */\n children?: HTMLElement;\n}" + } + }, + "SelectEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SelectEvents", + "description": "The select component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the select value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the select.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface SelectEvents {\n /**\n * A callback fired when the select value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the select.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n}" + } + }, + "SelectSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SelectSlots", + "description": "The select component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The selectable options displayed in the dropdown list. Accepts option components for individual selectable items, and option group components to organize related options into logical groups with labels.", + "isOptional": true + } + ], + "value": "export interface SelectSlots {\n /**\n * The selectable options displayed in the dropdown list. Accepts option components for individual selectable items, and option group components to organize related options into logical groups with labels.\n */\n children?: HTMLElement;\n}" + } + }, + "StackSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "StackSlots", + "description": "The stack component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.", + "isOptional": true + } + ], + "value": "export interface StackSlots {\n /**\n * The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.\n */\n children?: HTMLElement;\n}" + } + }, + "SwitchEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SwitchEvents", + "description": "The switch component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the switch value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the switch.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface SwitchEvents {\n /**\n * A callback fired when the switch value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the switch.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n}" + } + }, + "TableEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableEvents", + "description": "The table component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "nextpage", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user navigates to the next page.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "previouspage", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user navigates to the previous page.", + "isOptional": true + } + ], + "value": "export interface TableEvents {\n /**\n * A callback fired when the user navigates to the previous page.\n */\n previouspage: CallbackEventListener | null = null;\n /**\n * A callback fired when the user navigates to the next page.\n */\n nextpage: CallbackEventListener | null = null;\n}" + } + }, + "TableSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableSlots", + "description": "The table component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The table structure defining headers and data rows.\n\nAccepts table header row (for column headers) and table body (for data rows) components. Structure your table with a table header row first, followed by table body.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "filters", + "value": "HTMLElement", + "description": "Filter controls displayed above the table.\n\nAccepts input components like search field or select for filtering table data. These controls appear in a dedicated area above the table content.", + "isOptional": true + } + ], + "value": "export interface TableSlots {\n /**\n * The table structure defining headers and data rows.\n *\n * Accepts table header row (for column headers) and table body (for data rows) components. Structure your table with a table header row first, followed by table body.\n */\n children?: HTMLElement;\n /**\n * Filter controls displayed above the table.\n *\n * Accepts input components like search field or select for filtering table data. These controls appear in a dedicated area above the table content.\n */\n filters?: HTMLElement;\n}" + } + }, + "TableBodySlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableBodySlots", + "description": "The table body component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The data rows displayed in the table body.\n\nAccepts table row components, with each row representing a single record or entry in the table.", + "isOptional": true + } + ], + "value": "export interface TableBodySlots {\n /**\n * The data rows displayed in the table body.\n *\n * Accepts table row components, with each row representing a single record or entry in the table.\n */\n children?: HTMLElement;\n}" + } + }, + "TableCellSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableCellSlots", + "description": "The table cell component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The data value displayed in this cell.\n\nAccepts text content or inline components representing the cell's data value.", + "isOptional": true + } + ], + "value": "export interface TableCellSlots {\n /**\n * The data value displayed in this cell.\n *\n * Accepts text content or inline components representing the cell's data value.\n */\n children?: HTMLElement;\n}" + } + }, + "TableHeaderSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeaderSlots", + "description": "The table header component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The column heading text.\n\nThis text labels the column in table variant and appears as a label for data in list variant.", + "isOptional": true + } + ], + "value": "export interface TableHeaderSlots {\n /**\n * The column heading text.\n *\n * This text labels the column in table variant and appears as a label for data in list variant.\n */\n children?: HTMLElement;\n}" + } + }, + "TableHeaderRowSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeaderRowSlots", + "description": "The table header row component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The column headers displayed in the table header row.\n\nAccepts table header components, with each header defining a column and providing its label.", + "isOptional": true + } + ], + "value": "export interface TableHeaderRowSlots {\n /**\n * The column headers displayed in the table header row.\n *\n * Accepts table header components, with each header defining a column and providing its label.\n */\n children?: HTMLElement;\n}" + } + }, + "TableRowSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableRowSlots", + "description": "The table row component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The data cells displayed in this table row.\n\nAccepts table cell components, with each cell containing a data value for the corresponding column.", + "isOptional": true + } + ], + "value": "export interface TableRowSlots {\n /**\n * The data cells displayed in this table row.\n *\n * Accepts table cell components, with each cell containing a data value for the corresponding column.\n */\n children?: HTMLElement;\n}" + } + }, + "TextSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextSlots", + "description": "The text component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.", + "isOptional": true + } + ], + "value": "export interface TextSlots {\n /**\n * The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.\n */\n children?: HTMLElement;\n}" + } + }, + "TextAreaEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextAreaEvents", + "description": "The text area component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text area loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text area value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text area receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the text area.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface TextAreaEvents {\n /**\n * A callback fired when the text area value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text area loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text area receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "TextFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextFieldEvents", + "description": "The text field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the text field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface TextFieldEvents {\n /**\n * A callback fired when the text field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "TextFieldSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextFieldSlots", + "description": "The text field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the text field.\n\nAccepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface TextFieldSlots {\n /**\n * Additional interactive content displayed within the text field.\n *\n * Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "ThumbnailEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ThumbnailEvents", + "description": "The thumbnail component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "OnErrorEventHandler", + "description": "A callback fired when the thumbnail image fails to load.\n\nLearn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "load", + "value": "CallbackEventListener | null", + "description": "A callback fired when the thumbnail image successfully loads.\n\nLearn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).", + "isOptional": true + } + ], + "value": "export interface ThumbnailEvents {\n /**\n * A callback fired when the thumbnail image successfully loads.\n *\n * Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).\n */\n load: CallbackEventListener | null = null;\n /**\n * A callback fired when the thumbnail image fails to load.\n *\n * Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).\n */\n error: OnErrorEventHandler = null;\n}" + } + }, + "TooltipSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TooltipSlots", + "description": "The tooltip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The informational text or elements displayed within the tooltip overlay, providing helpful context or explanations when users interact with the associated element.\n\nOnly accepts text, paragraph components, and raw `textContent`.", + "isOptional": true + } + ], + "value": "export interface TooltipSlots {\n /**\n * The informational text or elements displayed within the tooltip overlay, providing helpful context or explanations when users interact with the associated element.\n *\n * Only accepts text, paragraph components, and raw `textContent`.\n */\n children?: HTMLElement;\n}" + } + }, + "URLFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "URLFieldEvents", + "description": "The URL field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the URL field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the URL field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the URL field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the URL field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface URLFieldEvents {\n /**\n * A callback fired when the URL field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the URL field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the URL field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the URL field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "UnorderedListSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "UnorderedListSlots", + "description": "The unordered list component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The list entries displayed within the unordered list, where each item is marked with a bullet point. Only accepts list item components as children. Each list item represents a single bulleted entry in the list.", + "isOptional": true + } + ], + "value": "export interface UnorderedListSlots {\n /**\n * The list entries displayed within the unordered list, where each item is marked with a bullet point. Only accepts list item components as children. Each list item represents a single bulleted entry in the list.\n */\n children?: HTMLElement;\n}" + } + }, + "AdminActionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminActionSlots", + "description": "The admin action component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action button or link displayed in the admin action modal. This represents the primary or most important action that users can take in this modal context, typically displayed with high visual prominence." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Additional action buttons or links displayed in the admin action modal. These provide alternative or supporting actions, visually de-emphasized compared to the primary action to establish clear hierarchy." + } + ], + "value": "export interface AdminActionSlots {\n /**\n * The main action button or link displayed in the admin action modal.\n * This represents the primary or most important action that users can take in this modal context, typically displayed with high visual prominence.\n */\n 'primary-action': HTMLElement;\n /**\n * Additional action buttons or links displayed in the admin action modal.\n * These provide alternative or supporting actions, visually de-emphasized compared to the primary action to establish clear hierarchy.\n */\n 'secondary-actions': HTMLElement;\n}" + } + }, + "FormEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FormEvents", + "description": "The form component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "reset", + "value": "CallbackEventListener | null", + "description": "A callback that is run when the form is reset.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "CallbackExtendableEventListener | null", + "description": "A callback that is run when the form is submitted.", + "isOptional": true + } + ], + "value": "export interface FormEvents {\n /**\n * A callback that is run when the form is submitted.\n */\n submit: CallbackExtendableEventListener | null = null;\n /**\n * A callback that is run when the form is reset.\n */\n reset: CallbackEventListener | null = null;\n}" + } + }, + "FunctionSettingsEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionSettingsEvents", + "description": "The function settings component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "CallbackErrorEventListener<\n typeof tagName,\n FunctionSettingsErrorEvent['error']['errors'][0]\n > | null", + "description": "An optional callback function that will be run by the admin when committing the changes to Shopify’s servers fails. The error event you receive includes an `error` property that is an `AggregateError` object. This object includes an array of errors that were caused by data your extension provided. Network errors and user errors that are out of your control will not be reported here.\n\nIn the `onError` callback, you should update your extension’s UI to highlight the fields that caused the errors, and display the error messages to the user.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "reset", + "value": "CallbackEventListener | null", + "description": "A callback that is run when the function settings form is reset.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "CallbackExtendableEventListener | null", + "description": "An optional callback function that will be run by the admin when the user commits their changes in the admin-rendered part of the function settings experience. If `event.waitUntil` is called with a promise, the admin will wait for the promise to resolve before committing any changes to Shopify’s servers. If the promise rejects, the admin will abort the changes and display an error, using the `message` property of the error you reject with.", + "isOptional": true + } + ], + "value": "export interface FunctionSettingsEvents {\n /**\n * An optional callback function that will be run by the admin when the user\n * commits their changes in the admin-rendered part of the function settings\n * experience. If `event.waitUntil` is called with a promise, the admin will wait for the\n * promise to resolve before committing any changes to Shopify’s servers. If\n * the promise rejects, the admin will abort the changes and display an error,\n * using the `message` property of the error you reject with.\n */\n submit: CallbackExtendableEventListener | null = null;\n /**\n * An optional callback function that will be run by the admin when\n * committing the changes to Shopify’s servers fails. The error event you receive includes\n * an `error` property that is an `AggregateError` object. This object includes\n * an array of errors that were caused by data your extension provided.\n * Network errors and user errors that are out of your control will not be reported here.\n *\n * In the `onError` callback, you should update your extension’s UI to\n * highlight the fields that caused the errors, and display the error messages\n * to the user.\n */\n error: CallbackErrorEventListener<\n typeof tagName,\n FunctionSettingsErrorEvent['error']['errors'][0]\n > | null = null;\n /**\n * A callback that is run when the function settings form is reset.\n */\n reset: CallbackEventListener | null = null;\n}" + } + }, + "AppNavAttributes": { + "src/surfaces/admin/components/AppNav/AppNavTypes.ts": { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "name": "AppNavAttributes", + "description": "Configure the following properties on the app nav component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The navigation items to inject into the Shopify admin sidebar. Provide `` children where each link represents a navigation item. This component does not render any visible UI itself.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element.", + "isOptional": true + } + ], + "value": "export interface AppNavAttributes {\n /**\n * A unique identifier for the element.\n */\n id?: string;\n /**\n * The navigation items to inject into the Shopify admin sidebar.\n * Provide `` children where each link represents a navigation item.\n * This component does not render any visible UI itself.\n */\n children?: ComponentChildren;\n}" + } + }, + "AppNavLinkAttributes": { + "src/surfaces/admin/components/AppNav/AppNavTypes.ts": { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "name": "AppNavLinkAttributes", + "description": "Attributes for link elements used as children of app nav. Each link defines a navigation destination in your app's menu.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "string", + "description": "The visible label text for the navigation item. Keep labels short (1-2 words) and use nouns that describe the destination (such as \"Products\", \"Settings\", or \"Reports\"). Avoid verbs like \"Manage\" or \"View\" to maintain consistency with Shopify admin navigation patterns.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL path for the navigation item. Must be a relative path within your app, such as `/products` or `/settings`. When clicked, it navigates the app to this route without a full page reload. The path should match a route defined in your app's routing configuration." + } + ], + "value": "export interface AppNavLinkAttributes {\n /**\n * The URL path for the navigation item. Must be a relative path within your app, such as `/products` or `/settings`. When clicked, it navigates the app to this route without a full page reload. The path should match a route defined in your app's routing configuration.\n */\n href: string;\n /**\n * The visible label text for the navigation item. Keep labels short (1-2 words) and use nouns that describe the destination (such as \"Products\", \"Settings\", or \"Reports\"). Avoid verbs like \"Manage\" or \"View\" to maintain consistency with Shopify admin navigation patterns.\n */\n children?: string;\n}" + } + } +} diff --git a/packages/ui-extensions/docs/surfaces/admin/generated/app_home_ui_extension/2026-07-rc/generated_docs_data_v2.json b/packages/ui-extensions/docs/surfaces/admin/generated/app_home_ui_extension/2026-07-rc/generated_docs_data_v2.json new file mode 100644 index 0000000000..004e997942 --- /dev/null +++ b/packages/ui-extensions/docs/surfaces/admin/generated/app_home_ui_extension/2026-07-rc/generated_docs_data_v2.json @@ -0,0 +1,23449 @@ +{ + "GraphQLError": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "GraphQLError", + "description": "An error returned by the Storefront GraphQL API. Contains a human-readable `message` and an `extensions` object with the request ID and error code for debugging.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "extensions", + "value": "{ requestId: string; code: string; }", + "description": "Additional error metadata including the request ID and error code." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A human-readable description of the error." + } + ], + "value": "export interface GraphQLError {\n /**\n * A human-readable description of the error.\n */\n message: string;\n /**\n * Additional error metadata including the request ID and error code.\n */\n extensions: {\n /**\n * The unique identifier for the API request, useful for debugging with Shopify support.\n */\n requestId: string;\n /**\n * A machine-readable error code identifying the type of error.\n */\n code: string;\n };\n}" + } + }, + "Storage": { + "src/surfaces/admin/api/standard/storage.ts": { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "name": "Storage", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "clear", + "value": "() => Promise", + "description": "Clears all data from the storage. Use this to reset your extension's storage, such as when implementing a logout flow, clearing cached data, or resetting to defaults. This operation removes all stored key-value pairs." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "delete", + "value": "(key: Keys) => Promise", + "description": "Deletes a specific key from the storage. Use this to remove individual data items that are no longer needed, freeing up storage space and maintaining data hygiene." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "deleteMany", + "value": "(keys: Keys[]) => Promise>", + "description": "Deletes multiple keys from the storage at once. Use this to efficiently remove several related data items in a single operation, such as clearing expired cache entries or removing a group of related settings." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "entries", + "value": "() => Promise>", + "description": "Gets all the keys and values in the storage. Use this to iterate over all stored data, useful for debugging, data migration, or displaying all stored settings. The returned iterator provides entries as `[key, value]` tuples." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "get", + "value": "(key: Keys) => Promise", + "description": "Gets the value of a key in the storage. Use this to retrieve previously saved data when your extension loads or when you need to access stored values. The value is automatically deserialized from JSON to its original type." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "getMany", + "value": "(keys: Keys[]) => Promise", + "description": "Gets the values of multiple keys in the storage at once. Use this to efficiently retrieve related data in a single operation, reducing overhead when loading multiple stored values. The returned array is in the same order as the provided keys, with `undefined` values for keys that don't exist in storage." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "set", + "value": "(key: Keys, value: StorageTypes[Keys]) => Promise", + "description": "Sets the value of a key in the storage. Use this to save individual data items like user preferences, form state, or cached values. The value is serialized using `JSON.stringify`, so it can be any primitive type, object, or array that JSON supports." + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "MethodSignature", + "name": "setMany", + "value": "(entries: Partial) => Promise", + "description": "Sets multiple key-value pairs in the storage at once. Use this for efficient batch operations when you need to save multiple related values together, such as form data or configuration settings." + } + ], + "value": "export interface Storage<\n BaseStorageTypes extends Record = Record,\n> {\n /**\n * Sets the value of a key in the storage. Use this to save individual data items like user preferences, form state, or cached values. The value is serialized using `JSON.stringify`, so it can be any primitive type, object, or array that JSON supports.\n *\n * @param key - The key to set the value for. Use descriptive keys to organize your stored data.\n * @param value - The value to set for the key. Can be any primitive type supported by `JSON.stringify`.\n *\n * @throws {StorageExceededError} Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.\n */\n set<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n key: Keys,\n value: StorageTypes[Keys],\n ): Promise;\n\n /**\n * Sets multiple key-value pairs in the storage at once. Use this for efficient batch operations when you need to save multiple related values together, such as form data or configuration settings.\n *\n * @param entries - An object containing key-value pairs to store. Values can be any primitive type supported by `JSON.stringify`.\n *\n * @throws {StorageExceededError} Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.\n */\n setMany(\n entries: Partial,\n ): Promise;\n\n /**\n * Gets the value of a key in the storage. Use this to retrieve previously saved data when your extension loads or when you need to access stored values. The value is automatically deserialized from JSON to its original type.\n *\n * @param key - The key to get the value for.\n * @returns The value of the key, or `undefined` if no value exists for the key.\n */\n get<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n key: Keys,\n ): Promise;\n\n /**\n * Gets the values of multiple keys in the storage at once. Use this to efficiently retrieve related data in a single operation, reducing overhead when loading multiple stored values. The returned array is in the same order as the provided keys, with `undefined` values for keys that don't exist in storage.\n *\n * @param keys - An array of keys to get the values for.\n * @returns An array containing values for the requested keys, in the same order as the input keys.\n */\n getMany<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n keys: Keys[],\n ): Promise<(StorageTypes[Keys] | undefined)[]>;\n\n /**\n * Clears all data from the storage. Use this to reset your extension's storage, such as when implementing a logout flow, clearing cached data, or resetting to defaults. This operation removes all stored key-value pairs.\n */\n clear(): Promise;\n\n /**\n * Deletes a specific key from the storage. Use this to remove individual data items that are no longer needed, freeing up storage space and maintaining data hygiene.\n *\n * @param key - The key to delete.\n * @returns A promise that resolves to `true` if the key existed and was deleted, or `false` if the key did not exist.\n */\n delete<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n key: Keys,\n ): Promise;\n\n /**\n * Deletes multiple keys from the storage at once. Use this to efficiently remove several related data items in a single operation, such as clearing expired cache entries or removing a group of related settings.\n *\n * @param keys - An array of keys to delete.\n * @returns A promise that resolves to an object mapping each key to a boolean value: `true` if the key existed and was deleted, or `false` if the key did not exist.\n */\n deleteMany<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(\n keys: Keys[],\n ): Promise>;\n\n /**\n * Gets all the keys and values in the storage. Use this to iterate over all stored data, useful for debugging, data migration, or displaying all stored settings. The returned iterator provides entries as `[key, value]` tuples.\n *\n * @returns A promise that resolves to an iterator containing all key-value pairs in the storage.\n */\n entries<\n StorageTypes extends BaseStorageTypes = BaseStorageTypes,\n Keys extends keyof StorageTypes = keyof StorageTypes,\n >(): Promise>;\n}" + } + }, + "StorageExceededError": { + "src/surfaces/admin/api/standard/storage.ts": { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "name": "StorageExceededError", + "description": "Error thrown when storage operations exceed the available storage quota. This can occur during `set()` or `setMany()` operations when the total stored data size exceeds the limit allocated to your extension.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "'StorageExceededError'", + "description": "" + }, + { + "filePath": "src/surfaces/admin/api/standard/storage.ts", + "syntaxKind": "PropertySignature", + "name": "stack", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface StorageExceededError extends Error {\n name: 'StorageExceededError';\n}" + } + }, + "Data": { + "src/surfaces/admin/api/shared.ts": { + "filePath": "src/surfaces/admin/api/shared.ts", + "name": "Data", + "description": "The `Data` object provides access to currently viewed or selected resources in the admin context.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "{ id: string; }[]", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions." + } + ], + "value": "export interface Data {\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.\n */\n selected: {id: string}[];\n}" + } + }, + "SupportedDefinitionType": { + "src/surfaces/admin/api/shared.ts": { + "filePath": "src/surfaces/admin/api/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SupportedDefinitionType", + "value": "'boolean' | 'collection_reference' | 'color' | 'date' | 'date_time' | 'dimension' | 'file_reference' | 'json' | 'metaobject_reference' | 'mixed_reference' | 'money' | 'multi_line_text_field' | 'number_decimal' | 'number_integer' | 'page_reference' | 'product_reference' | 'rating' | 'rich_text_field' | 'single_line_text_field' | 'product_taxonomy_value_reference' | 'url' | 'variant_reference' | 'volume' | 'weight' | 'list.collection_reference' | 'list.color' | 'list.date' | 'list.date_time' | 'list.dimension' | 'list.file_reference' | 'list.metaobject_reference' | 'list.mixed_reference' | 'list.number_decimal' | 'list.number_integer' | 'list.page_reference' | 'list.product_reference' | 'list.rating' | 'list.single_line_text_field' | 'list.url' | 'list.variant_reference' | 'list.volume' | 'list.weight'", + "description": "The supported [metafield definition types](/docs/apps/build/metafields/list-of-data-types) for storing extension configuration data. Use these types to specify how metafield values should be formatted, validated, and displayed. Types prefixed with `list.` store arrays of values, while other types store single values. Choose a type that matches your data format (for example, use `'number_integer'` for whole numbers, `'single_line_text_field'` for short text, or `'json'` for complex structured data).", + "isPublicDocs": true + } + }, + "ExtensionTargets": { + "src/surfaces/admin/extension-targets.ts": { + "filePath": "src/surfaces/admin/extension-targets.ts", + "name": "ExtensionTargets", + "description": "Maps extension target identifiers to their corresponding extension types. Each target represents a specific location or context in the Shopify admin where extensions can render or execute. Use these targets to define where your extension appears and what capabilities it has access to.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the abandoned checkout details page. Use this to create workflows for cart recovery, customer engagement, or checkout analysis." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the abandoned checkout details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on checkout properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.abandoned-checkout-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the abandoned checkout details page. Use this to show cart recovery tools, abandonment analysis, or customer re-engagement options." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the abandoned checkout index page. Use this to create workflows for cart recovery, bulk customer engagement, or checkout analysis across multiple abandoned carts." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.abandoned-checkout-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the abandoned checkout index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.app.home.render", + "value": "RenderExtension<\n AppHomeApi<'admin.app.home.render'>,\n FormExtensionComponents | 'Modal' | 'Page' | 'AppNav'\n >", + "description": "Renders an admin extension on the app home page." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.app.intent.render", + "value": "RenderExtension<\n IntentRenderApi<'admin.app.intent.render'>,\n FormExtensionComponents\n >", + "description": "Renders an admin extension for handling app intents." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.app.tools.data", + "value": "RunnableExtension<\n StandardApi<'admin.app.tools.data'>,\n undefined\n >", + "description": "A runnable target that enables your app to expose data to [Sidekick](/docs/apps/build/sidekick/build-app-data). Use this target to register tools that Sidekick can invoke to search your app's data and answer merchant questions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.catalog-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.catalog-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the catalog details page. Use this to create workflows for catalog management, market synchronization, or data exports." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.catalog-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.catalog-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the catalog details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on catalog properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.catalog-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.catalog-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the catalog details page. Use this to show catalog-specific settings, market information, or synchronization tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.collection-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the collection details page. Use this to create workflows for collection management, product operations, or merchandising tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.collection-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the collection details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on collection properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.collection-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the collection details page. Use this to show collection analytics, bulk product operations, or collection-specific tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.collection-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the collection index page. Use this to create workflows for collection management, bulk operations, or catalog organization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.collection-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.collection-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the collection index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.company-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the company details page. Use this to create workflows for B2B customer management, credit operations, or company data synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.company-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the company details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on company properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.company-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the company details page. Use this to show B2B customer information, credit limits, or company-specific data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.company-location-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.company-location-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the company location details page. Use this to show location-specific information, shipping preferences, or location management tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the customer details page. Use this to create workflows for customer data management, loyalty operations, or CRM integrations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on customer properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.customer-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the customer details page. Use this to show customer-specific information, loyalty data, or custom customer actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the customer index page. Use this to create workflows for customer management, marketing operations, or bulk data processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the customer index page when multiple customers are selected. Use this to create workflows for bulk customer operations, mass email campaigns, or batch data updates." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-segment-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.customer-segment-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears from the **Use segment** button on the customer segment details page. Use this to create workflows for marketing campaigns, email operations, or segment-based actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customer-segment-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.customer-segment-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the customer segment details action appears from the **Use segment** button. Use this to conditionally show or hide your action based on segment properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.customers.segmentation-templates.data", + "value": "RunnableExtension<\n CustomerSegmentTemplateApi<'admin.customers.segmentation-templates.data'>,\n {templates: CustomerSegmentTemplate[]}\n >", + "description": "A runnable target that provides [customer segment templates](/docs/apps/build/marketing-analytics/customer-segments/build-a-template-extension) in the [customer segment editor](https://help.shopify.com/manual/customers/customer-segmentation/create-customer-segments). Use this target to provide pre-built segment templates that merchants can use as starting points for creating targeted customer groups based on custom criteria." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.discount-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the discount details page. Use this to create workflows for discount management, promotion analysis, or discount synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.discount-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the discount details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on discount properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-details.function-settings.render", + "value": "RenderExtension<\n DiscountFunctionSettingsApi<'admin.discount-details.function-settings.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that appears when merchants create or edit a discount powered by your discount function, allowing them to configure function-specific settings. Use this to build custom configuration interfaces for discount function parameters." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.discount-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the discount index page. Use this to create workflows for discount management, promotional operations, or bulk discount updates." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.discount-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the discount index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.discount-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the discount index page when multiple discounts are selected. Use this to create workflows for bulk discount operations or batch data updates." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.discount-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.discount-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the discount index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.draft-order-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the draft order details page. Use this to create workflows for draft order processing, custom pricing, or order preparation tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.draft-order-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the draft order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on draft order properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.draft-order-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the draft order details page. Use this to show custom pricing calculations, special order handling tools, or order-specific information." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the draft order index page. Use this to create workflows for draft order management, bulk operations, or order conversion tools." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the draft order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the draft order index page when multiple draft orders are selected. Use this to create workflows for bulk draft order operations, batch conversions, or mass order processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.draft-order-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the draft order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.gift-card-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.gift-card-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the gift card details page. Use this to create workflows for gift card processing, balance adjustments, or custom gift card operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.gift-card-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.gift-card-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the gift card details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on gift card properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.gift-card-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.gift-card-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the gift card details page. Use this to show gift card balance tracking, usage history, or custom gift card metadata." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the order details page. Use this to create workflows for order processing, fulfillment operations, or external system integrations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on order properties, fulfillment status, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.order-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the order details page. Use this to show order-specific information, fulfillment tools, or custom order actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.order-details.print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the order details page. Use this to generate custom documents such as packing slips, shipping labels, or invoices." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-details.print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-details.print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on order properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-fulfilled-card.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-fulfilled-card.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the actions menu inside the order fulfilled card, visible only on orders fulfilled by your app. Use this to create workflows for fulfillment operations, tracking updates, or post-fulfillment actions." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-fulfilled-card.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-fulfilled-card.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order fulfilled card action appears in the actions menu. Use this to conditionally show or hide your action based on fulfillment properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the order index page. Use this to create workflows for order management, reporting, or fulfillment operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.order-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the order index page when multiple orders are selected. Use this to create workflows for bulk order operations, batch fulfillment, or mass order processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.order-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the order index page when multiple orders are selected. Use this to generate batch documents such as combined packing slips, shipping manifests, or bulk invoices." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.order-index.selection-print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the order index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the product details page. Use this to create workflows for processing products, syncing data, or integrating with external systems." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on product properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.product-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the product details page. Use this to show product-specific information, tools, or actions directly on the product page." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.configuration.render", + "value": "RenderExtension<\n ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>,\n BlockExtensionComponents\n >", + "description": "A configuration target that renders product configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product details page. Use this to define bundle component selections, customization options, or product configuration rules." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.product-details.print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the product details page. Use this to generate custom documents such as product labels, barcode sheets, or specification sheets." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-details.print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on product properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-details.reorder.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.product-details.reorder.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that provides custom reordering functionality on the product details page. Use this to help merchants rearrange product data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-index.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the product index page. Use this to create workflows for product management, catalog operations, or inventory synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-index.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-index.selection-action.render'>,\n ActionExtensionComponents\n >", + "description": "A selection action target that appears in the **More actions** menu on the product index page when multiple products are selected. Use this to create workflows for bulk product operations, batch updates, or mass data processing." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-print-action.render", + "value": "RenderExtension<\n PrintActionExtensionApi<'admin.product-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >", + "description": "A print action target that appears in the **Print** menu on the product index page when multiple products are selected. Use this to generate batch documents such as combined product labels, barcode sheets, or catalog pages." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-index.selection-print-action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-purchase-option.action.render", + "value": "RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-purchase-option.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **Purchase Options** card on the product details page when a selling plan group is present. Use this to create workflows for subscription management, selling plan configuration, or purchase option operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.action.render", + "value": "RenderExtension<\n ActionExtensionApi<'admin.product-variant-details.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **More actions** menu on the product variant details page. Use this to create workflows for variant management, inventory operations, or data synchronization." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.action.should-render", + "value": "RunnableExtension<\n ShouldRenderApi<'admin.product-variant-details.action.should-render'>,\n ShouldRenderOutput\n >", + "description": "A non-rendering target that controls whether the product variant details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on variant properties, user permissions, or external data." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.block.render", + "value": "RenderExtension<\n BlockExtensionApi<'admin.product-variant-details.block.render'>,\n BlockExtensionComponents\n >", + "description": "A block target that displays inline content within the product variant details page. Use this to show variant-specific data, inventory tools, or variant configuration options." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-details.configuration.render", + "value": "RenderExtension<\n ProductVariantDetailsConfigurationApi<'admin.product-variant-details.configuration.render'>,\n BlockExtensionComponents\n >", + "description": "A configuration target that renders product variant configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product variant details page. Use this to define variant-specific bundle components, customization options, or configuration rules." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.product-variant-purchase-option.action.render", + "value": "RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-variant-purchase-option.action.render'>,\n ActionExtensionComponents\n >", + "description": "An action target that appears in the **Purchase Options** card on the product variant details page when a selling plan group is present. Use this to create workflows for variant-specific subscription management, selling plan configuration, or purchase option operations." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.settings.internal-order-routing-rule.render", + "value": "RenderExtension<\n OrderRoutingRuleApi<'admin.settings.internal-order-routing-rule.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.settings.order-routing-rule.render", + "value": "RenderExtension<\n OrderRoutingRuleApi<'admin.settings.order-routing-rule.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions. Use this to build custom configuration interfaces for order routing function parameters." + }, + { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "admin.settings.validation.render", + "value": "RenderExtension<\n ValidationSettingsApi<'admin.settings.validation.render'>,\n FunctionSettingsComponents\n >", + "description": "A function settings target that renders within a validation's add and edit views, allowing merchants to configure validation function settings. Use this to build custom configuration interfaces for validation function parameters and rules." + } + ], + "value": "export interface ExtensionTargets {\n /**\n * A runnable target that provides [customer segment templates](/docs/apps/build/marketing-analytics/customer-segments/build-a-template-extension) in the [customer segment editor](https://help.shopify.com/manual/customers/customer-segmentation/create-customer-segments). Use this target to provide pre-built segment templates that merchants can use as starting points for creating targeted customer groups based on custom criteria.\n */\n 'admin.customers.segmentation-templates.data': RunnableExtension<\n CustomerSegmentTemplateApi<'admin.customers.segmentation-templates.data'>,\n {templates: CustomerSegmentTemplate[]}\n >;\n\n // Blocks\n /**\n * A block target that displays inline content within the product details page. Use this to show product-specific information, tools, or actions directly on the product page.\n */\n 'admin.product-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.product-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the order details page. Use this to show order-specific information, fulfillment tools, or custom order actions.\n */\n 'admin.order-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.order-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A function settings target that appears when merchants create or edit a discount powered by your discount function, allowing them to configure function-specific settings. Use this to build custom configuration interfaces for discount function parameters.\n */\n 'admin.discount-details.function-settings.render': RenderExtension<\n DiscountFunctionSettingsApi<'admin.discount-details.function-settings.render'>,\n FunctionSettingsComponents\n >;\n\n /**\n * A block target that displays inline content within the customer details page. Use this to show customer-specific information, loyalty data, or custom customer actions.\n */\n 'admin.customer-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.customer-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the collection details page. Use this to show collection analytics, bulk product operations, or collection-specific tools.\n */\n 'admin.collection-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.collection-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the draft order details page. Use this to show custom pricing calculations, special order handling tools, or order-specific information.\n */\n 'admin.draft-order-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.draft-order-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the abandoned checkout details page. Use this to show cart recovery tools, abandonment analysis, or customer re-engagement options.\n */\n 'admin.abandoned-checkout-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.abandoned-checkout-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the catalog details page. Use this to show catalog-specific settings, market information, or synchronization tools.\n */\n 'admin.catalog-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.catalog-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the company details page. Use this to show B2B customer information, credit limits, or company-specific data.\n */\n 'admin.company-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.company-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the company location details page. Use this to show location-specific information, shipping preferences, or location management tools.\n */\n 'admin.company-location-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.company-location-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the gift card details page. Use this to show gift card balance tracking, usage history, or custom gift card metadata.\n */\n 'admin.gift-card-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.gift-card-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that displays inline content within the product variant details page. Use this to show variant-specific data, inventory tools, or variant configuration options.\n */\n 'admin.product-variant-details.block.render': RenderExtension<\n BlockExtensionApi<'admin.product-variant-details.block.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A block target that provides custom reordering functionality on the product details page. Use this to help merchants rearrange product data.\n */\n 'admin.product-details.reorder.render': RenderExtension<\n BlockExtensionApi<'admin.product-details.reorder.render'>,\n BlockExtensionComponents\n >;\n\n // Actions\n /**\n * An action target that appears in the **More actions** menu on the product details page. Use this to create workflows for processing products, syncing data, or integrating with external systems.\n */\n 'admin.product-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.product-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the catalog details page. Use this to create workflows for catalog management, market synchronization, or data exports.\n */\n 'admin.catalog-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.catalog-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the company details page. Use this to create workflows for B2B customer management, credit operations, or company data synchronization.\n */\n 'admin.company-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.company-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the gift card details page. Use this to create workflows for gift card processing, balance adjustments, or custom gift card operations.\n */\n 'admin.gift-card-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.gift-card-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the order details page. Use this to create workflows for order processing, fulfillment operations, or external system integrations.\n */\n 'admin.order-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.order-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the customer details page. Use this to create workflows for customer data management, loyalty operations, or CRM integrations.\n */\n 'admin.customer-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears from the **Use segment** button on the customer segment details page. Use this to create workflows for marketing campaigns, email operations, or segment-based actions.\n */\n 'admin.customer-segment-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-segment-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the product index page. Use this to create workflows for product management, catalog operations, or inventory synchronization.\n */\n 'admin.product-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.product-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the order index page. Use this to create workflows for order management, reporting, or fulfillment operations.\n */\n 'admin.order-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.order-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the customer index page. Use this to create workflows for customer management, marketing operations, or bulk data processing.\n */\n 'admin.customer-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the discount index page. Use this to create workflows for discount management, promotional operations, or bulk discount updates.\n */\n 'admin.discount-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.discount-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the collection details page. Use this to create workflows for collection management, product operations, or merchandising tools.\n */\n 'admin.collection-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.collection-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the collection index page. Use this to create workflows for collection management, bulk operations, or catalog organization.\n */\n 'admin.collection-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.collection-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the abandoned checkout details page. Use this to create workflows for cart recovery, customer engagement, or checkout analysis.\n */\n 'admin.abandoned-checkout-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the abandoned checkout index page. Use this to create workflows for cart recovery, bulk customer engagement, or checkout analysis across multiple abandoned carts.\n */\n 'admin.abandoned-checkout-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.abandoned-checkout-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the product variant details page. Use this to create workflows for variant management, inventory operations, or data synchronization.\n */\n 'admin.product-variant-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.product-variant-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the draft order details page. Use this to create workflows for draft order processing, custom pricing, or order preparation tools.\n */\n 'admin.draft-order-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.draft-order-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the draft order index page. Use this to create workflows for draft order management, bulk operations, or order conversion tools.\n */\n 'admin.draft-order-index.action.render': RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the discount details page. Use this to create workflows for discount management, promotion analysis, or discount synchronization.\n */\n 'admin.discount-details.action.render': RenderExtension<\n ActionExtensionApi<'admin.discount-details.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the actions menu inside the order fulfilled card, visible only on orders fulfilled by your app. Use this to create workflows for fulfillment operations, tracking updates, or post-fulfillment actions.\n */\n 'admin.order-fulfilled-card.action.render': RenderExtension<\n ActionExtensionApi<'admin.order-fulfilled-card.action.render'>,\n ActionExtensionComponents\n >;\n\n // Bulk Actions\n\n /**\n * A selection action target that appears in the **More actions** menu on the product index page when multiple products are selected. Use this to create workflows for bulk product operations, batch updates, or mass data processing.\n */\n 'admin.product-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.product-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * A selection action target that appears in the **More actions** menu on the order index page when multiple orders are selected. Use this to create workflows for bulk order operations, batch fulfillment, or mass order processing.\n */\n 'admin.order-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.order-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * A selection action target that appears in the **More actions** menu on the customer index page when multiple customers are selected. Use this to create workflows for bulk customer operations, mass email campaigns, or batch data updates.\n */\n 'admin.customer-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.customer-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **More actions** menu on the discount index page when multiple discounts are selected. Use this to create workflows for bulk discount operations or batch data updates.\n */\n 'admin.discount-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.discount-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * A selection action target that appears in the **More actions** menu on the draft order index page when multiple draft orders are selected. Use this to create workflows for bulk draft order operations, batch conversions, or mass order processing.\n */\n 'admin.draft-order-index.selection-action.render': RenderExtension<\n ActionExtensionApi<'admin.draft-order-index.selection-action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **Purchase Options** card on the product details page when a selling plan group is present. Use this to create workflows for subscription management, selling plan configuration, or purchase option operations.\n */\n 'admin.product-purchase-option.action.render': RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-purchase-option.action.render'>,\n ActionExtensionComponents\n >;\n\n /**\n * An action target that appears in the **Purchase Options** card on the product variant details page when a selling plan group is present. Use this to create workflows for variant-specific subscription management, selling plan configuration, or purchase option operations.\n */\n 'admin.product-variant-purchase-option.action.render': RenderExtension<\n PurchaseOptionsCardConfigurationApi<'admin.product-variant-purchase-option.action.render'>,\n ActionExtensionComponents\n >;\n\n // Print actions and bulk print actions\n\n /**\n * A print action target that appears in the **Print** menu on the order details page. Use this to generate custom documents such as packing slips, shipping labels, or invoices.\n */\n 'admin.order-details.print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.order-details.print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n /**\n * A print action target that appears in the **Print** menu on the product details page. Use this to generate custom documents such as product labels, barcode sheets, or specification sheets.\n */\n 'admin.product-details.print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.product-details.print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n /**\n * A print action target that appears in the **Print** menu on the order index page when multiple orders are selected. Use this to generate batch documents such as combined packing slips, shipping manifests, or bulk invoices.\n */\n 'admin.order-index.selection-print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.order-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n /**\n * A print action target that appears in the **Print** menu on the product index page when multiple products are selected. Use this to generate batch documents such as combined product labels, barcode sheets, or catalog pages.\n */\n 'admin.product-index.selection-print-action.render': RenderExtension<\n PrintActionExtensionApi<'admin.product-index.selection-print-action.render'>,\n PrintActionExtensionComponents\n >;\n\n // Other\n\n /**\n * A configuration target that renders product configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product details page. Use this to define bundle component selections, customization options, or product configuration rules.\n */\n 'admin.product-details.configuration.render': RenderExtension<\n ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A configuration target that renders product variant configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product variant details page. Use this to define variant-specific bundle components, customization options, or configuration rules.\n */\n 'admin.product-variant-details.configuration.render': RenderExtension<\n ProductVariantDetailsConfigurationApi<'admin.product-variant-details.configuration.render'>,\n BlockExtensionComponents\n >;\n\n /**\n * A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions.\n * @private\n */\n 'admin.settings.internal-order-routing-rule.render': RenderExtension<\n OrderRoutingRuleApi<'admin.settings.internal-order-routing-rule.render'>,\n FunctionSettingsComponents\n >;\n /**\n * A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions. Use this to build custom configuration interfaces for order routing function parameters.\n */\n 'admin.settings.order-routing-rule.render': RenderExtension<\n OrderRoutingRuleApi<'admin.settings.order-routing-rule.render'>,\n FunctionSettingsComponents\n >;\n\n /**\n * A function settings target that renders within a validation's add and edit views, allowing merchants to configure validation function settings. Use this to build custom configuration interfaces for validation function parameters and rules.\n */\n 'admin.settings.validation.render': RenderExtension<\n ValidationSettingsApi<'admin.settings.validation.render'>,\n FunctionSettingsComponents\n >;\n\n // Admin action shouldRender targets\n /**\n * A non-rendering target that controls whether the product details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on product properties, user permissions, or external data.\n */\n 'admin.product-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the catalog details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on catalog properties, user permissions, or external data.\n */\n 'admin.catalog-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.catalog-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the company details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on company properties, user permissions, or external data.\n */\n 'admin.company-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.company-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the gift card details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on gift card properties, user permissions, or external data.\n */\n 'admin.gift-card-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.gift-card-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on order properties, fulfillment status, or external data.\n */\n 'admin.order-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on customer properties, user permissions, or external data.\n */\n 'admin.customer-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer segment details action appears from the **Use segment** button. Use this to conditionally show or hide your action based on segment properties, user permissions, or external data.\n */\n 'admin.customer-segment-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-segment-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.product-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.order-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.customer-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the discount index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.discount-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.discount-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the collection details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on collection properties, user permissions, or external data.\n */\n 'admin.collection-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.collection-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the collection index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.collection-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.collection-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the abandoned checkout details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on checkout properties, user permissions, or external data.\n */\n 'admin.abandoned-checkout-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the abandoned checkout index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.abandoned-checkout-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.abandoned-checkout-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product variant details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on variant properties, user permissions, or external data.\n */\n 'admin.product-variant-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-variant-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the draft order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on draft order properties, user permissions, or external data.\n */\n 'admin.draft-order-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.draft-order-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the draft order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data.\n */\n 'admin.draft-order-index.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the discount details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on discount properties, user permissions, or external data.\n */\n 'admin.discount-details.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.discount-details.action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order fulfilled card action appears in the actions menu. Use this to conditionally show or hide your action based on fulfillment properties, user permissions, or external data.\n */\n 'admin.order-fulfilled-card.action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-fulfilled-card.action.should-render'>,\n ShouldRenderOutput\n >;\n\n // Admin bulk action shouldRender targets\n\n /**\n * A non-rendering target that controls whether the product index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.product-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.order-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the customer index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.customer-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.customer-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the discount index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.discount-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.discount-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the draft order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data.\n */\n 'admin.draft-order-index.selection-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.draft-order-index.selection-action.should-render'>,\n ShouldRenderOutput\n >;\n\n // Admin print action and bulk print action shouldRender targets\n\n /**\n * A non-rendering target that controls whether the order details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on order properties, user permissions, or external data.\n */\n 'admin.order-details.print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-details.print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on product properties, user permissions, or external data.\n */\n 'admin.product-details.print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-details.print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the order index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data.\n */\n 'admin.order-index.selection-print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.order-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A non-rendering target that controls whether the product index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data.\n */\n 'admin.product-index.selection-print-action.should-render': RunnableExtension<\n ShouldRenderApi<'admin.product-index.selection-print-action.should-render'>,\n ShouldRenderOutput\n >;\n\n /**\n * A runnable target that enables your app to expose data to [Sidekick](/docs/apps/build/sidekick/build-app-data). Use this target to register tools that Sidekick can invoke to search your app's data and answer merchant questions.\n */\n 'admin.app.tools.data': RunnableExtension<\n StandardApi<'admin.app.tools.data'>,\n undefined\n >;\n\n /**\n * Renders an admin extension for handling app intents.\n */\n 'admin.app.intent.render': RenderExtension<\n IntentRenderApi<'admin.app.intent.render'>,\n FormExtensionComponents\n >;\n\n /**\n * Renders an admin extension on the app home page.\n */\n 'admin.app.home.render': RenderExtension<\n AppHomeApi<'admin.app.home.render'>,\n FormExtensionComponents | 'Modal' | 'Page' | 'AppNav'\n >;\n}" + } + }, + "RenderExtension": { + "src/extension.ts": { + "filePath": "src/extension.ts", + "name": "RenderExtension", + "description": "Defines the structure of a render extension, which displays UI in the Shopify admin.", + "members": [ + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "api", + "value": "Api", + "description": "The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "components", + "value": "ComponentsSet", + "description": "The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "output", + "value": "void | Promise", + "description": "The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads." + } + ], + "value": "export interface RenderExtension {\n /**\n * The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying.\n */\n api: Api;\n /**\n * The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target.\n */\n components: ComponentsSet;\n /**\n * The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads.\n */\n output: void | Promise;\n}" + } + }, + "ActionExtensionApi": { + "src/surfaces/admin/api/action/action.ts": { + "filePath": "src/surfaces/admin/api/action/action.ts", + "name": "ActionExtensionApi", + "description": "The `ActionExtensionApi` object provides methods for action extensions that render in modal overlays. Access the following properties on the `ActionExtensionApi` object to interact with the current context, control the modal, and display picker dialogs.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "close", + "value": "() => void", + "description": "Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/action/action.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ActionExtensionApi\n extends StandardRenderingExtensionApi {\n /**\n * Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner.\n */\n close: () => void;\n\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.\n */\n data: Data;\n}" + } + }, + "Auth": { + "src/surfaces/admin/api/standard/standard.ts": { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "name": "Auth", + "description": "The `Auth` object provides authentication methods for secure communication with your app backend.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "idToken", + "value": "() => Promise", + "description": "Retrieves a [Shopify OpenID Connect ID token](/docs/api/app-home/apis/id-token) for the current user. Use this token to authenticate requests to your app backend and verify the user's identity. The token is a signed JWT that contains user information and can be validated using Shopify's public keys. Returns `null` if the token can't be retrieved." + } + ], + "value": "export interface Auth {\n /**\n * Retrieves a [Shopify OpenID Connect ID token](/docs/api/app-home/apis/id-token) for the current user. Use this token to authenticate requests to your app backend and verify the user's identity. The token is a signed JWT that contains user information and can be validated using Shopify's public keys. Returns `null` if the token can't be retrieved.\n */\n idToken: () => Promise;\n}" + } + }, + "ExtensionTarget": { + "src/surfaces/admin/extension-targets.ts": { + "filePath": "src/surfaces/admin/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionTarget", + "value": "keyof ExtensionTargets", + "description": "A string literal union of all valid extension target identifiers. Use this type to specify where your admin UI extension should render, such as `admin.product-details.block.render` for a block on product details pages or `admin.order-details.action.render` for an action on order details pages. The target determines the extension's location, available APIs, and UI components." + } + }, + "I18n": { + "src/api.ts": { + "filePath": "src/api.ts", + "name": "I18n", + "description": "Internationalization utilities for formatting and translating content according to the user's locale. Use these methods to display numbers, currency, dates, and translated strings that match the merchant's language and regional preferences.", + "members": [ + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "formatCurrency", + "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", + "description": "Returns a localized currency value formatted according to the user's locale and currency conventions. Use this to display prices, totals, or financial amounts in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. Uses the current user's locale by default." + }, + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "formatDate", + "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", + "description": "Returns a localized date value formatted according to the user's locale and date conventions. Use this to display dates and times in the appropriate format for the merchant's region, such as order dates, timestamps, or schedule information. This function behaves like the standard `Intl.DateTimeFormat()` and uses the current user's locale by default. Formatting options can be passed to customize the date display style." + }, + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "formatNumber", + "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", + "description": "Returns a localized number formatted according to the user's locale. Use this to display numbers like quantities, percentages, or measurements in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. Uses the current user's locale by default." + }, + { + "filePath": "src/api.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "I18nTranslate", + "description": "Returns translated content in the user's locale, as supported by the extension. Use this to display localized strings from your extension's locale files. The special `options.count` property enables pluralization. Other option keys and values are treated as replacements for interpolation in your translation strings. Returns a single string when replacements are primitives, or an array when replacements contain UI components." + } + ], + "value": "export interface I18n {\n /**\n * Returns a localized number formatted according to the user's locale. Use this to display numbers like quantities, percentages, or measurements in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. Uses the current user's locale by default.\n *\n * @param number - The number to format\n * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale\n * @param options - Additional Intl.NumberFormatOptions for customizing the number format\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value formatted according to the user's locale and currency conventions. Use this to display prices, totals, or financial amounts in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. Uses the current user's locale by default.\n *\n * @param number - The currency amount to format\n * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale\n * @param options - Additional Intl.NumberFormatOptions for customizing the currency format, such as the currency code\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value formatted according to the user's locale and date conventions. Use this to display dates and times in the appropriate format for the merchant's region, such as order dates, timestamps, or schedule information. This function behaves like the standard `Intl.DateTimeFormat()` and uses the current user's locale by default. Formatting options can be passed to customize the date display style.\n *\n * @param date - The Date object to format\n * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale\n * @param options - Additional Intl.DateTimeFormatOptions for customizing the date format\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat\n * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the user's locale, as supported by the extension. Use this to display localized strings from your extension's locale files. The special `options.count` property enables pluralization. Other option keys and values are treated as replacements for interpolation in your translation strings. Returns a single string when replacements are primitives, or an array when replacements contain UI components.\n */\n translate: I18nTranslate;\n}" + } + }, + "I18nTranslate": { + "src/api.ts": { + "filePath": "src/api.ts", + "name": "I18nTranslate", + "description": "The translation function signature for internationalization. Use this to translate string keys defined in your locale files into localized content for the current user's language.", + "members": [], + "value": "export interface I18nTranslate {\n /**\n * Returns a translated string matching a key in a locale file. Use this to display localized text in your extension based on the merchant's language preferences. Supports interpolation with replacement values and pluralization with the `count` option. Returns a string when replacements are primitives, or an array when replacements include UI components.\n *\n * @param key - The translation key from your locale file (for example, \"banner.title\")\n * @param options - Optional replacement values for interpolation or the special `count` property for pluralization\n *\n * @example translate(\"banner.title\")\n * @example translate(\"items.count\", { count: 5 })\n */\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" + } + }, + "Intents": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "Intents", + "description": "The `Intents` object provides methods for launching standardized Shopify workflows to create or edit resources. Intents enable your extension to trigger native admin interfaces for products, customers, discounts, and other resources, then receive the results when merchants complete the workflow.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "invoke", + "value": "IntentInvokeApi", + "description": "Launches an intent workflow for creating or editing Shopify resources. Returns a handle that resolves when the merchant completes, cancels, or encounters an error in the workflow. Use this to initiate resource creation or editing without building custom forms.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "launchUrl", + "value": "string | URL", + "description": "The URL that launched the current intent workflow, if your extension was opened through an intent. Use this to determine how your extension was invoked and access any parameters passed in the URL.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "response", + "value": "IntentResponseApi", + "description": "Resolves the current intent from within an invoked extension. This property is only present when your extension is running inside an intent workflow.", + "isOptional": true + } + ], + "value": "export interface Intents {\n /**\n * Resolves the current intent from within an invoked extension. This property is only present when your extension is running inside an intent workflow.\n */\n response?: IntentResponseApi;\n\n /**\n * The URL that launched the current intent workflow, if your extension was opened through an intent. Use this to determine how your extension was invoked and access any parameters passed in the URL.\n */\n launchUrl?: string | URL;\n /**\n * Launches an intent workflow for creating or editing Shopify resources. Returns a handle that resolves when the merchant completes, cancels, or encounters an error in the workflow. Use this to initiate resource creation or editing without building custom forms.\n */\n invoke?: IntentInvokeApi;\n}" + } + }, + "IntentInvokeApi": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentInvokeApi", + "description": "The [`invoke` method](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/intents-api#invoke-method) in the Intents API launches a Shopify admin workflow for creating, editing, or picking resources, such as products, customers, or files. It opens a native admin interface, waits for the merchant to complete the workflow, and returns the result including any created, updated, or selected resource data.", + "isPublicDocs": true, + "members": [], + "value": "export interface IntentInvokeApi {\n (query: IntentQuery): Promise;\n (intentURL: string, options?: IntentQueryOptions): Promise;\n}" + } + }, + "IntentResponseApi": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentResponseApi", + "description": "The `IntentResponseApi` object provides methods for resolving the current intent from within an invoked extension. This API is only present when your extension is running inside an intent workflow.", + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "MethodSignature", + "name": "closed", + "value": "() => Promise", + "description": "Resolves the current intent as closed without completing the workflow." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "MethodSignature", + "name": "error", + "value": "(message: string, issues?: Issue[]) => Promise", + "description": "Resolves the current intent with an error. Use `issues` to provide field-specific validation details when available." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "MethodSignature", + "name": "ok", + "value": "(data?: { [key: string]: unknown; }) => Promise", + "description": "Resolves the current intent successfully. Pass output data when your intent defines a response schema." + } + ], + "value": "export interface IntentResponseApi {\n /**\n * Resolves the current intent successfully. Pass output data when your intent defines a response schema.\n */\n ok(data?: SuccessIntentResponse['data']): Promise;\n\n /**\n * Resolves the current intent with an error. Use `issues` to provide field-specific validation details when available.\n */\n error(message: string, issues?: Issue[]): Promise;\n\n /**\n * Resolves the current intent as closed without completing the workflow.\n */\n closed(): Promise;\n}" + } + }, + "Issue": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "Issue", + "description": "A structured issue describing a validation or workflow error.", + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A machine-readable error code for this issue. Use this for programmatic error handling or logging.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A description of what's wrong with this field. Display this to help merchants understand how to fix the error.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "path", + "value": "string[]", + "description": "The path to the field that has an error (for example, `['product', 'title']`). Use this to identify which field caused the validation failure.", + "isOptional": true + } + ], + "value": "export interface Issue {\n /** The path to the field that has an error (for example, `['product', 'title']`). Use this to identify which field caused the validation failure. */\n path?: string[];\n /** A description of what's wrong with this field. Display this to help merchants understand how to fix the error. */\n message?: string;\n /** A machine-readable error code for this issue. Use this for programmatic error handling or logging. */\n code?: string;\n}" + } + }, + "PickerApi": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "PickerApi", + "description": "The `picker` function opens a custom selection dialog with your app-specific data. It accepts configuration options to define the picker's heading, items, headers, and selection behavior. It returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.", + "isPublicDocs": true, + "params": [ + { + "name": "options", + "description": "", + "value": "PickerOptions", + "filePath": "src/surfaces/admin/api/picker/picker.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "description": "", + "name": "Promise", + "value": "Promise" + }, + "value": "(options: PickerOptions) => Promise" + } + }, + "PickerOptions": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "PickerOptions", + "description": "The configuration options for the custom picker dialog. Define the picker's appearance, selection behavior, and data structure.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "headers", + "value": "Header[]", + "description": "The column headers for the picker table. Define headers to label and organize the data columns displayed for each item. The header order determines the column layout.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading displayed at the top of the picker modal. Use a clear, descriptive title that tells merchants what they're selecting." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "items", + "value": "Item[]", + "description": "The list of items that merchants can select from. Each item appears as a row in the picker table." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean | number", + "description": "The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `3` allows up to three items).", + "isOptional": true + } + ], + "value": "export interface PickerOptions {\n /**\n * The heading displayed at the top of the picker modal. Use a clear, descriptive title that tells merchants what they're selecting.\n */\n heading: string;\n /**\n * The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `3` allows up to three items).\n */\n multiple?: boolean | number;\n /**\n * The list of items that merchants can select from. Each item appears as a row in the picker table.\n */\n items: Item[];\n /**\n * The column headers for the picker table. Define headers to label and organize the data columns displayed for each item. The header order determines the column layout.\n */\n headers?: Header[];\n}" + } + }, + "Header": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "Header", + "description": "The configuration for a table column header in the picker. Each header creates a labeled column that displays corresponding data from items.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The label text displayed at the top of the table column. Use clear, concise labels that describe the data in that column (for example, \"Price\", \"Status\", \"Last Updated\").", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'string' | 'number'", + "description": "The data type that controls column formatting and text alignment. Use `'number'` for currency, prices, or numeric values (displays right-aligned), or `'string'` for text content (displays left-aligned).", + "isOptional": true, + "defaultValue": "'string'" + } + ], + "value": "export interface Header {\n /**\n * The label text displayed at the top of the table column. Use clear, concise labels that describe the data in that column (for example, \"Price\", \"Status\", \"Last Updated\").\n */\n content?: string;\n /**\n * The data type that controls column formatting and text alignment. Use `'number'` for currency, prices, or numeric values (displays right-aligned), or `'string'` for text content (displays left-aligned).\n * @defaultValue 'string'\n */\n type?: 'string' | 'number';\n}" + } + }, + "Item": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "Item", + "description": "An individual item that merchants can select in the picker. Each item appears as a row in the picker table.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "badges", + "value": "PickerBadge[]", + "description": "Status or context badges displayed next to the heading in the first column. Use badges to highlight item state, completion status, or other important attributes (for example, \"Draft\", \"Published\", \"Incomplete\").", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "DataPoint[]", + "description": "Additional data displayed in subsequent columns after the heading. Each value appears in its own column, and the order must match the `headers` array. For example, if headers are `[\"Price\", \"Status\"]`, then data would be `[19.99, \"Active\"]`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the item can be selected. When `true`, the item is disabled and can't be selected. Disabled items appear grayed out and merchants can't choose them. Use this for items that are unavailable or don't meet selection criteria.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The primary text displayed in the first column. This is typically the item's name or title and is the most prominent text in the row." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique identifier for this item. This ID is returned in the selection array when the merchant selects this item. Use an ID that helps you identify the item in your system (for example, template IDs, review IDs, or custom option keys)." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the item is preselected when the picker opens. When `true`, the item appears selected by default. Merchants can still deselect preselected items. Use this to show current selections or suggest default choices.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "thumbnail", + "value": "{ url: string; }", + "description": "A small preview image or icon displayed at the start of the row. Thumbnails help merchants visually identify items at a glance. Provide a URL to the image file.", + "isOptional": true + } + ], + "value": "export interface Item {\n /**\n * The unique identifier for this item. This ID is returned in the selection array when the merchant selects this item. Use an ID that helps you identify the item in your system (for example, template IDs, review IDs, or custom option keys).\n */\n id: string;\n /**\n * The primary text displayed in the first column. This is typically the item's name or title and is the most prominent text in the row.\n */\n heading: string;\n /**\n * Additional data displayed in subsequent columns after the heading. Each value appears in its own column, and the order must match the `headers` array. For example, if headers are `[\"Price\", \"Status\"]`, then data would be `[19.99, \"Active\"]`.\n */\n data?: DataPoint[];\n /**\n * Whether the item can be selected. When `true`, the item is disabled and can't be selected. Disabled items appear grayed out and merchants can't choose them. Use this for items that are unavailable or don't meet selection criteria.\n * @defaultValue false\n */\n disabled?: boolean;\n /**\n * Whether the item is preselected when the picker opens. When `true`, the item appears selected by default. Merchants can still deselect preselected items. Use this to show current selections or suggest default choices.\n */\n selected?: boolean;\n /**\n * Status or context badges displayed next to the heading in the first column. Use badges to highlight item state, completion status, or other important attributes (for example, \"Draft\", \"Published\", \"Incomplete\").\n */\n badges?: PickerBadge[];\n /**\n * A small preview image or icon displayed at the start of the row. Thumbnails help merchants visually identify items at a glance. Provide a URL to the image file.\n */\n thumbnail?: {url: string};\n}" + } + }, + "PickerBadge": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "PickerBadge", + "description": "A badge displayed next to an item in the picker to show status or progress. Use badges to highlight important item attributes or states that affect selection decisions.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The text content of the badge. Keep this short and descriptive (for example, \"Draft\", \"Active\", \"Incomplete\")." + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "progress", + "value": "Progress", + "description": "The progress indicator for the badge. Use this to show completion status for items that have progress states.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "Tone", + "description": "The visual tone indicating status or importance. Choose a tone that matches the badge's meaning.", + "isOptional": true + } + ], + "value": "export interface PickerBadge {\n /** The text content of the badge. Keep this short and descriptive (for example, \"Draft\", \"Active\", \"Incomplete\"). */\n content: string;\n /** The visual tone indicating status or importance. Choose a tone that matches the badge's meaning. */\n tone?: Tone;\n /** The progress indicator for the badge. Use this to show completion status for items that have progress states. */\n progress?: Progress;\n}" + } + }, + "Progress": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Progress", + "value": "'incomplete' | 'partiallyComplete' | 'complete'", + "description": "The progress state for picker badges showing completion status. Use this to indicate how complete an item is: `'incomplete'` for not started, `'partiallyComplete'` for in progress, or `'complete'` for finished.", + "isPublicDocs": true + } + }, + "Tone": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Tone", + "value": "'info' | 'success' | 'warning' | 'critical'", + "description": "The visual tone for picker badges indicating status or importance. Use different tones to communicate urgency or state: `'info'` for neutral information, `'success'` for positive states, `'warning'` for caution, or `'critical'` for urgent issues.", + "isPublicDocs": true + } + }, + "DataPoint": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DataPoint", + "value": "string | number | undefined", + "description": "A single data point that can appear in a picker table cell. Can be text, a number, or undefined if the cell should be empty.", + "isPublicDocs": true + } + }, + "Picker": { + "src/surfaces/admin/api/picker/picker.ts": { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "name": "Picker", + "description": "A handle returned when opening a picker dialog. Use this to access the merchant's selection after they confirm or cancel the picker.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/picker/picker.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "Promise", + "description": "A Promise that resolves with an array of selected item IDs when the merchant presses the **Select** button, or `undefined` if they cancel. Await this Promise to handle the selection result." + } + ], + "value": "export interface Picker {\n /**\n * A Promise that resolves with an array of selected item IDs when the merchant presses the **Select** button, or `undefined` if they cancel. Await this Promise to handle the selection result.\n */\n selected: Promise;\n}" + } + }, + "ApiVersion": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ApiVersion", + "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04' | '2026-07'", + "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." + } + }, + "ResourcePickerApi": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ResourcePickerApi", + "description": "Opens the resource picker modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel.", + "isPublicDocs": true, + "params": [ + { + "name": "options", + "description": "", + "value": "ResourcePickerOptions", + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "description": "", + "name": "Promise | undefined>", + "value": "Promise | undefined>" + }, + "value": "(\n options: ResourcePickerOptions,\n) => Promise | undefined>" + } + }, + "ResourcePickerOptions": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ResourcePickerOptions", + "description": "The `ResourcePickerOptions` object defines how the resource picker behaves, including which resource type to display, selection limits, filters, and preselected items. Access the following properties on the `ResourcePickerOptions` object to configure the resource picker's appearance and functionality.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "'add' | 'select'", + "description": "The action verb that appears in the picker's title and primary button. Use `'add'` for actions that add new items (for example, \"Add products\") or `'select'` for choosing existing items (for example, \"Select products\"). This helps merchants understand the picker's purpose.", + "isOptional": true, + "defaultValue": "'add'" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "filter", + "value": "Filters", + "description": "Filtering options that control which resources appear in the picker. Use filters to restrict resources by publication status, include or exclude variants, or apply custom search criteria. This helps merchants find relevant items faster.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean | number", + "description": "The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `5` allows up to five items). When `type` is `'product'`, merchants can still select multiple variants from a single product even if `multiple` is `false`.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "string", + "description": "An initial search query that appears in the picker's search bar when it opens. Merchants can see and edit this query. See [search syntax](/docs/api/usage/search-syntax) for the query format. For most use cases, use `filter.query` instead, which filters results without exposing the query to merchants.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "selectionIds", + "value": "BaseResource[]", + "description": "Resources that should be preselected when the picker opens. Pass an array of resource objects with IDs (and optional variant IDs) to show which items are already selected. Merchants can deselect these preselected items. Use this to show current selections or default choices.", + "isOptional": true, + "defaultValue": "[]" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'product' | 'variant' | 'collection'", + "description": "The type of Shopify resource to select: `'product'` for products, `'variant'` for specific product variants, or `'collection'` for collections. This determines what appears in the picker and what data structure is returned." + } + ], + "value": "export interface ResourcePickerOptions {\n /**\n * The type of Shopify resource to select: `'product'` for products, `'variant'` for specific product variants, or `'collection'` for collections. This determines what appears in the picker and what data structure is returned.\n */\n type: 'product' | 'variant' | 'collection';\n /**\n * The action verb that appears in the picker's title and primary button. Use `'add'` for actions that add new items (for example, \"Add products\") or `'select'` for choosing existing items (for example, \"Select products\"). This helps merchants understand the picker's purpose.\n * @defaultValue 'add'\n */\n action?: 'add' | 'select';\n /**\n * Filtering options that control which resources appear in the picker. Use filters to restrict resources by publication status, include or exclude variants, or apply custom search criteria. This helps merchants find relevant items faster.\n */\n filter?: Filters;\n /**\n * The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `5` allows up to five items). When `type` is `'product'`, merchants can still select multiple variants from a single product even if `multiple` is `false`.\n * @defaultValue false\n */\n multiple?: boolean | number;\n /**\n * An initial search query that appears in the picker's search bar when it opens. Merchants can see and edit this query. See [search syntax](/docs/api/usage/search-syntax) for the query format. For most use cases, use `filter.query` instead, which filters results without exposing the query to merchants.\n * @defaultValue ''\n */\n query?: string;\n /**\n * Resources that should be preselected when the picker opens. Pass an array of resource objects with IDs (and optional variant IDs) to show which items are already selected. Merchants can deselect these preselected items. Use this to show current selections or default choices.\n * @defaultValue []\n */\n selectionIds?: BaseResource[];\n}" + } + }, + "Filters": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Filters", + "description": "Filter options that control which resources appear in the resource picker. Use filters to restrict the available resources based on publication status, resource type, or custom search criteria.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "archived", + "value": "boolean | undefined", + "description": "Whether to include archived products in the picker. When `false`, archived products are hidden. When `undefined`, archived products appear with an archived badge. Only applies when `type` is `'product'`. Use this to prevent selecting discontinued products.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "draft", + "value": "boolean | undefined", + "description": "Whether to include draft products in the picker. When `false`, draft products are hidden. When `undefined`, draft products appear with a draft badge. Only applies when `type` is `'product'`. Use this to prevent selecting products that aren't ready for use.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Whether to include products that aren't published on any sales channels. When `false`, only products published to at least one sales channel appear in the picker. Use this to ensure merchants only select products that customers can purchase.", + "isOptional": true, + "defaultValue": "true" + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "string", + "description": "A GraphQL search query that filters the available resources without showing the query in the picker's search bar. Merchants won't see or edit this filter. See [search syntax](/docs/api/usage/search-syntax) for the query format. Use this to programmatically restrict resources based on attributes like tags, vendor, or product type (for example, `\"tag:featured\"` or `\"vendor:Acme\"`).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "variants", + "value": "boolean", + "description": "Whether to show product variants in the picker. When `false`, merchants can only select products, not individual variants. Only applies when `type` is `'product'`. Use this to simplify selection when you only need product-level data.", + "isOptional": true, + "defaultValue": "true" + } + ], + "value": "export interface Filters {\n /**\n * Whether to include products that aren't published on any sales channels. When `false`, only products published to at least one sales channel appear in the picker. Use this to ensure merchants only select products that customers can purchase.\n * @defaultValue true\n */\n hidden?: boolean;\n /**\n * Whether to show product variants in the picker. When `false`, merchants can only select products, not individual variants. Only applies when `type` is `'product'`. Use this to simplify selection when you only need product-level data.\n * @defaultValue true\n */\n variants?: boolean;\n /**\n * Whether to include draft products in the picker. When `false`, draft products are hidden. When `undefined`, draft products appear with a draft badge. Only applies when `type` is `'product'`. Use this to prevent selecting products that aren't ready for use.\n * @defaultValue true\n */\n draft?: boolean | undefined;\n /**\n * Whether to include archived products in the picker. When `false`, archived products are hidden. When `undefined`, archived products appear with an archived badge. Only applies when `type` is `'product'`. Use this to prevent selecting discontinued products.\n * @defaultValue true\n */\n archived?: boolean | undefined;\n /**\n * A GraphQL search query that filters the available resources without showing the query in the picker's search bar. Merchants won't see or edit this filter. See [search syntax](/docs/api/usage/search-syntax) for the query format. Use this to programmatically restrict resources based on attributes like tags, vendor, or product type (for example, `\"tag:featured\"` or `\"vendor:Acme\"`).\n */\n query?: string;\n}" + } + }, + "BaseResource": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "BaseResource", + "description": "A resource structure that can optionally include associated variants. Use this type for specifying preselected items in the resource picker when you need to include variant selections.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The resource identifier in GraphQL global ID format (for example, `gid://shopify/Product/123`)." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "variants", + "value": "Resource[]", + "description": "An array of variant resources to preselect along with the main resource. Only applicable when the main resource is a product that has variants you want to preselect.", + "isOptional": true + } + ], + "value": "export interface BaseResource extends Resource {\n /** An array of variant resources to preselect along with the main resource. Only applicable when the main resource is a product that has variants you want to preselect. */\n variants?: Resource[];\n}" + } + }, + "Resource": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Resource", + "description": "The base resource structure with a unique identifier.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The resource identifier in GraphQL global ID format (for example, `gid://shopify/Product/123`)." + } + ], + "value": "export interface Resource {\n /** The resource identifier in GraphQL global ID format (for example, `gid://shopify/Product/123`). */\n id: string;\n}" + } + }, + "SelectPayload": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SelectPayload", + "value": "SelectPayload", + "description": "The payload returned when resources are selected from the picker.", + "isPublicDocs": true + } + }, + "ActionExtensionComponents": { + "src/surfaces/admin/components/ActionExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/ActionExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActionExtensionComponents", + "value": "StandardComponents | 'AdminAction'", + "description": "The components available for building action extensions. Includes all standard components plus the admin action component required for action extension setup." + } + }, + "StandardComponents": { + "src/surfaces/admin/components/StandardComponents.ts": { + "filePath": "src/surfaces/admin/components/StandardComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "StandardComponents", + "value": "'Avatar' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'ButtonGroup' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ColorField' | 'ColorPicker' | 'DateField' | 'DatePicker' | 'DropZone' | 'Divider' | 'EmailField' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Menu' | 'MoneyField' | 'NumberField' | 'Option' | 'OptionGroup' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'QueryContainer' | 'SearchField' | 'Section' | 'Select' | 'Spinner' | 'Stack' | 'Switch' | 'Table' | 'TableBody' | 'TableCell' | 'TableHeader' | 'TableHeaderRow' | 'TableRow' | 'Text' | 'TextArea' | 'TextField' | 'Thumbnail' | 'Tooltip' | 'UnorderedList' | 'URLField'", + "description": "The standard set of UI components available in most admin extensions. These components provide the building blocks for creating extension interfaces including layout elements, form inputs, data display, navigation, and interactive controls. Use these components to build consistent, accessible UIs that match the Shopify admin design system." + } + }, + "Avatar": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Avatar", + "description": "Configure the following properties on the avatar component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "initials", + "value": "string", + "description": "The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials, such as \"JD\" for John Doe.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The URL or path to the avatar image. When provided, the image takes priority over `initials`. If the image fails to load or loads slowly, `initials` will be rendered as a fallback.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"small-200\" | \"base\" | \"large\" | \"large-200\"", + "description": "The size of the avatar image.\n\n- `small-200`: Extra small avatar, suitable for compact displays or lists with many items.\n- `small`: Small avatar, good for secondary contexts or tight layouts.\n- `base`: Default size that works well in most contexts.\n- `large`: Large avatar for emphasis or when the avatar is a focal point.\n- `large-200`: Extra large avatar for prominent display.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the avatar for accessibility.\n\nProvides a text description of the avatar for users with assistive technology and serves as a fallback when the avatar fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an avatar, it reads this description aloud. When an avatar fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Avatar extends PreactCustomElement implements AvatarProps {\n accessor initials: AvatarProps['initials'];\n accessor src: AvatarProps['src'];\n accessor size: AvatarProps['size'];\n accessor alt: AvatarProps['alt'];\n constructor();\n}" + } + }, + "ClickOptions": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickOptions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "sourceEvent", + "value": "ActivationEventEsque", + "description": "The event you want to influence the synthetic click.", + "isOptional": true + } + ], + "value": "export interface ClickOptions {\n /**\n * The event you want to influence the synthetic click.\n */\n sourceEvent?: ActivationEventEsque;\n}" + } + }, + "ActivationEventEsque": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ActivationEventEsque", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "button", + "value": "number", + "description": "The button number that was pressed on the mouse. 0 for left button, 1 for middle button, 2 for right button." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ctrlKey", + "value": "boolean", + "description": "Whether the Ctrl key was pressed when the event occurred." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "metaKey", + "value": "boolean", + "description": "Whether the Meta/Command key (Mac) or Windows key was pressed when the event occurred." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "shiftKey", + "value": "boolean", + "description": "Whether the Shift key was pressed when the event occurred." + } + ], + "value": "export interface ActivationEventEsque {\n /**\n * Whether the Shift key was pressed when the event occurred.\n */\n shiftKey: boolean;\n /**\n * Whether the Meta/Command key (Mac) or Windows key was pressed when the event occurred.\n */\n metaKey: boolean;\n /**\n * Whether the Ctrl key was pressed when the event occurred.\n */\n ctrlKey: boolean;\n /**\n * The button number that was pressed on the mouse. 0 for left button, 1 for middle button, 2 for right button.\n */\n button: number;\n}" + } + }, + "Badge": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Badge", + "description": "Configure the following properties on the badge component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"strong\"", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `strong`: Increased visual weight for higher emphasis and prominence.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"base\" | \"large\" | \"large-100\"", + "description": "The size of the badge.\n\n- `base`: Default size suitable for most badge use cases.\n- `large`: Larger badge for increased visibility and prominence.\n- `large-100`: Extra large badge for maximum visibility in emphasized contexts.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\" | \"neutral\" | \"caution\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `caution`: Advisory notices that need attention.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Badge extends PreactCustomElement implements BadgeProps {\n accessor color: BadgeProps['color'];\n accessor icon: BadgeProps['icon'];\n accessor size: BadgeProps['size'];\n accessor tone: BadgeProps['tone'];\n constructor();\n}" + } + }, + "Banner": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Banner", + "description": "Configure the following properties on the banner component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the banner.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hidden", + "value": "boolean", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "dismissible", + "value": "boolean", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event fires, then `hidden` is set to `true`, any animation completes, and the `afterhide` event fires.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Banner extends PreactCustomElement implements BannerProps {\n accessor heading: BannerProps['heading'];\n accessor tone: BannerProps['tone'];\n accessor hidden: BannerProps['hidden'];\n accessor dismissible: BannerProps['dismissible'];\n constructor();\n}" + } + }, + "Box": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Box", + "description": "Configure the following properties on the box component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Box extends BoxElement implements BoxProps {\n constructor();\n}" + } + }, + "AccessibilityRole": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AccessibilityRole", + "value": "'main' | 'header' | 'footer' | 'section' | 'aside' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'status' | 'alert' | 'generic' | 'presentation' | 'none'", + "description": "Defines the semantic role of a component for assistive technologies like screen readers.\n\nAccessibility roles help users with disabilities understand the purpose and structure of content. These roles map to HTML elements and ARIA roles, providing semantic meaning beyond visual presentation.\n\nUse these roles to:\n- Improve navigation for screen reader users\n- Provide semantic structure to your UI\n- Ensure proper interpretation by assistive technologies\n\nLearn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles) in the MDN web docs.\n\n- `main`: Indicates the primary content area of the page.\n- `header`: Marks a component as a header containing introductory content or navigation.\n- `footer`: Designates content containing information like copyright, navigation links, or privacy statements.\n- `section`: Defines a generic thematic grouping of content that should have a heading or accessible label.\n- `aside`: Marks supporting content that relates to but is separate from the main content.\n- `navigation`: Identifies major groups of navigation links for moving around the site or page.\n- `ordered-list`: Represents a list where the order of items is meaningful.\n- `list-item`: Identifies an individual item within a list.\n- `list-item-separator`: Acts as a visual and semantic divider between items in a list.\n- `unordered-list`: Represents a list where the order of items is not meaningful.\n- `separator`: Creates a divider that separates and distinguishes sections of content.\n- `status`: Defines a live region for advisory information that is not urgent enough to be an alert.\n- `alert`: Marks important, time-sensitive information that requires the user's immediate attention.\n- `generic`: Creates a semantically neutral container element with no inherent meaning.\n- `presentation`: Removes semantic meaning from an element while preserving its visual appearance.\n- `none`: Synonym for `presentation`, removes semantic meaning while keeping visual styling.", + "isPublicDocs": true + } + }, + "BackgroundColorKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BackgroundColorKeyword", + "value": "'transparent' | ColorKeyword", + "description": "Defines the background color intensity or emphasis level for UI elements.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isPublicDocs": true + } + }, + "ColorKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColorKeyword", + "value": "'subdued' | 'base' | 'strong'", + "description": "Defines the color intensity or emphasis level for text and UI elements.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.", + "isPublicDocs": true + } + }, + "SizeUnitsOrAuto": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnitsOrAuto", + "value": "SizeUnits | 'auto'", + "description": "Represents size values that can also be set to `auto` for automatic sizing.\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isPublicDocs": true + } + }, + "SizeUnits": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnits", + "value": "`${number}px` | `${number}%` | `0`", + "description": "Represents size values in pixels, percentages, or zero.\n\n- `${number}px`: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`).\n- `${number}%`: Relative size as a percentage of the parent container (such as `50%`, `100%`).\n- `0`: Zero size, equivalent to no dimension.", + "isPublicDocs": true + } + }, + "SizeUnitsOrNone": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnitsOrNone", + "value": "SizeUnits | 'none'", + "description": "Represents size values that can also be set to `none` to remove the size constraint.\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `none`: No size constraint, allowing unlimited growth.", + "isPublicDocs": true + } + }, + "MaybeResponsive": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeResponsive", + "value": "T | `@container${string}`", + "description": "Makes a property responsive by allowing it to be set conditionally based on container query conditions. The value can be either a base value or a container query string.\n\n- `T`: Base value that applies in all conditions.\n- `@container${string}`: Container query string for conditional responsive styling based on container size.", + "isPublicDocs": true + } + }, + "MaybeAllValuesShorthandProperty": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeAllValuesShorthandProperty", + "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", + "description": "Represents CSS shorthand properties that accept one to four values. Supports specifying values for all four sides: top, right, bottom, and left.\n\n- `T`: Single value that applies to all four sides.\n- `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right).\n- `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom).\n- `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left).", + "isPublicDocs": true + } + }, + "PaddingKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PaddingKeyword", + "value": "SizeKeyword | 'none'", + "description": "Defines the padding size for elements, using the standard size scale or `none` for no padding.\n\n- `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing.\n- `none`: No padding.", + "isPublicDocs": true + } + }, + "SizeKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeKeyword", + "value": "'small-500' | 'small-400' | 'small-300' | 'small-200' | 'small-100' | 'small' | 'base' | 'large' | 'large-100' | 'large-200' | 'large-300' | 'large-400' | 'large-500'", + "description": "Defines component sizes using a consistent scale from extra small to extra large.\n\n- `small-500` through `small-100`: Extra small to small sizes, progressively increasing.\n- `small`: Standard small size.\n- `base`: Default medium size that works well in most contexts.\n- `large`: Standard large size.\n- `large-100` through `large-500`: Large to extra large sizes, progressively increasing.", + "isPublicDocs": true + } + }, + "MaybeTwoValuesShorthandProperty": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeTwoValuesShorthandProperty", + "value": "T | `${T} ${T}`", + "description": "Represents CSS shorthand properties that accept one or two values. Supports specifying the same value for both dimensions or different values.\n\n- `T`: Single value that applies to both dimensions.\n- `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal).", + "isPublicDocs": true + } + }, + "BorderShorthand": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderShorthand", + "value": "BorderSizeKeyword | `${BorderSizeKeyword} ${ColorKeyword}` | `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`", + "description": "Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style.", + "isPublicDocs": true + } + }, + "BorderSizeKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderSizeKeyword", + "value": "SizeKeyword | 'none'", + "description": "Defines the width of borders, using the standard size scale or `none` for no border.\n\n- `SizeKeyword`: Standard border widths from the size scale for consistent thickness.\n- `none`: No border width (removes the border).", + "isPublicDocs": true + } + }, + "BorderStyleKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderStyleKeyword", + "value": "'none' | 'solid' | 'dashed' | 'dotted' | 'auto'", + "description": "Defines the visual style of borders.\n\n- `none`: No border is displayed.\n- `solid`: A single solid line.\n- `dashed`: A series of short dashes.\n- `dotted`: A series of dots.\n- `auto`: Automatically determined based on context.", + "isPublicDocs": true + } + }, + "BoxBorderStyles": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BoxBorderStyles", + "value": "'auto' | 'none' | 'solid' | 'dashed'", + "description": "Represents the subset of border style values supported by the box component.\n\n- `auto`: Default border style determined by the system.\n- `none`: No border style (removes the border).\n- `solid`: Continuous line border.\n- `dashed`: Border made up of dashes.", + "isPublicDocs": true + } + }, + "BoxBorderRadii": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BoxBorderRadii", + "value": "'small' | 'small-200' | 'small-100' | 'base' | 'large' | 'large-100' | 'large-200' | 'none'", + "description": "Represents the subset of border radius values supported by the component.\n\n- `small-200`: Extra small radius for subtle rounding.\n- `small-100`: Small radius for minimal corner rounding.\n- `small`: Standard small radius.\n- `base`: Medium radius for moderate corner rounding.\n- `large`: Standard large radius for pronounced rounding.\n- `large-100`: Large radius for more prominent corner rounding.\n- `large-200`: Extra large radius for maximum rounding.\n- `none`: No border radius (sharp corners).", + "isPublicDocs": true + } + }, + "Button": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Button", + "description": "Configure the following properties on the button component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "An icon displayed inside the button, typically positioned before the button text. Use icons to help users quickly identify the button's action or to improve scannability. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "variant", + "value": "\"auto\" | \"primary\" | \"secondary\" | \"tertiary\"", + "description": "The visual appearance of the button component.\n\n- `auto`: The variant is automatically determined by the button component's context.\n- `primary`: High emphasis button for the primary action on the page. Should be used sparingly.\n- `secondary`: Medium emphasis button for secondary actions.\n- `tertiary`: Low emphasis button for less important actions.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"critical\" | \"auto\" | \"neutral\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "target", + "value": "\"auto\" | AnyString | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"button\" | \"reset\" | \"submit\"", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "defaultValue": "'button'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class Button extends Button_base implements ButtonProps {\n accessor disabled: ButtonProps['disabled'];\n accessor icon: ButtonProps['icon'];\n accessor loading: ButtonProps['loading'];\n accessor variant: ButtonProps['variant'];\n accessor tone: ButtonProps['tone'];\n accessor target: ButtonProps['target'];\n accessor href: ButtonProps['href'];\n accessor download: ButtonProps['download'];\n accessor type: ButtonProps['type'];\n accessor accessibilityLabel: ButtonProps['accessibilityLabel'];\n constructor();\n}" + } + }, + "AnyString": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyString", + "value": "string & {}", + "description": "A utility type that enables autocomplete for specific string literals while still accepting any string value. By intersecting `string` with an empty object type, this prevents TypeScript from widening literal types, preserving IDE suggestions for known values while maintaining flexibility for custom strings.", + "isPublicDocs": true + } + }, + "ButtonGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonGroup", + "description": "Configure the following properties on the button group component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gap", + "value": "\"base\" | \"none\"", + "description": "The spacing between buttons in the group.\n\n- `base`: Standard spacing that provides clear visual separation between buttons.\n- `none`: No spacing, creating a connected button group.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ButtonGroup\n extends PreactCustomElement\n implements ButtonGroupProps\n{\n accessor gap: ButtonGroupProps['gap'];\n accessor accessibilityLabel: ButtonGroupProps['accessibilityLabel'];\n constructor();\n}" + } + }, + "Checkbox": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Checkbox", + "description": "Configure the following properties on the checkbox component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "indeterminate", + "value": "boolean", + "description": "Whether the checkbox displays in an indeterminate state (neither checked nor unchecked), typically used to indicate partial selection in hierarchical lists.\n\nThis visual state takes priority over the `checked` prop in appearance only. The form submission value is still determined by the `checked` prop.\n\nIf `indeterminate` has not been explicitly set and hasn't been modified by user interaction, it returns the value of `defaultIndeterminate`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultIndeterminate", + "value": "boolean", + "description": "The initial indeterminate state for uncontrolled components. Use this when you want the checkbox to start in an indeterminate state but don't need to control it afterward.\n\nThis value applies until `indeterminate` is explicitly set or the user changes the checkbox state by clicking.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked. Use this for controlled components where you manage the checked state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The value used in form data when the checkbox is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultChecked", + "value": "boolean", + "description": "The initial checked state for uncontrolled components. Use this when you want the control to start checked but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "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.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Checkbox extends PreactCheckboxElement implements CheckboxProps {\n get indeterminate(): CheckboxProps['indeterminate'];\n set indeterminate(indeterminate: CheckboxProps['indeterminate']);\n accessor defaultIndeterminate: CheckboxProps['defaultIndeterminate'];\n constructor();\n}" + } + }, + "Chip": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Chip", + "description": "Configure the following properties on the chip component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Chip extends PreactCustomElement implements ChipProps {\n accessor color: ChipProps['color'];\n accessor accessibilityLabel: ChipProps['accessibilityLabel'];\n constructor();\n}" + } + }, + "Choice": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Choice", + "description": "The choice component creates individual selectable options within a choice list. Use choice to define each option that merchants can select, supporting both single selection (radio buttons) and multiple selection (checkboxes) modes.\n\nChoice components support labels, help text, and custom content through slots, providing flexible option presentation within choice lists.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "selected", + "value": "boolean", + "description": "Whether the option is currently selected. Use this for controlled components where you manage the selection state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultSelected", + "value": "boolean", + "description": "The initial selected state for uncontrolled components. Use this when you want the option to start selected but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Choice extends PreactCustomElement implements ChoiceProps {\n accessor disabled: ChoiceProps['disabled'];\n get selected(): boolean;\n set selected(selected: ChoiceProps['selected']);\n accessor value: ChoiceProps['value'];\n accessor accessibilityLabel: ChoiceProps['accessibilityLabel'];\n accessor defaultSelected: ChoiceProps['defaultSelected'];\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "ChoiceList": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceList", + "description": "Configure the following properties on the choice list component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction. When `true`, the `disabled` property on any child choices is ignored.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple choices can be selected.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "values", + "value": "string[]", + "description": "An array of `value` attributes for the currently selected options. When provided, this property automatically sets the `selected` state on child option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$3@2409", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ChoiceList extends BaseClass$3 implements ChoiceListProps {\n accessor disabled: ChoiceListProps['disabled'];\n accessor name: ChoiceListProps['name'];\n accessor error: ChoiceListProps['error'];\n accessor details: ChoiceListProps['details'];\n accessor multiple: ChoiceListProps['multiple'];\n accessor label: ChoiceListProps['label'];\n accessor labelAccessibilityVisibility: ChoiceListProps['labelAccessibilityVisibility'];\n get values(): ChoiceListProps['values'];\n set values(values: ChoiceListProps['values']);\n /** @private */\n formResetCallback(): void;\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "Clickable": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Clickable", + "description": "Configure the following properties on the clickable component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the component is disabled, preventing clicks and focus. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You shouldapply disabled styling as needed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether the component is in a loading state, which indicates to assistive technology that an action is in progress and prevents interaction.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "target", + "value": "\"auto\" | AnyString | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"button\" | \"reset\" | \"submit\"", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "defaultValue": "'button'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class Clickable extends Clickable_base implements ClickableProps {\n accessor disabled: ClickableProps['disabled'];\n accessor loading: ClickableProps['loading'];\n accessor target: ClickableProps['target'];\n accessor href: ClickableProps['href'];\n accessor download: ClickableProps['download'];\n accessor type: ClickableProps['type'];\n constructor();\n}" + } + }, + "ClickableChip": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableChip", + "description": "Configure the following properties on the clickable chip component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "removable", + "value": "boolean", + "description": "Whether the chip displays a remove button for dismissal. When clicked, the `remove` callback fires.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hidden", + "value": "boolean", + "description": "Whether the chip is hidden from view. When using controlled component pattern with `removable` chips, update this property when the `remove` event fires. For non-removable chips, manually toggle this property to show or hide the chip.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the chip is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class ClickableChip\n extends ClickableChip_base\n implements ClickableChipProps\n{\n accessor color: ClickableChipProps['color'];\n accessor accessibilityLabel: ClickableChipProps['accessibilityLabel'];\n accessor removable: ClickableChipProps['removable'];\n accessor hidden: ClickableChipProps['hidden'];\n accessor disabled: ClickableChipProps['disabled'];\n accessor href: ClickableChipProps['href'];\n constructor();\n}" + } + }, + "ColorField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorField", + "description": "Configure the following properties on the color field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alpha", + "value": "boolean", + "description": "Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected color value. Accepts multiple input formats:\n\n- Hex: `#RGB`, `#RRGGBB`, `#RRGGBBAA` (3, 6, or 8 digits)\n- RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)\n- HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`\n\nReturns an empty string if the value is invalid. The `change` event always emits values in hex format.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setInternalValue", + "value": "(value: string, normalize: boolean) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\"", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ColorField\n extends PreactFieldElement\n implements ColorFieldProps\n{\n accessor alpha: ColorFieldProps['alpha'];\n get value(): string;\n set value(value: string);\n /** @private */\n formResetCallback(): void;\n constructor();\n /** @private */\n setInternalValue(value: string, normalize: boolean): void;\n}" + } + }, + "ColorPicker": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorPicker", + "description": "Configure the following properties on the color picker component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alpha", + "value": "boolean", + "description": "Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial color value when the field first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts interacting, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected color value. Accepts multiple input formats:\n\n- Hex: `#RGB`, `#RRGGBB`, `#RRGGBBAA` (3, 6, or 8 digits)\n- RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated)\n- HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)`\n\nReturns an empty string if the value is invalid. The `change` event always emits values in hex format.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "A callback that fires when the containing form is reset (using the form's `reset()` method or a reset button). When triggered, the component's `value` reverts to its `defaultValue`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$2@2510", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ColorPicker extends BaseClass$2 implements ColorPickerProps {\n accessor alpha: boolean;\n accessor name: string;\n accessor defaultValue: string;\n get value(): string;\n set value(value: string);\n /**\n * A callback that fires when the containing form is reset (using the form's `reset()` method or a reset button). When triggered, the component's `value` reverts to its `defaultValue`.\n */\n formResetCallback(): void;\n constructor();\n}" + } + }, + "DateField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DateField", + "description": "Configure the following properties on the date field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allow", + "value": "string", + "description": "Specifies which dates can be selected as a comma-separated list. An empty string (default) allows all dates.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `2024-02--2025`: February 2024 through end of 2025\n- `2024-05-09, 2024-05-11`: Only May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallow", + "value": "string", + "description": "Specifies which dates can't be selected as a comma-separated list. These dates are excluded from those specified in `allow`. An empty string (default) has no effect.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `--2024-02`: All dates before February 2024\n- `2024-05-09, 2024-05-11`: May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allowDays", + "value": "string", + "description": "Specifies which days of the week can be selected as a comma-separated list. Further restricts dates from `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (only weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallowDays", + "value": "string", + "description": "Specifies which days of the week can't be selected as a comma-separated list. Excludes days from `allowDays` and intersects with `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (no weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "SetAccessor", + "name": "view", + "value": "string", + "description": "The currently displayed month in `YYYY-MM` format. When changed, the `viewchange` callback is triggered. Defaults to `defaultView`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultView", + "value": "string", + "description": "The default month to display in `YYYY-MM` format. Used until the `view` callback is set by user interaction or programmatically. Defaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "DateAutocompleteField", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected date in `YYYY-MM-DD` format. An empty string means no date is selected.", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class DateField\n extends PreactFieldElement\n implements DateFieldProps\n{\n accessor allow: DateFieldProps['allow'];\n accessor disallow: DateFieldProps['disallow'];\n accessor allowDays: DateFieldProps['allowDays'];\n accessor disallowDays: DateFieldProps['disallowDays'];\n set view(view: string);\n get view(): string;\n accessor defaultView: DateFieldProps['defaultView'];\n constructor();\n}" + } + }, + "DateAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DateAutocompleteField", + "value": "'bday-day' | 'bday-month' | 'bday-year' | 'bday' | 'cc-expiry-month' | 'cc-expiry-year' | 'cc-expiry'", + "description": "Represents autocomplete values that are valid for date input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for date-based inputs.\n\nAvailable values:\n- `bday` - Complete birthday date\n- `bday-day` - Day component of a birthday (1-31)\n- `bday-month` - Month component of a birthday (1-12)\n- `bday-year` - Year component of a birthday (1990)\n- `cc-expiry` - Complete credit card expiration date\n- `cc-expiry-month` - Month component of a credit card expiration date (1-12)\n- `cc-expiry-year` - Year component of a credit card expiration date (2025)", + "isPublicDocs": true + } + }, + "DatePicker": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DatePicker", + "description": "Configure the following properties on the date picker component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultView", + "value": "string", + "description": "The default month to display in `YYYY-MM` format. Used until the `view` callback is set by user interaction or programmatically. Defaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "SetAccessor", + "name": "view", + "value": "string", + "description": "The currently displayed month in `YYYY-MM` format. When changed, the `viewchange` callback is triggered. Defaults to `defaultView`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allow", + "value": "string", + "description": "Specifies which dates can be selected as a comma-separated list. An empty string (default) allows all dates.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `2024-02--2025`: February 2024 through end of 2025\n- `2024-05-09, 2024-05-11`: Only May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallow", + "value": "string", + "description": "Specifies which dates can't be selected as a comma-separated list. These dates are excluded from those specified in `allow`. An empty string (default) has no effect.\n\n**Formats:**\n- `YYYY-MM-DD`: Single date\n- `YYYY-MM`: Whole month\n- `YYYY`: Whole year\n- `start--end`: Date range (inclusive, unbounded if start/end omitted)\n\n**Examples:**\n- `--2024-02`: All dates before February 2024\n- `2024-05-09, 2024-05-11`: May 9th and 11th, 2024", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "allowDays", + "value": "string", + "description": "Specifies which days of the week can be selected as a comma-separated list. Further restricts dates from `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (only weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disallowDays", + "value": "string", + "description": "Specifies which days of the week can't be selected as a comma-separated list. Excludes days from `allowDays` and intersects with `allow` and `disallow`. An empty string (default) has no effect.\n\n**Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`\n\n**Example:** `saturday, sunday` (no weekends)", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"single\" | \"range\"", + "description": "The type of date selection allowed.\n\n- `single`: Select a single date\n- `range`: Select a date range", + "defaultValue": "\"single\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initially selected date(s) when the component first renders. An empty string means no date is initially selected.\n\n- Single date in `YYYY-MM-DD` format when `type` is set to `\"single\"`\n- Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `\"range\"`", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "SetAccessor", + "name": "value", + "value": "string", + "description": "The currently selected date(s). An empty string means no date is selected.\n\n- Single date in `YYYY-MM-DD` format when `type` is set to `\"single\"`\n- Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `\"range\"`", + "defaultValue": "\"\"", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@dirtyStateSymbol@2554", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$1@2553", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class DatePicker extends BaseClass$1 implements DatePickerProps {\n accessor defaultView: string;\n set view(view: string);\n get view(): string;\n accessor allow: DatePickerProps['allow'];\n accessor disallow: DatePickerProps['disallow'];\n accessor allowDays: DatePickerProps['allowDays'];\n accessor disallowDays: DatePickerProps['disallowDays'];\n accessor type: DatePickerProps['type'];\n accessor defaultValue: DatePickerProps['defaultValue'];\n accessor name: DatePickerProps['name'];\n set value(value: string);\n get value(): string;\n /** @private */\n [dirtyStateSymbol]: boolean;\n /** @private */\n formResetCallback(): void;\n constructor();\n}" + } + }, + "DropZone": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DropZone", + "description": "Configure the following properties on the drop zone component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accept", + "value": "string", + "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:\n- A file extension starting with a period (\".\") character (e.g. .jpg, .pdf, .doc)\n- A valid MIME type string with no extensions\n\nIf omitted, all file types are accepted.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple files can be selected or dropped at once.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "This sets the input value for a file type, which cannot be set programatically, so it can only be reset.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "files", + "value": "File[]", + "description": "An array of File objects representing the files currently selected by the user.\n\nThis property is read-only and cannot be directly modified. To clear the selected files, set the `value` prop to an empty string or null.", + "defaultValue": "[]", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@setFiles@2589", + "value": "(files: File[]) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@getFileInput@2591", + "value": "() => HTMLInputElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals@2590", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class DropZone extends BaseClass implements DropZoneProps {\n accessor accept: DropZoneProps['accept'];\n accessor accessibilityLabel: DropZoneProps['accessibilityLabel'];\n accessor disabled: DropZoneProps['disabled'];\n accessor error: DropZoneProps['error'];\n accessor label: DropZoneProps['label'];\n accessor labelAccessibilityVisibility: DropZoneProps['labelAccessibilityVisibility'];\n accessor multiple: DropZoneProps['multiple'];\n accessor name: DropZoneProps['name'];\n accessor required: DropZoneProps['required'];\n get value(): string;\n /** This sets the input value for a file type, which cannot be set programatically, so it can only be reset. */\n set value(value: '' | null);\n get files(): File[];\n set files(files: File[]);\n /** @private */\n [setFiles](files: File[]): void;\n /** @private */\n [getFileInput](): ReplaceType<\n Element | null | undefined,\n Element,\n HTMLInputElement\n >;\n\n /** @private */\n formResetCallback(): void;\n constructor();\n}" + } + }, + "Divider": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Divider", + "description": "Configure the following properties on the divider component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "direction", + "value": "\"inline\" | \"block\"", + "description": "The orientation of the divider line, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `inline`: Horizontal divider for separating vertically stacked content\n- `block`: Vertical divider for separating horizontally arranged content", + "defaultValue": "'inline'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"strong\"", + "description": "The visual prominence of the divider line.\n\n- `base`: Standard divider for most separations (default)\n- `strong`: More prominent divider for major section breaks", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Divider extends PreactCustomElement implements DividerProps {\n accessor direction: DividerProps['direction'];\n accessor color: DividerProps['color'];\n constructor();\n}" + } + }, + "EmailField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "EmailField", + "description": "Configure the following properties on the email field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | EmailAutocompleteField | `section-${string} email` | `section-${string} home email` | `section-${string} mobile email` | `section-${string} fax email` | `section-${string} pager email` | \"shipping email\" | \"shipping home email\" | \"shipping mobile email\" | ... 16 more ... | `section-${string} billing p...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current email address value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as an email address format when the user finishes editing.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class EmailField\n extends PreactFieldElement\n implements EmailFieldProps\n{\n accessor autocomplete: EmailFieldProps['autocomplete'];\n accessor maxLength: EmailFieldProps['maxLength'];\n accessor minLength: EmailFieldProps['minLength'];\n /**\n * The current email address value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as an email address format when the user finishes editing.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "EmailAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "EmailAutocompleteField", + "value": "'email' | 'home email' | 'mobile email' | 'fax email' | 'pager email'", + "description": "Represents autocomplete values that are valid for email input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for email inputs.\n\nAvailable values:\n- `email` - Primary email address\n- `home email` - Home email address\n- `mobile email` - Mobile device email address\n- `fax email` - Fax machine email address\n- `pager email` - Pager device email address", + "isPublicDocs": true + } + }, + "Grid": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Grid", + "description": "Configure the following properties on the grid component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridTemplateColumns", + "value": "string", + "description": "The columns in the grid and their sizes.\n\nAccepts:\n- [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), such as `1fr auto`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported track sizing values as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridTemplateRows", + "value": "string", + "description": "The rows in the grid and their sizes.\n\nAccepts:\n- [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), such as `1fr auto`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported track sizing values as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "justifyItems", + "value": "\"\" | JustifyItemsKeyword", + "description": "Aligns the grid items along the inline axis.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignItems", + "value": "\"\" | AlignItemsKeyword", + "description": "Aligns the grid items along the block axis.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeItems", + "value": "AlignItemsKeyword | \"normal normal\" | \"normal stretch\" | \"normal baseline\" | \"normal first baseline\" | \"normal last baseline\" | \"normal start\" | \"normal end\" | ... 188 more ... | \"safe center safe center\"", + "description": "A shorthand property for `justify-items` and `align-items`.", + "defaultValue": "'normal normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "justifyContent", + "value": "\"\" | JustifyContentKeyword", + "description": "Aligns the grid along the inline axis. This overrides the inline value of `placeContent`.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignContent", + "value": "\"\" | AlignContentKeyword", + "description": "Aligns the grid along the block axis. This overrides the block value of `placeContent`.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeContent", + "value": "\"normal normal\" | \"normal stretch\" | \"normal start\" | \"normal end\" | \"normal center\" | \"normal unsafe start\" | \"normal unsafe end\" | \"normal unsafe center\" | \"normal safe start\" | ... 229 more ... | \"space-evenly space-evenly\"", + "description": "A shorthand property for `justify-content` and `align-content`.", + "defaultValue": "'normal normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gap", + "value": "MaybeResponsive>", + "description": "Adjusts spacing between elements.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value applied to both axes, such as `large-100`\n- A pair of values, such as `large-100 large-500`, to set the inline and block axes respectively\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "rowGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "s spacing between elements in the block axis. This overrides the row value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "columnGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "Adjusts spacing between elements in the inline axis. This overrides the column value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Grid extends BoxElement implements GridProps {\n constructor();\n accessor gridTemplateColumns: GridProps['gridTemplateColumns'];\n accessor gridTemplateRows: GridProps['gridTemplateRows'];\n accessor justifyItems: GridProps['justifyItems'];\n accessor alignItems: GridProps['alignItems'];\n accessor placeItems: GridProps['placeItems'];\n accessor justifyContent: GridProps['justifyContent'];\n accessor alignContent: GridProps['alignContent'];\n accessor placeContent: GridProps['placeContent'];\n accessor gap: GridProps['gap'];\n accessor rowGap: GridProps['rowGap'];\n accessor columnGap: GridProps['columnGap'];\n}" + } + }, + "JustifyItemsKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "JustifyItemsKeyword", + "value": "'normal' | 'stretch' | BaselinePosition | OverflowPosition | ContentPosition", + "description": "Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis.\n\nLearn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).", + "isPublicDocs": true + } + }, + "BaselinePosition": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BaselinePosition", + "value": "'baseline' | 'first baseline' | 'last baseline'", + "description": "Represents baseline alignment positions used to align items relative to their baselines.\n- `baseline`: Aligns to the baseline of the parent.\n- `first baseline`: Aligns to the first baseline of the parent.\n- `last baseline`: Aligns to the last baseline of the parent.", + "isPublicDocs": true + } + }, + "OverflowPosition": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "OverflowPosition", + "value": "`unsafe ${ContentPosition}` | `safe ${ContentPosition}`", + "description": "Represents content positioning with overflow behavior control. Use `safe` to prevent content from becoming inaccessible when it overflows, or `unsafe` to allow overflow regardless of accessibility.", + "isPublicDocs": true + } + }, + "ContentPosition": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ContentPosition", + "value": "'center' | 'start' | 'end'", + "description": "Defines the position of content along an axis.\n- `center`: Centers the content.\n- `start`: Aligns content to the start.\n- `end`: Aligns content to the end.", + "isPublicDocs": true + } + }, + "AlignItemsKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AlignItemsKeyword", + "value": "'normal' | 'stretch' | BaselinePosition | OverflowPosition | ContentPosition", + "description": "Align items sets the align-self value on all direct children as a group.\n\nLearn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).", + "isPublicDocs": true + } + }, + "JustifyContentKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "JustifyContentKeyword", + "value": "'normal' | ContentDistribution | OverflowPosition | ContentPosition", + "description": "Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container.\n\nLearn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).", + "isPublicDocs": true + } + }, + "ContentDistribution": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ContentDistribution", + "value": "'space-between' | 'space-around' | 'space-evenly' | 'stretch'", + "description": "Defines how space is distributed between and around content items in flex and grid layouts.\n- `space-between`: Distributes items evenly with the first item at the start and last at the end.\n- `space-around`: Distributes items evenly with equal space around each item.\n- `space-evenly`: Distributes items evenly with equal space between them.\n- `stretch`: Stretches items to fill the container.", + "isPublicDocs": true + } + }, + "AlignContentKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AlignContentKeyword", + "value": "'normal' | BaselinePosition | ContentDistribution | OverflowPosition | ContentPosition", + "description": "Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis.\n\nLearn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).", + "isPublicDocs": true + } + }, + "SpacingKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingKeyword", + "value": "SizeKeyword | 'none'", + "description": "Defines the spacing size between elements, using the standard size scale or `none` for no spacing.", + "isPublicDocs": true + } + }, + "GridItem": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "GridItem", + "description": "The grid item component represents a single cell within a grid layout, allowing you to control how content is positioned and sized within the grid. Use grid item as a child of grid to specify column span, row span, and positioning for individual content areas.\n\nGrid item supports precise placement control through column and row properties, enabling you to create complex layouts where different items occupy varying amounts of space or appear in specific grid positions.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridColumn", + "value": "\"auto\" | `span ${number}`", + "description": "The number of columns the item will span across.\n\nLearn more about the [grid-column property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gridRow", + "value": "\"auto\" | `span ${number}`", + "description": "The number of rows the item will span across.\n\nLearn more about the [grid-row property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class GridItem extends BoxElement implements GridItemProps {\n accessor gridColumn: GridItemProps['gridColumn'];\n accessor gridRow: GridItemProps['gridRow'];\n constructor();\n}" + } + }, + "Heading": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Heading", + "description": "Configure the following properties on the heading component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "\"none\" | \"presentation\" | \"heading\"", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `none`: Completely hides the element and its content from assistive technologies\n- `presentation`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.\n- `img`: Identifies the element as an image that conveys meaningful information to users.", + "defaultValue": "'heading'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "lineClamp", + "value": "number", + "description": "The maximum number of lines to display before truncating the text content.\n\nLearn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).", + "defaultValue": "Infinity - no truncation is applied", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Heading extends PreactCustomElement implements HeadingProps {\n accessor accessibilityRole: HeadingProps['accessibilityRole'];\n accessor lineClamp: HeadingProps['lineClamp'];\n accessor accessibilityVisibility: HeadingProps['accessibilityVisibility'];\n constructor();\n}" + } + }, + "Icon": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Icon", + "description": "Configure the following properties on the icon component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"subdued\"", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\" | \"neutral\" | \"caution\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `caution`: Advisory notices that need attention.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "The icon to display from the icon library.\n\nSet to a valid icon name to display that icon. To hide the icon completely, use an empty string `''`. To reserve the icon's space without displaying an icon, use `'empty'`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"base\"", + "description": "The size of the icon.\n\n- `small`: Smaller icon suitable for inline use within text or compact UI elements.\n- `base`: Default size that works well for standalone icons and standard use cases.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Icon extends PreactCustomElement implements IconProps {\n accessor color: IconProps['color'];\n accessor tone: IconProps['tone'];\n accessor type: IconProps['type'];\n accessor size: IconProps['size'];\n accessor interestFor: string;\n constructor();\n}" + } + }, + "Image": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Image", + "description": "Configure the following properties on the image component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. This overrides the `src` property.\n\nLearn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes.\n\nLearn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "defaultValue": "``", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "aspectRatio", + "value": "`${number}` | `${number}/${number}` | `${number}/ ${number}` | `${number} /${number}` | `${number} / ${number}`", + "description": "The aspect ratio of the image.\n\nThe rendering of the image will depend on the `inlineSize` value:\n\n- `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space.\n- `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored.\n\nFor 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`.\n\nLearn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).", + "defaultValue": "'1/1'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "objectFit", + "value": "\"contain\" | \"cover\"", + "description": "The image resizing behavior to fit within its container.\n\n- `contain`: Scales the image to fit within the container while maintaining its aspect ratio. The entire image is visible, but might leave empty space.\n- `cover`: Scales the image to fill the entire container while maintaining its aspect ratio. The image might be cropped to fit.\n\nThe image is always positioned in the center of the container.\n\nLearn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).", + "defaultValue": "'contain'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "\"eager\" | \"lazy\"", + "description": "The loading strategy for the image.\n\n- `eager`: Immediately loads the image, irrespective of its position within the visible viewport.\n- `lazy`: Delays loading the image until it approaches a specified distance from the viewport.\n\nLearn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).", + "defaultValue": "'eager'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "\"none\" | \"presentation\" | \"img\"", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `none`: Completely hides the element and its content from assistive technologies\n- `presentation`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.\n- `img`: Identifies the element as an image that conveys meaningful information to users.", + "defaultValue": "'img'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "\"auto\" | \"fill\"", + "description": "The displayed inline width of the image.\n\n- `fill`: the image will takes up 100% of the available inline size.\n- `auto`: the image will be displayed at its natural size.\n\nLearn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).", + "defaultValue": "'fill'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied around the image using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border around the image. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border around the image, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border around the image using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the image's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Image extends PreactCustomElement implements ImageProps {\n accessor src: ImageProps['src'];\n accessor srcSet: ImageProps['srcSet'];\n accessor sizes: ImageProps['sizes'];\n accessor alt: ImageProps['alt'];\n accessor aspectRatio: ImageProps['aspectRatio'];\n accessor objectFit: ImageProps['objectFit'];\n accessor loading: ImageProps['loading'];\n accessor accessibilityRole: ImageProps['accessibilityRole'];\n accessor inlineSize: ImageProps['inlineSize'];\n /**\n * A border applied around the image using shorthand syntax to specify width, color, and style in a single property.\n */\n accessor border: ImageProps['border'];\n /**\n * The thickness of the border around the image. When set, this overrides the width value specified in the `border` property.\n */\n accessor borderWidth: ImageProps['borderWidth'];\n /**\n * The visual style of the border around the image, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.\n */\n accessor borderStyle: ImageProps['borderStyle'];\n /**\n * The color of the border around the image using the design system's color scale. When set, this overrides the color value specified in the `border` property.\n */\n accessor borderColor: ImageProps['borderColor'];\n /**\n * The roundedness of the image's corners using the design system's radius scale.\n */\n accessor borderRadius: ImageProps['borderRadius'];\n constructor();\n}" + } + }, + "Link": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Link", + "description": "Configure the following properties on the link component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"critical\" | \"auto\" | \"neutral\"", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "target", + "value": "\"auto\" | AnyString | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "declare class Link extends Link_base implements LinkProps {\n accessor tone: LinkProps['tone'];\n accessor accessibilityLabel: LinkProps['accessibilityLabel'];\n accessor href: LinkProps['href'];\n accessor target: LinkProps['target'];\n accessor download: LinkProps['download'];\n accessor lang: LinkProps['lang'];\n constructor();\n}" + } + }, + "ListItem": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ListItem", + "description": "The list item component represents a single entry within an ordered list or unordered list. Use list item to structure individual points, steps, or items within a list, with each item automatically receiving appropriate list markers (bullets or numbers) from its parent list.\n\nList item must be used as a direct child of ordered list or unordered list components. Each list item can contain text, inline formatting, or other components to create rich list content.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class ListItem extends PreactCustomElement implements ListItemProps {\n constructor();\n}" + } + }, + "Menu": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Menu", + "description": "Configure the following properties on the menu component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Menu extends PreactOverlayElement implements MenuProps {\n accessor accessibilityLabel: string;\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "MoneyField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MoneyField", + "description": "Configure the following properties on the money field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "-Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current monetary value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string representing the amount in the store's currency.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "string", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class MoneyField\n extends PreactFieldElement\n implements MoneyFieldProps\n{\n accessor max: MoneyFieldProps['max'];\n accessor min: MoneyFieldProps['min'];\n /**\n * The current monetary value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string representing the amount in the store's currency.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "NumberField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "NumberField", + "description": "Configure the following properties on the number field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current numeric value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string (decimal or integer).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inputMode", + "value": "\"decimal\" | \"numeric\"", + "description": "The type of virtual keyboard to display on mobile devices.\n\n- `decimal`: Shows a numeric keyboard with a decimal point, suitable for prices or measurements.\n- `numeric`: Shows a numeric keyboard without a decimal point, suitable for whole numbers like quantities.\n\nLearn more about the [inputmode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).", + "defaultValue": "'decimal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "step", + "value": "number", + "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.", + "defaultValue": "1", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "defaultValue": "-Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "prefix", + "value": "string", + "description": "A non-editable text value 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`.\n\nThis text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "suffix", + "value": "string", + "description": "A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n\nThis text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | NumberAutocompleteField | `section-${string} one-time-code` | `section-${string} cc-number` | `section-${string} cc-csc` | \"shipping one-time-code\" | \"shipping cc-number\" | \"shipping cc-csc\" | \"billing one-time-code\" | ... 7 more ... | `section-${string} billing cc-csc`", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class NumberField\n extends PreactFieldElement\n implements NumberFieldProps\n{\n /**\n * The current numeric value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string (decimal or integer).\n */\n get value(): string;\n set value(value: string);\n accessor inputMode: NumberFieldProps['inputMode'];\n accessor step: NumberFieldProps['step'];\n accessor max: NumberFieldProps['max'];\n accessor min: NumberFieldProps['min'];\n accessor prefix: NumberFieldProps['prefix'];\n accessor suffix: NumberFieldProps['suffix'];\n constructor();\n}" + } + }, + "NumberAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "NumberAutocompleteField", + "value": "'one-time-code' | 'cc-number' | 'cc-csc'", + "description": "Represents autocomplete values that are valid for number input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for numeric inputs.\n\nAvailable values:\n- `one-time-code` - One-time codes for authentication (OTP, 2FA codes)\n- `cc-number` - Credit card number\n- `cc-csc` - Credit card security code (CVV/CVC)", + "isPublicDocs": true + } + }, + "Option": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Option", + "description": "Represents a single option within a select component. Use only as a child of s-select components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "selected", + "value": "boolean", + "description": "Whether the option is currently selected. Use this for controlled components where you manage the selection state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultSelected", + "value": "boolean", + "description": "The initial selected state for uncontrolled components. Use this when you want the option to start selected but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Option extends PreactCustomElement implements OptionProps {\n accessor selected: OptionProps['selected'];\n accessor defaultSelected: OptionProps['defaultSelected'];\n accessor value: OptionProps['value'];\n accessor disabled: OptionProps['disabled'];\n constructor();\n}" + } + }, + "OptionGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OptionGroup", + "description": "Represents a group of options within a select component. Use only as a child of `s-select` components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the options within this group can be selected or not.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The user-facing label for this group of options.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class OptionGroup\n extends PreactCustomElement\n implements OptionGroupProps\n{\n accessor disabled: OptionGroupProps['disabled'];\n accessor label: OptionGroupProps['label'];\n constructor();\n}" + } + }, + "OrderedList": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OrderedList", + "description": "Configure the following properties on the ordered list component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class OrderedList\n extends PreactCustomElement\n implements OrderedListProps\n{\n constructor();\n}" + } + }, + "Paragraph": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Paragraph", + "description": "Configure the following properties on the paragraph component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "fontVariantNumeric", + "value": "\"auto\" | \"normal\" | \"tabular-nums\"", + "description": "The rendering style for numbers in the font.\n\n- `auto`: Inherits the setting from the parent element.\n- `normal`: Uses the font's default numeric glyphs.\n- `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n\nLearn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "lineClamp", + "value": "number", + "description": "The maximum number of lines to display before truncating the text content.\n\nLearn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).", + "defaultValue": "Infinity - no truncation is applied", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"caution\"", + "description": "The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.\n\n- `info`: Informational content or helpful tips (blue).\n- `success`: Positive outcomes or successful states (green).\n- `warning`: Important warnings about potential issues (orange).\n- `critical`: Urgent problems or destructive actions (red).\n- `caution`: Advisory notices that need attention (yellow).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"subdued\"", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "dir", + "value": "\"\" | \"auto\" | \"ltr\" | \"rtl\"", + "description": "Indicates the directionality of the element’s text.\n\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n- `auto`: The user agent determines the direction based on the content.\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Paragraph extends PreactCustomElement implements ParagraphProps {\n accessor fontVariantNumeric: ParagraphProps['fontVariantNumeric'];\n accessor lineClamp: ParagraphProps['lineClamp'];\n /**\n * The semantic tone that's applied to the paragraph text, which changes its color to convey meaning.\n *\n * - `info`: Informational content or helpful tips (blue).\n * - `success`: Positive outcomes or successful states (green).\n * - `warning`: Important warnings about potential issues (orange).\n * - `critical`: Urgent problems or destructive actions (red).\n * - `caution`: Advisory notices that need attention (yellow).\n */\n accessor tone: ParagraphProps['tone'];\n\n accessor color: ParagraphProps['color'];\n accessor dir: ParagraphProps['dir'];\n accessor accessibilityVisibility: ParagraphProps['accessibilityVisibility'];\n constructor();\n}" + } + }, + "PasswordField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PasswordField", + "description": "Configure the following properties on the password field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current password value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value is masked in the UI for security.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | PasswordAutocompleteField | `section-${string} current-password` | `section-${string} new-password` | \"shipping current-password\" | \"shipping new-password\" | \"billing current-password\" | \"billing new-password\" | `section-${string} shipping current-password` | `section-${string} shipping new-password` | `section-${string} billing current-password` | `section-${string} billing new-password`", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class PasswordField\n extends PreactFieldElement\n implements PasswordFieldProps\n{\n accessor maxLength: PasswordFieldProps['maxLength'];\n accessor minLength: PasswordFieldProps['minLength'];\n /**\n * The current password value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value is masked in the UI for security.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "PasswordAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PasswordAutocompleteField", + "value": "'current-password' | 'new-password'", + "description": "Represents autocomplete values that are valid for password input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for password inputs.\n\nAvailable values:\n- `current-password` - Existing password for login or authentication\n- `new-password` - New password when creating an account or changing password", + "isPublicDocs": true + } + }, + "QueryContainer": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "QueryContainer", + "description": "Configure the following properties on the query container component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "containerName", + "value": "string", + "description": "An identifier for this container that you can reference in CSS container queries to apply styles based on this specific container's size.\n\nAll query container components automatically receive a container name of `s-default`. You can omit the container name in your queries, so `@container (inline-size <= 300px)` is equivalent to `@container s-default (inline-size <= 300px)`.\n\nWhen you provide a custom `containerName`, it's added alongside `s-default`. For example, `containerName=\"product-card\"` results in `s-default product-card` being set on the `container-name` CSS property, allowing you to target this container with `@container product-card (inline-size <= 300px)`.\n\nLearn more about the [container-name property](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name).", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class QueryContainer\n extends PreactCustomElement\n implements QueryContainerProps\n{\n accessor containerName: QueryContainerProps['containerName'];\n /** @private */\n static globalStylesApplied: boolean;\n constructor();\n}" + } + }, + "SearchField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SearchField", + "description": "Configure the following properties on the search field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current search query value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | TextAutocompleteField | `section-${string} one-time-code` | \"shipping one-time-code\" | \"billing one-time-code\" | `section-${string} shipping one-time-code` | `section-${string} billing one-time-code` | `section-${string} language` | `section-${string} organization` | `section-${string} name` | ... 141...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class SearchField\n extends PreactFieldElement\n implements SearchFieldProps\n{\n accessor maxLength: SearchFieldProps['maxLength'];\n accessor minLength: SearchFieldProps['minLength'];\n /**\n * The current search query value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "TextAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextAutocompleteField", + "value": "'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'", + "description": "Represents autocomplete values that are valid for text input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for text-based inputs.\n\nAvailable values:\n- `name` - Full name\n- `given-name` - First name\n- `additional-name` - Middle name\n- `family-name` - Last name\n- `nickname` - Nickname or handle\n- `username` - Username for login\n- `honorific-prefix` - Name prefix (Mr., Mrs., Dr.)\n- `honorific-suffix` - Name suffix (Jr., Sr., III)\n- `organization` - Company or organization name\n- `organization-title` - Job title or position\n- `address-line1` - Street address (first line)\n- `address-line2` - Street address (second line)\n- `address-line3` - Street address (third line)\n- `address-level1` - State or province\n- `address-level2` - City or town\n- `address-level3` - District or locality\n- `address-level4` - Neighborhood or suburb\n- `street-address` - Complete street address (multi-line)\n- `postal-code` - Postal or ZIP code\n- `country` - Country code (US, CA, GB)\n- `country-name` - Country name (United States, Canada)\n- `language` - Preferred language\n- `sex` - Gender or sex\n- `one-time-code` - One-time codes for authentication\n- `transaction-currency` - Currency code (USD, EUR, GBP)\n- `cc-name` - Name on credit card\n- `cc-given-name` - First name on credit card\n- `cc-additional-name` - Middle name on credit card\n- `cc-family-name` - Last name on credit card\n- `cc-type` - Credit card type (Visa, Mastercard)", + "isPublicDocs": true + } + }, + "Section": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Section", + "description": "Configure the following properties on the section component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "\"base\" | \"none\"", + "description": "The padding applied to all edges of the element.\n\n- `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context.\n- `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.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Section extends PreactCustomElement implements SectionProps {\n constructor();\n /** @private */\n connectedCallback(): void;\n accessor accessibilityLabel: SectionProps['accessibilityLabel'];\n accessor heading: SectionProps['heading'];\n accessor padding: SectionProps['padding'];\n}" + } + }, + "Select": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Select", + "description": "Configure the following properties on the select component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"\" | \"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 541 more ... | \"x-circle-filled\"", + "description": "An icon displayed inside the field to provide visual context about the expected input or field purpose. Commonly used for search fields, currency inputs, or to indicate field type. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "A lifecycle callback that fires when the component is removed from the DOM. Performs cleanup operations.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The value of the currently selected option. When setting this property programmatically, it updates which option appears selected in the dropdown. When reading it, you get the `value` attribute of the currently selected option component.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@usedFirstOptionSymbol@3004", + "value": "boolean", + "description": "A flag used to determine if no value or defaultValue was set, in which case the first non-disabled option was used.\n\nThis is important because we need to use the placeholder in these situations, even though the first value will be submitted as part of the form.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@hasInitialValueSymbol@3005", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Select extends PreactInputElement implements SelectProps {\n accessor icon: SelectProps['icon'];\n accessor details: SelectProps['details'];\n accessor error: SelectProps['error'];\n accessor label: SelectProps['label'];\n accessor placeholder: SelectProps['placeholder'];\n accessor required: SelectProps['required'];\n accessor labelAccessibilityVisibility: SelectProps['labelAccessibilityVisibility'];\n /** @private */\n connectedCallback(): void;\n /**\n * A lifecycle callback that fires when the component is removed from the DOM. Performs cleanup operations.\n * @private\n */\n disconnectedCallback(): void;\n constructor();\n /**\n * A flag used to determine if no value or defaultValue was set, in which case the first non-disabled option was used.\n *\n * This is important because we need to use the placeholder in these situations, even though the first value will be submitted as part of the form.\n * @private\n */\n [usedFirstOptionSymbol]: boolean;\n /**\n * @private\n */\n [hasInitialValueSymbol]: boolean;\n /**\n * The value of the currently selected option. When setting this property programmatically, it updates which option appears selected in the dropdown. When reading it, you get the `value` attribute of the currently selected option component.\n */\n get value(): string;\n set value(value: string);\n /** @private */\n formResetCallback(): void;\n}" + } + }, + "Spinner": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Spinner", + "description": "Configure the following properties on the spinner component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"base\" | \"large\" | \"large-100\"", + "description": "The size of the loading spinner.\n\n- `base`: Default size suitable for inline loading indicators or standard UI contexts.\n- `large`: Larger spinner for more prominent loading states.\n- `large-100`: Extra large spinner for full-page or emphasized loading states.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Spinner extends PreactCustomElement implements SpinnerProps {\n accessor accessibilityLabel: string;\n accessor size: SpinnerProps['size'];\n constructor();\n}" + } + }, + "Stack": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Stack", + "description": "Configure the following properties on the stack component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "direction", + "value": "MaybeResponsive<\"inline\" | \"block\">", + "description": "The direction in which the stack's children are placed within the stack.\n\nAccepts:\n- A single value, either `inline` or `block`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported direction values as a query value", + "defaultValue": "'block'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "justifyContent", + "value": "JustifyContentKeyword", + "description": "Controls the distribution of children along the inline axis (horizontally in horizontal writing modes).\n\nUse this to position items along the primary axis of the stack - horizontally for inline stacks or vertically for block stacks when wrapped into multiple lines.", + "defaultValue": "'normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignItems", + "value": "AlignItemsKeyword", + "description": "Controls the alignment of children along the block axis (vertically in horizontal writing modes).\n\nUse this to align items perpendicular to the stack direction - vertically for inline stacks or horizontally for block stacks.", + "defaultValue": "'normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alignContent", + "value": "AlignContentKeyword", + "description": "Controls the distribution of lines along the block axis when content wraps into multiple lines.\n\nThis property only affects stacks with wrapping content. For single-line stacks, use `alignItems` instead.", + "defaultValue": "'normal'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "gap", + "value": "MaybeResponsive>", + "description": "Adjusts spacing between elements.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value applied to both axes, such as `large-100`\n- A pair of values, such as `large-100 large-500`, to set the inline and block axes respectively\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "rowGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "Adjusts spacing between elements in the block axis. This overrides the row value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "columnGap", + "value": "MaybeResponsive<\"\" | SpacingKeyword>", + "description": "Adjusts spacing between elements in the inline axis. This overrides the column value of `gap`.\n\nAccepts:\n- A single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value, such as `large-100`\n- A [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported SpacingKeyword as a query value", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the component.", + "defaultValue": "'transparent'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum height in horizontal writing modes, or minimum width in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum height in horizontal writing modes, or maximum width in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The width in horizontal writing modes, or height in vertical writing modes. Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum width in horizontal writing modes, or minimum height in vertical writing modes. Prevents the element from shrinking below this size.\n\nLearn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum width in horizontal writing modes, or maximum height in vertical writing modes. Prevents the element from growing beyond this size.\n\nLearn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "overflow", + "value": "\"visible\" | \"hidden\"", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlock", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingBlockEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInline", + "value": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineStart", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paddingInlineEnd", + "value": "MaybeResponsive<\"\" | PaddingKeyword>", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.", + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ], + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderWidth", + "value": "\"\" | MaybeAllValuesShorthandProperty<\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\" | \"none\">", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderStyle", + "value": "\"\" | MaybeAllValuesShorthandProperty", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderColor", + "value": "\"\" | ColorKeyword", + "description": "The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.", + "defaultValue": "'' - meaning no override", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "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).\n\n- `auto` the component's initial value. The actual value depends on the component and context.\n- `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Stack extends BoxElement implements StackProps {\n constructor();\n accessor direction: StackProps['direction'];\n accessor justifyContent: StackProps['justifyContent'];\n accessor alignItems: StackProps['alignItems'];\n accessor alignContent: StackProps['alignContent'];\n accessor gap: StackProps['gap'];\n accessor rowGap: StackProps['rowGap'];\n accessor columnGap: StackProps['columnGap'];\n}" + } + }, + "Switch": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Switch", + "description": "Configure the following properties on the switch component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked. Use this for controlled components where you manage the checked state.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The value used in form data when the checkbox is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultChecked", + "value": "boolean", + "description": "The initial checked state for uncontrolled components. Use this when you want the control to start checked but don't need to control its state afterward.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "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.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Switch extends PreactCheckboxElement implements SwitchProps {\n accessor labelAccessibilityVisibility: SwitchProps['labelAccessibilityVisibility'];\n constructor();\n}" + } + }, + "Table": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Table", + "description": "Configure the following properties on the table component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "variant", + "value": "\"auto\" | \"list\"", + "description": "The layout variant of the table component.\n\n- `list`: Always displays as a list layout.\n- `table`: Always displays as a traditional table layout.\n- `auto`: Automatically displays as a table on wide screens and as a list on narrow screens.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table. When `true`, the table might be in an inert state that prevents user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "paginate", + "value": "boolean", + "description": "Whether to use pagination controls.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hasPreviousPage", + "value": "boolean", + "description": "Whether there's a previous page of data.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "hasNextPage", + "value": "boolean", + "description": "Whether there's an additional page of data.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@actualTableVariantSymbol@3080", + "value": "AddedContext", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@tableHeadersSharedDataSymbol@3081", + "value": "AddedContext<{ listSlot: ListSlotType; textContent: string; format: HeaderFormat; }[]>", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Table extends PreactCustomElement implements TableProps {\n accessor variant: TableProps['variant'];\n accessor loading: TableProps['loading'];\n accessor paginate: TableProps['paginate'];\n accessor hasPreviousPage: TableProps['hasPreviousPage'];\n accessor hasNextPage: TableProps['hasNextPage'];\n /**\n * @private\n * The actual table variant, which is either 'table' or 'list'.\n */\n [actualTableVariantSymbol]: AddedContext;\n /** @private */\n [tableHeadersSharedDataSymbol]: AddedContext<\n {\n listSlot: TableHeaderProps['listSlot'];\n textContent: string;\n format: HeaderFormat;\n }[]\n >;\n\n constructor();\n}" + } + }, + "AddedContext": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AddedContext", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "T", + "description": "The current context value.\n\nThe new context value to set, which will notify all consumers." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "(type: string, callback: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions) => void", + "description": "The **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "(type: string, callback: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions) => void", + "description": "The **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + } + ], + "value": "declare class AddedContext extends EventTarget {\n constructor(defaultValue: T);\n /**\n * The current context value.\n */\n get value(): T;\n /**\n * The new context value to set, which will notify all consumers.\n */\n set value(value: T);\n}" + } + }, + "ActualTableVariant": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ActualTableVariant", + "value": "'table' | 'list'", + "description": "Represents the actual rendered variant of a table component.\n- `table`: Displays as a traditional table layout.\n- `list`: Displays as a list layout.", + "isPublicDocs": true + } + }, + "ListSlotType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ListSlotType", + "value": "'primary' | 'secondary' | 'kicker' | 'inline' | 'labeled'", + "description": "Represents the semantic type of content slots within list items.\n\n- `primary`: The main content or title of the list item.\n- `secondary`: Supporting or descriptive content below the primary content.\n- `kicker`: A small label or tag displayed above the primary content.\n- `inline`: Content displayed inline with the primary content.\n- `labeled`: Content with an associated label.", + "isPublicDocs": true + } + }, + "HeaderFormat": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "HeaderFormat", + "value": "'base' | 'numeric' | 'currency'", + "description": "Represents the format options for table headers that control styling and alignment of column content.\n\nAvailable values:\n- `base`: Standard format for text columns\n- `currency`: Right-aligned format for monetary values\n- `numeric`: Right-aligned format for numeric values", + "isPublicDocs": true + } + }, + "TableBody": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableBody", + "description": "The table body component represents the main content area of a table, containing the data rows. Use table body as a child of table to structure your table data, with each table row within the body representing a single record or entry.\n\nTable body must contain table row components, which in turn contain table cell components for the actual data values.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableBody extends PreactCustomElement implements TableBodyProps {\n constructor();\n}" + } + }, + "TableCell": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableCell", + "description": "The table cell component represents a single data cell within a table row. Use table cell as a child of table row to display individual data values, with each cell corresponding to a column in the table.\n\nTable cell automatically inherits styling and alignment from its parent table structure and supports text content or other inline components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "__@headerFormatSymbol@3103", + "value": "HeaderFormat", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableCell extends PreactCustomElement implements TableCellProps {\n constructor();\n /** @private */\n get [headerFormatSymbol](): HeaderFormat;\n /** @private */\n set [headerFormatSymbol](format: HeaderFormat);\n}" + } + }, + "TableHeader": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeader", + "description": "The table header component represents a single column header within a table header row. Use table header as a child of table header row to define column headings and optionally enable column sorting.\n\nTable header provides semantic meaning for screen readers and can include sorting controls when configured. Each header corresponds to a column in the table body.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "listSlot", + "value": "ListSlotType", + "description": "The content designation for this column when the table displays in list variant on mobile devices.", + "defaultValue": "'labeled'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "format", + "value": "HeaderFormat", + "description": "The format of the column that controls styling and alignment of cell content.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableHeader\n extends PreactCustomElement\n implements TableHeaderProps\n{\n accessor listSlot: TableHeaderProps['listSlot'];\n accessor format: TableHeaderProps['format'];\n constructor();\n}" + } + }, + "TableHeaderRow": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeaderRow", + "description": "The table header row component represents the header row of a table, containing column headings. Use table header row as the first child of table (before table body) to define the table structure and provide column labels.\n\nTable header row must contain table header components for each column. These headers provide context for the data columns and can support sorting functionality.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableHeaderRow\n extends PreactCustomElement\n implements TableHeaderRowProps\n{\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "TableRow": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableRow", + "description": "The table row component represents a single row of data within a table body. Use table row as a child of table body to structure individual records or entries in the table.\n\nTable row must contain table cell components, with each cell representing a data value for the corresponding column. The number of cells should match the number of headers in the table.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "clickDelegate", + "value": "string", + "description": "The ID of an interactive element, such as `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.\n\nThis 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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TableRow extends PreactCustomElement implements TableRowProps {\n constructor();\n accessor clickDelegate: string;\n}" + } + }, + "Text": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Text", + "description": "Configure the following properties on the text component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "fontVariantNumeric", + "value": "\"auto\" | \"normal\" | \"tabular-nums\"", + "description": "The rendering style for numbers in the font.\n\n- `auto`: Inherits the setting from the parent element.\n- `normal`: Uses the font's default numeric glyphs.\n- `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n\nLearn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "color", + "value": "\"base\" | \"subdued\"", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "tone", + "value": "\"info\" | \"success\" | \"warning\" | \"critical\" | \"auto\" | \"neutral\" | \"caution\"", + "description": "The semantic tone that's applied to the text, which changes its color to convey meaning.\n\n- `info`: Informational content or helpful tips (blue).\n- `success`: Positive outcomes or successful states (green).\n- `warning`: Important warnings about potential issues (orange).\n- `critical`: Urgent problems or destructive actions (red).\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent (gray).\n- `caution`: Advisory notices that need attention (yellow).", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "type", + "value": "\"strong\" | \"generic\" | \"address\" | \"redundant\"", + "description": "The semantic type and styling treatment for the text content.\n\n- `strong`: Emphasizes the text with strong importance, typically displayed in bold.\n- `generic`: Standard text with no special semantic meaning or styling.\n- `address`: Marks the text as contact information, such as a physical or email address.\n- `redundant`: Indicates the text is redundant or duplicated information for screen reader context.", + "defaultValue": "'generic'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "dir", + "value": "\"\" | \"auto\" | \"ltr\" | \"rtl\"", + "description": "Indicates the directionality of the element’s text.\n\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n- `auto`: The user agent determines the direction based on the content.\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityVisibility", + "value": "\"visible\" | \"hidden\" | \"exclusive\"", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Text extends PreactCustomElement implements TextProps {\n accessor fontVariantNumeric: TextProps['fontVariantNumeric'];\n accessor color: TextProps['color'];\n /**\n * The semantic tone that's applied to the text, which changes its color to convey meaning.\n *\n * - `info`: Informational content or helpful tips (blue).\n * - `success`: Positive outcomes or successful states (green).\n * - `warning`: Important warnings about potential issues (orange).\n * - `critical`: Urgent problems or destructive actions (red).\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent (gray).\n * - `caution`: Advisory notices that need attention (yellow).\n */\n accessor tone: TextProps['tone'];\n /**\n * The semantic type and styling treatment for the text content.\n *\n * - `strong`: Emphasizes the text with strong importance, typically displayed in bold.\n * - `generic`: Standard text with no special semantic meaning or styling.\n * - `address`: Marks the text as contact information, such as a physical or email address.\n * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context.\n */\n accessor type: TextProps['type'];\n accessor dir: TextProps['dir'];\n accessor accessibilityVisibility: TextProps['accessibilityVisibility'];\n accessor interestFor: string;\n constructor();\n}" + } + }, + "TextArea": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextArea", + "description": "Configure the following properties on the text area component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "rows", + "value": "number", + "description": "A number of visible text lines.", + "defaultValue": "2", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | TextAutocompleteField | `section-${string} one-time-code` | \"shipping one-time-code\" | \"billing one-time-code\" | `section-${string} shipping one-time-code` | `section-${string} billing one-time-code` | `section-${string} language` | `section-${string} organization` | `section-${string} name` | ... 141...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TextArea\n extends PreactFieldElement\n implements TextAreaProps\n{\n accessor maxLength: TextAreaProps['maxLength'];\n accessor minLength: TextAreaProps['minLength'];\n accessor rows: TextAreaProps['rows'];\n /**\n * The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "TextField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextField", + "description": "Configure the following properties on the text field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "icon", + "value": "\"replace\" | \"search\" | \"split\" | \"link\" | \"edit\" | \"info\" | \"incomplete\" | \"complete\" | \"product\" | \"variant\" | \"collection\" | \"select\" | \"color\" | \"money\" | \"order\" | \"code\" | ... 542 more ... | AnyString", + "description": "An icon displayed inside the field to provide visual context about the expected input or field purpose. Commonly used for search fields, currency inputs, or to indicate field type. Accepts any icon name from the icon library or a custom string identifier.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "prefix", + "value": "string", + "description": "A non-editable text value 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`.\n\nThis text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "suffix", + "value": "string", + "description": "A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n\nThis text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.", + "defaultValue": "''", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | TextAutocompleteField | `section-${string} one-time-code` | \"shipping one-time-code\" | \"billing one-time-code\" | `section-${string} shipping one-time-code` | `section-${string} billing one-time-code` | `section-${string} language` | `section-${string} organization` | `section-${string} name` | ... 141...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class TextField\n extends PreactFieldElement\n implements TextFieldProps\n{\n accessor icon: TextFieldProps['icon'];\n accessor maxLength: TextFieldProps['maxLength'];\n accessor minLength: TextFieldProps['minLength'];\n accessor prefix: TextFieldProps['prefix'];\n accessor suffix: TextFieldProps['suffix'];\n /**\n * The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "Thumbnail": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Thumbnail", + "description": "Configure the following properties on the thumbnail component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "defaultValue": "``", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"small-200\" | \"small-100\" | \"base\" | \"large\" | \"large-100\"", + "description": "The size of the product thumbnail image.\n\n- `small-200`: Smallest thumbnail size, ideal for compact product lists or tables.\n- `small-100`: Very small thumbnail, suitable for dense layouts.\n- `small`: Small thumbnail for space-constrained contexts.\n- `base`: Default size that balances visibility and space efficiency.\n- `large`: Larger thumbnail for featured products or detailed views.\n- `large-100`: Extra large thumbnail for prominent product display.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Thumbnail extends PreactCustomElement implements ThumbnailProps {\n accessor src: ThumbnailProps['src'];\n accessor alt: ThumbnailProps['alt'];\n accessor size: ThumbnailProps['size'];\n constructor();\n}" + } + }, + "Tooltip": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Tooltip", + "description": "Configure the following properties on the tooltip component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Tooltip extends PreactOverlayElement implements TooltipProps {\n constructor();\n}" + } + }, + "UnorderedList": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "UnorderedList", + "description": "Configure the following properties on the unordered list component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class UnorderedList\n extends PreactCustomElement\n implements UnorderedListProps\n{\n constructor();\n}" + } + }, + "URLField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "URLField", + "description": "Configure the following properties on the URL field component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "autocomplete", + "value": "\"on\" | \"off\" | `section-${string} url` | `section-${string} photo` | `section-${string} impp` | `section-${string} home impp` | `section-${string} mobile impp` | `section-${string} fax impp` | `section-${string} pager impp` | \"shipping url\" | \"shipping photo\" | \"shipping impp\" | \"shipping home impp\" | \"shipping mobi...", + "description": "Controls browser autofill behavior for the field.\n\nBasic values:\n- `on` - Enables autofill without specifying content type (default)\n- `off` - Disables autofill for sensitive data or one-time codes\n\nSpecific field values describe the expected data type. You can optionally prefix these with:\n- `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n- `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n- Both section and group (for example, `section-primary shipping email`)\n\nProviding a specific autofill token helps browsers suggest more relevant saved data.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "defaultValue": "'on' for everything else", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "defaultValue": "Infinity", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "defaultValue": "0", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "value", + "value": "string", + "description": "The current URL value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as a URL format when the user finishes editing.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "labelAccessibilityVisibility", + "value": "\"visible\" | \"exclusive\"", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "defaultValue": "'visible'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "Global keyboard event handlers for things like key bindings typically ignore keystrokes originating from within input elements. Unfortunately, these never account for a Custom Element being the input element.\n\nTo fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement appear as a contentEditable \"input\" when it contains a focused input element.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "isContentEditable", + "value": "boolean", + "description": "Whether the shadow tree contains a focused input (input, textarea, select, ).\n\nNote: this does _not_ return true for focussed non-field form elements like buttons.", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "formResetCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@internals$4@2356", + "value": "ElementInternals", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class URLField\n extends PreactFieldElement\n implements URLFieldProps\n{\n accessor autocomplete: URLFieldProps['autocomplete'];\n accessor maxLength: URLFieldProps['maxLength'];\n accessor minLength: URLFieldProps['minLength'];\n /**\n * The current URL value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as a URL format when the user finishes editing.\n */\n get value(): string;\n set value(value: string);\n constructor();\n}" + } + }, + "AdminAction": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminAction", + "description": "Configure the following properties on the admin action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The text to use as the Action modal's title. If not provided, the name of the extension will be used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "loading", + "value": "boolean", + "description": "Whether the action is in a loading state, such as during initial page load or when the action is being opened. When `true`, the action might be in an inert state that prevents user interaction.", + "defaultValue": "false", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class AdminAction\n extends PreactCustomElement\n implements AdminActionProps\n{\n /**\n * The text to use as the Action modal's title. If not provided, the name of the extension will be used.\n */\n heading: string;\n /**\n * Whether the action is in a loading state, such as during initial page load or when the action is being opened.\n * When `true`, the action might be in an inert state that prevents user interaction.\n */\n loading: boolean;\n constructor();\n}" + } + }, + "RunnableExtension": { + "src/extension.ts": { + "filePath": "src/extension.ts", + "name": "RunnableExtension", + "description": "Defines the structure of a runnable extension, which executes logic and returns data without rendering UI.", + "members": [ + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "api", + "value": "Api", + "description": "The API object providing access to extension capabilities and methods. The specific API type depends on the extension target and determines what functionality is available to your extension." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "output", + "value": "Output | Promise", + "description": "The function output. Your extension function should return the expected output type or a Promise that resolves to that type. The output type is determined by your specific extension target and use case." + } + ], + "value": "export interface RunnableExtension {\n /**\n * The API object providing access to extension capabilities and methods. The specific API type depends on the extension target and determines what functionality is available to your extension.\n */\n api: Api;\n /**\n * The function output. Your extension function should return the expected output type or a Promise that resolves to that type. The output type is determined by your specific extension target and use case.\n */\n output: Output | Promise;\n}" + } + }, + "ShouldRenderApi": { + "src/surfaces/admin/api/should-render/should-render.ts": { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "name": "ShouldRenderApi", + "description": "The `ShouldRenderApi` object provides methods for controlling action extension visibility. Access the following properties on the `ShouldRenderApi` object to determine whether an associated action should appear based on the current context.", + "members": [ + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this data to determine whether the action extension should appear based on the current context." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ShouldRenderApi\n extends StandardApi {\n /**\n * An array of currently viewed or selected resource identifiers. Use this data to determine whether the action extension should appear based on the current context.\n */\n data: Data;\n}" + } + }, + "ShouldRenderOutput": { + "src/surfaces/admin/api/should-render/should-render.ts": { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "name": "ShouldRenderOutput", + "description": "The output returned by `should-render` extensions to control visibility.", + "members": [ + { + "filePath": "src/surfaces/admin/api/should-render/should-render.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "boolean", + "description": "Whether to display the associated action extension. Return `true` to show the action, `false` to hide it." + } + ], + "value": "export interface ShouldRenderOutput {\n /** Whether to display the associated action extension. Return `true` to show the action, `false` to hide it. */\n display: boolean;\n}" + } + }, + "BlockExtensionApi": { + "src/surfaces/admin/api/block/block.ts": { + "filePath": "src/surfaces/admin/api/block/block.ts", + "name": "BlockExtensionApi", + "description": "The `BlockExtensionApi` object provides methods for block extensions that render inline content on admin pages. Access the following properties on the `BlockExtensionApi` object to interact with the current context, navigate to other extensions, and display picker dialogs.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface BlockExtensionApi\n extends StandardRenderingExtensionApi {\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.\n */\n data: Data;\n\n /**\n * Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`).\n */\n navigation: Navigation;\n}" + } + }, + "Navigation": { + "src/surfaces/admin/api/block/block.ts": { + "filePath": "src/surfaces/admin/api/block/block.ts", + "name": "Navigation", + "description": "The `Navigation` object provides methods for navigating between extensions and admin pages.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/block/block.ts", + "syntaxKind": "PropertySignature", + "name": "navigate", + "value": "(url: string | URL) => void", + "description": "Navigates to a specific extension or admin route. Currently supports navigating from a block extension to an action extension on the same resource page.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "navigation.navigate('extension://my-admin-action-extension-handle')", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface Navigation {\n /**\n * Navigates to a specific extension or admin route. Currently supports navigating from a block extension to an action extension on the same resource page.\n *\n * @param url - The destination URL, typically in the format 'extension://extension-handle' for other extensions\n * @example navigation.navigate('extension://my-admin-action-extension-handle')\n */\n navigate: (url: string | URL) => void;\n}" + } + }, + "BlockExtensionComponents": { + "src/surfaces/admin/components/BlockExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/BlockExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BlockExtensionComponents", + "value": "StandardComponents | 'AdminBlock' | 'Form'", + "description": "The components available for building block extensions. Includes all standard components plus the admin block component required for block extension setup and the form component for creating forms." + } + }, + "AdminBlock": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminBlock", + "description": "Configure the following properties on the admin block component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The text displayed as the block's title in the header. If not provided, the extension name will be used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "collapsedSummary", + "value": "string", + "description": "The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class AdminBlock\n extends PreactCustomElement\n implements AdminBlockProps\n{\n /**\n * The text displayed as the block's title in the header. If not provided, the extension name will be used.\n */\n heading: string;\n /**\n * The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.\n */\n collapsedSummary: string;\n constructor();\n}" + } + }, + "Form": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Form", + "description": "Configure the following properties on the form component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Form extends PreactCustomElement implements FormProps {\n constructor();\n}" + } + }, + "AppHomeApi": { + "src/surfaces/admin/api/app-home/app-home.ts": { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "name": "AppHomeApi", + "description": "The `AppHomeApi` object provides methods for app home extensions. Access the following properties on the `AppHomeApi` object to authenticate users, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, handle intents, persist data, display toast notifications, control the Admin page-level loading indicator, and access app-level data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "app", + "value": "AppApi", + "description": "Provides access to app-level data and functionality. Use this API to query information about extensions registered for the current app, including their activation status and target information." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "AppHomeIntents", + "description": "Receives [link intents](/docs/apps/build/sidekick/build-app-data) dispatched to the app home target and resolves them when complete. Subscribe to `intents.request` to be notified each time the admin navigates the merchant to your app via a link intent, and call `intents.response.ok()` / `error()` / `closed()` to resolve the active intent.\n\nWhen you run `dev`, the CLI generates typed variants for every intent declared in `shopify.extension.toml`. Use the `WithGeneratedIntents` helper type to narrow `request.value` and `response.ok` to the generated payloads in your app code." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "LoadingApi", + "description": "Sets the Admin page-level loading indicator. Call `loading(true)` to show the loading indicator while your app home extension performs an asynchronous task. Call `loading(false)`, or call `loading()` without an argument, to hide it when the task completes." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "toast", + "value": "ToastApi", + "description": "Displays brief, non-blocking notification messages at the bottom of the page. Use the Toast API to confirm successful actions, report errors, or provide contextual feedback without interrupting the merchant's workflow." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "tools", + "value": "Tools", + "description": "Registers runtime handlers for app tools declared in your extension configuration. Use this to expose app data lookups and app actions to [Sidekick](/docs/apps/build/sidekick/build-app-data), including link intents that drive the navigate modality from the app home target.\n\nWhen you run `dev`, the CLI generates typed `register` overloads for every tool declared in `shopify.extension.toml`. Use the `WithGeneratedTools` helper type to narrow this property to the generated overloads in your app code." + } + ], + "value": "export interface AppHomeApi\n extends StandardApi {\n /**\n * Displays brief, non-blocking notification messages at the bottom of the page. Use the Toast API to confirm successful actions, report errors, or provide contextual feedback without interrupting the merchant's workflow.\n */\n toast: ToastApi;\n\n /**\n * Provides access to app-level data and functionality. Use this API to query information about extensions registered for the current app, including their activation status and target information.\n */\n app: AppApi;\n\n /**\n * Sets the Admin page-level loading indicator. Call `loading(true)` to show the loading indicator while your app home extension performs an asynchronous task. Call `loading(false)`, or call `loading()` without an argument, to hide it when the task completes.\n */\n loading: LoadingApi;\n\n /**\n * Receives [link intents](/docs/apps/build/sidekick/build-app-data) dispatched to the app home target and resolves them when complete. Subscribe to `intents.request` to be notified each time the admin navigates the merchant to your app via a link intent, and call `intents.response.ok()` / `error()` / `closed()` to resolve the active intent.\n *\n * When you run `dev`, the CLI generates typed variants for every intent declared in `shopify.extension.toml`. Use the `WithGeneratedIntents` helper type to narrow `request.value` and `response.ok` to the generated payloads in your app code.\n */\n intents: AppHomeIntents;\n\n /**\n * Registers runtime handlers for app tools declared in your extension configuration. Use this to expose app data lookups and app actions to [Sidekick](/docs/apps/build/sidekick/build-app-data), including link intents that drive the navigate modality from the app home target.\n *\n * When you run `dev`, the CLI generates typed `register` overloads for every tool declared in `shopify.extension.toml`. Use the `WithGeneratedTools` helper type to narrow this property to the generated overloads in your app code.\n */\n tools: Tools;\n}" + } + }, + "AppApi": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "AppApi", + "description": "The `AppApi` object provides methods for interacting with app-level data and functionality. Use this API to query information about extensions registered for the current app.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "extensions", + "value": "() => Promise", + "description": "Returns a list of all extensions registered for the current app, including their activation status and target information. Use this to discover what extensions are available and where they are activated." + } + ], + "value": "export interface AppApi {\n /**\n * Returns a list of all extensions registered for the current app, including their activation status and target information.\n * Use this to discover what extensions are available and where they are activated.\n *\n * @returns A promise that resolves to an array of extension information objects.\n */\n extensions: () => Promise;\n}" + } + }, + "ExtensionInfo": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "ExtensionInfo", + "description": "Information about an extension registered for the current app.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "activations", + "value": "UiExtensionActivation[] | ThemeExtensionBlockActivation[]", + "description": "The list of activations for this extension. For UI extensions, this contains target information. For theme extensions, this contains detailed block activation information." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string | null", + "description": "The unique handle identifier for this extension, if available.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "ExtensionStatus", + "description": "The current status of this extension.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "ExtensionType", + "description": "The type of extension.", + "isOptional": true + } + ], + "value": "export interface ExtensionInfo {\n /**\n * The unique handle identifier for this extension, if available.\n */\n handle?: string | null;\n\n /**\n * The list of activations for this extension. For UI extensions, this contains target information.\n * For theme extensions, this contains detailed block activation information.\n */\n activations: UiExtensionActivation[] | ThemeExtensionBlockActivation[];\n\n /**\n * The current status of this extension.\n */\n status?: ExtensionStatus;\n\n /**\n * The type of extension.\n */\n type?: ExtensionType;\n}" + } + }, + "UiExtensionActivation": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "UiExtensionActivation", + "description": "Represents an activation of a UI extension at a specific target.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "string", + "description": "The extension target where this extension is activated." + } + ], + "value": "export interface UiExtensionActivation {\n /**\n * The extension target where this extension is activated.\n */\n target: string;\n}" + } + }, + "ThemeExtensionBlockActivation": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "ThemeExtensionBlockActivation", + "description": "Represents a theme extension block activation with its status and nested activations.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "activations", + "value": "ThemeBlockActivation[]", + "description": "The list of theme-specific activations for this block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The handle identifier for this theme extension block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The display name of this theme extension block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "ExtensionStatus", + "description": "The current status of this theme extension block." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "ThemeAppBlockTarget | ThemeAppEmbedTarget", + "description": "The target location for this theme extension block or embed." + } + ], + "value": "export interface ThemeExtensionBlockActivation {\n /**\n * The target location for this theme extension block or embed.\n */\n target: ThemeAppBlockTarget | ThemeAppEmbedTarget;\n\n /**\n * The handle identifier for this theme extension block.\n */\n handle: string;\n\n /**\n * The display name of this theme extension block.\n */\n name: string;\n\n /**\n * The current status of this theme extension block.\n */\n status: ExtensionStatus;\n\n /**\n * The list of theme-specific activations for this block.\n */\n activations: ThemeBlockActivation[];\n}" + } + }, + "ThemeBlockActivation": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "name": "ThemeBlockActivation", + "description": "Represents an activation of a theme block at a specific target within a theme.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "string", + "description": "The target location within the theme." + }, + { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "PropertySignature", + "name": "themeId", + "value": "string", + "description": "The ID of the theme where this block is activated." + } + ], + "value": "export interface ThemeBlockActivation {\n /**\n * The target location within the theme.\n */\n target: string;\n\n /**\n * The ID of the theme where this block is activated.\n */\n themeId: string;\n}" + } + }, + "ExtensionStatus": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionStatus", + "value": "'active' | 'available' | 'unavailable'", + "description": "The status of an extension indicating whether it's active, available for activation, or unavailable.", + "isPublicDocs": true + } + }, + "ThemeAppBlockTarget": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ThemeAppBlockTarget", + "value": "'section'", + "description": "The target location for theme app blocks within a theme section.", + "isPublicDocs": true + } + }, + "ThemeAppEmbedTarget": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ThemeAppEmbedTarget", + "value": "'head' | 'body' | 'compliance_head'", + "description": "The target location for theme app embeds within the document.", + "isPublicDocs": true + } + }, + "ExtensionType": { + "src/surfaces/admin/api/app/app.ts": { + "filePath": "src/surfaces/admin/api/app/app.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionType", + "value": "'ui_extension' | 'theme_app_extension'", + "description": "The type of extension.", + "isPublicDocs": true + } + }, + "AppHomeIntents": { + "src/surfaces/admin/api/app-home/app-home.ts": { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "name": "AppHomeIntents", + "description": "The intents API available to app home extensions. It exposes a signal-like `request` that streams link intents into the long-running extension. Inspect `request.value` for information about the active intent.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "invoke", + "value": "IntentInvokeApi", + "description": "Launches an intent workflow for creating or editing Shopify resources.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "request", + "value": "AppHomeIntentRequest", + "description": "The current link intent delivered to the extension. Subscribe to receive new intents over the lifetime of the extension." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "response", + "value": "IntentResponseApi", + "description": "Resolves the current intent. Available only while `request.value` is non-null; the runtime swaps in a fresh handle for each new intent.", + "isOptional": true + } + ], + "value": "export interface AppHomeIntents {\n /**\n * The current link intent delivered to the extension. Subscribe to receive\n * new intents over the lifetime of the extension.\n */\n request: AppHomeIntentRequest;\n /**\n * Resolves the current intent. Available only while `request.value` is\n * non-null; the runtime swaps in a fresh handle for each new intent.\n */\n response?: IntentResponseApi;\n /**\n * Launches an intent workflow for creating or editing Shopify resources.\n */\n invoke?: IntentInvokeApi;\n}" + } + }, + "AppHomeIntentRequest": { + "src/surfaces/admin/api/app-home/app-home.ts": { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "name": "AppHomeIntentRequest", + "description": "The current link intent delivered to an app home extension. The admin pushes a new value into `request` whenever a link intent is dispatched to your app, and resets it to `null` when no intent is active.\n\nThe shape is signal-like (`value` + `subscribe`) so the running extension can observe a stream of intents over its lifetime, mirroring the behaviour the CLI's generated typings already expect via `WithGeneratedIntents`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "subscribe", + "value": "(callback: (value: IntentQueryOptions) => void) => () => void", + "description": "Subscribes to changes in the active intent. The callback is invoked with the new value whenever the admin dispatches a new intent or clears it. Returns a function that unsubscribes the callback." + }, + { + "filePath": "src/surfaces/admin/api/app-home/app-home.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "IntentQueryOptions | null", + "description": "The intent that's currently being delivered to the extension, or `null` when no intent is active." + } + ], + "value": "export interface AppHomeIntentRequest {\n /**\n * The intent that's currently being delivered to the extension, or `null`\n * when no intent is active.\n */\n readonly value: IntentQueryOptions | null;\n /**\n * Subscribes to changes in the active intent. The callback is invoked with\n * the new value whenever the admin dispatches a new intent or clears it.\n * Returns a function that unsubscribes the callback.\n */\n subscribe: (\n callback: (value: IntentQueryOptions | null) => void,\n ) => () => void;\n}" + } + }, + "IntentQueryOptions": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentQueryOptions", + "description": "Additional parameters for intent invocation when using the string query format. Use these options to provide resource IDs for editing or pass required context data for resource creation.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ [key: string]: unknown; }", + "description": "Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.", + "isOptional": true + } + ], + "value": "export interface IntentQueryOptions {\n /**\n * The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.\n */\n value?: string;\n /**\n * Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.\n */\n data?: {[key: string]: unknown};\n}" + } + }, + "LoadingApi": { + "src/surfaces/admin/api/loading/loading.ts": { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "name": "LoadingApi", + "description": "Sets the Admin page-level loading indicator for hosted app home extensions.\n\nCall with `true` to start loading. Call with `false`, or without an argument, to stop loading.", + "isPublicDocs": true, + "params": [ + { + "name": "isLoading", + "description": "", + "value": "boolean", + "isOptional": true, + "filePath": "src/surfaces/admin/api/loading/loading.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(isLoading?: boolean) => void" + } + }, + "ToastApi": { + "src/surfaces/admin/api/toast/toast.ts": { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "name": "ToastApi", + "description": "The `ToastApi` object provides methods for displaying temporary notification messages. Access these methods through `shopify.toast` to show user feedback and status updates.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "() => void", + "description": "Dismisses any currently visible toast notification. Use this to programmatically hide a toast before its duration expires." + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "(message: string, options?: ToastOptions) => void", + "description": "Displays a toast notification with the specified message. The toast appears as a temporary overlay that automatically dismisses after the specified duration. Use for providing immediate user feedback, confirming actions, or communicating status updates without interrupting the user's workflow." + } + ], + "value": "export interface ToastApi {\n /**\n * Displays a toast notification with the specified message. The toast appears as a temporary overlay that automatically dismisses after the specified duration. Use for providing immediate user feedback, confirming actions, or communicating status updates without interrupting the user's workflow.\n *\n * @param message - The text content to display in the toast notification.\n * @param options - Optional configuration for the toast behavior and appearance.\n */\n show: (message: string, options?: ToastOptions) => void;\n\n /**\n * Dismisses any currently visible toast notification. Use this to programmatically hide a toast before its duration expires.\n */\n hide: () => void;\n}" + } + }, + "ToastOptions": { + "src/surfaces/admin/api/toast/toast.ts": { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "name": "ToastOptions", + "description": "Options for configuring toast notification behavior and appearance.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "string", + "description": "The label for an optional action button displayed in the toast. When provided, an action button appears that the user can click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "duration", + "value": "number", + "description": "The duration in milliseconds to display the toast before automatically dismissing. If not specified, a default duration is used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "isError", + "value": "boolean", + "description": "Whether to display the toast as an error notification. Use for error messages or failed operations.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "onAction", + "value": "() => void", + "description": "Callback function triggered when the user clicks the action button. Only called if `action` is provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/toast/toast.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "() => void", + "description": "Callback function triggered when the toast is dismissed, either automatically after the duration expires or manually by the user.", + "isOptional": true + } + ], + "value": "export interface ToastOptions {\n /**\n * The duration in milliseconds to display the toast before automatically dismissing. If not specified, a default duration is used.\n */\n duration?: number;\n\n /**\n * Whether to display the toast as an error notification. Use for error messages or failed operations.\n * @defaultValue false\n */\n isError?: boolean;\n\n /**\n * The label for an optional action button displayed in the toast. When provided, an action button appears that the user can click.\n */\n action?: string;\n\n /**\n * Callback function triggered when the user clicks the action button. Only called if `action` is provided.\n */\n onAction?: () => void;\n\n /**\n * Callback function triggered when the toast is dismissed, either automatically after the duration expires or manually by the user.\n */\n onDismiss?: () => void;\n}" + } + }, + "Tools": { + "src/surfaces/admin/api/tools/tools.ts": { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "name": "Tools", + "description": "The `Tools` object provides methods for registering and removing runtime handlers for app tools declared in your extension configuration. Use this API to expose app data lookups and app actions that [Sidekick](/docs/apps/build/sidekick/build-app-data) can invoke on behalf of merchants.\n\nThe base `register` signature accepts any tool name and a generic handler. When you run `dev`, the CLI generates a typed `register` overload for every tool declared in `shopify.extension.toml`, narrowing both the accepted name and the handler's `input`/return types. Use the `WithGeneratedTools` helper to merge the generated typings into your target's API.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "syntaxKind": "PropertySignature", + "name": "clear", + "value": "() => void", + "description": "Unregisters every tool handler currently registered by your extension." + }, + { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "syntaxKind": "PropertySignature", + "name": "register", + "value": "(name: string, handler: ToolHandler) => () => void", + "description": "Registers a tool handler for your app. If a handler with the same name is already registered, it is replaced. Returns a cleanup function that unregisters the handler." + }, + { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "syntaxKind": "PropertySignature", + "name": "unregister", + "value": "(name: string) => void", + "description": "Unregisters a previously registered tool handler. Calling this for a tool that isn't registered is a no-op." + } + ], + "value": "export interface Tools {\n /**\n * Registers a tool handler for your app. If a handler with the same name is\n * already registered, it is replaced. Returns a cleanup function that\n * unregisters the handler.\n *\n * @param name - The tool name as declared in your extension configuration.\n * @param handler - The function invoked when the tool is called.\n * @returns A function that unregisters the handler when invoked.\n */\n register: (name: string, handler: ToolHandler) => () => void;\n\n /**\n * Unregisters a previously registered tool handler. Calling this for a tool\n * that isn't registered is a no-op.\n *\n * @param name - The tool name to unregister.\n */\n unregister: (name: string) => void;\n\n /**\n * Unregisters every tool handler currently registered by your extension.\n */\n clear: () => void;\n}" + } + }, + "ToolHandler": { + "src/surfaces/admin/api/tools/tools.ts": { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "name": "ToolHandler", + "description": "A handler function invoked by the platform when a registered tool is called. The handler receives an `input` object that matches the tool's declared input JSON schema and must return (synchronously or asynchronously) an object that matches the declared output JSON schema.\n\nGenerated tool typings narrow the `input` and return value of this handler for each registered tool name. This base signature is the generic fallback used before code generation has run, or for tools that aren't yet declared in your extension configuration.", + "isPublicDocs": true, + "params": [ + { + "name": "input", + "description": "", + "value": "Record", + "filePath": "src/surfaces/admin/api/tools/tools.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/tools/tools.ts", + "description": "", + "name": "Record | Promise>", + "value": "Record | Promise>" + }, + "value": "(\n input: Record,\n) => Record | Promise>" + } + }, + "FormExtensionComponents": { + "src/surfaces/admin/components/FormExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/FormExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "FormExtensionComponents", + "value": "StandardComponents | 'Form'", + "description": "The components available for building form-based extensions. Includes all standard components plus the form component for creating structured data collection interfaces with submission handling and validation." + } + }, + "Modal": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Modal", + "description": "Configure the following properties on the modal component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "accessibilityLabel", + "value": "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.\n\nThis overrides the `heading` prop for screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "padding", + "value": "\"base\" | \"none\"", + "description": "Adjust the padding around the modal content.\n\n`base`: applies padding that is appropriate for the element.\n\n`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.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "size", + "value": "\"small\" | \"small-100\" | \"base\" | \"large\" | \"large-100\"", + "description": "The size of the modal component, controlling its width and height. Larger sizes provide more space for content while smaller sizes are more compact.", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "showOverlay", + "value": "() => void", + "description": "A method to programmatically show the overlay.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "toggleOverlay", + "value": "() => void", + "description": "A method to programmatically toggle the visibility of the overlay.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@abortController@2785", + "value": "AbortController", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@dialog@2779", + "value": "HTMLDialogElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@focusedElement@2781", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@nestedModals@2783", + "value": "Map", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@childrenRerenderObserver@2787", + "value": "MutationObserver", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@shadowDomRerenderObserver@2788", + "value": "MutationObserver", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@onEscape@2782", + "value": "(event: KeyboardEvent) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@onBackdropClick@2784", + "value": "(event: MouseEvent) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@onChildModalChange@2786", + "value": "EventListenerOrEventListenerObject", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "__@isOpen@2778", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@dismiss@2780", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "GetAccessor", + "name": "__@hasOpenChildModal@2775", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@show@2776", + "value": "() => Promise", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "__@hide@2777", + "value": "() => Promise", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Modal extends PreactOverlayElement implements ModalProps {\n accessor accessibilityLabel: ModalProps['accessibilityLabel'];\n accessor heading: ModalProps['heading'];\n accessor padding: ModalProps['padding'];\n accessor size: ModalProps['size'];\n /** @private */\n [abortController]: AbortController;\n /** @private */\n [dialog]: HTMLDialogElement | null;\n /** @private */\n [focusedElement]: HTMLElement | null;\n /** @private */\n [nestedModals]: Map;\n /** @private */\n [childrenRerenderObserver]: MutationObserver;\n /** @private */\n [shadowDomRerenderObserver]: MutationObserver;\n /** @private */\n [onEscape]: (event: KeyboardEvent) => void;\n /** @private */\n [onBackdropClick]: (event: MouseEvent) => void;\n /** @private */\n [onChildModalChange]: EventListenerOrEventListenerObject;\n /** @private */\n get [isOpen](): boolean;\n /** @private */\n [dismiss](): void;\n /** @private */\n get [hasOpenChildModal](): boolean;\n /** @private */\n [show](): Promise;\n /** @private */\n [hide](): Promise;\n showOverlay(): void;\n hideOverlay(): void;\n toggleOverlay(): void;\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n constructor();\n}" + } + }, + "Page": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Page", + "description": "Use as the outer wrapper of a page.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "\"small\" | \"base\" | \"large\"", + "description": "The inline size of the page\n- `base` corresponds to a set default inline size\n- `large` full width with whitespace", + "defaultValue": "'base'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "heading", + "value": "string", + "description": "The main page heading", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Page extends PreactCustomElement implements PageProps {\n accessor inlineSize: PageProps['inlineSize'];\n accessor heading: PageProps['heading'];\n constructor();\n /** @private */\n connectedCallback(): void;\n /** @private */\n disconnectedCallback(): void;\n}" + } + }, + "IntentRenderApi": { + "src/surfaces/admin/api/intents/intent-render.ts": { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "name": "IntentRenderApi", + "description": "The `IntentRenderApi` object provides methods for extensions that render in response to an app intent. Access the intent data to determine what action the merchant requested and use `intents.response` to resolve the intent when complete.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "IntentRenderIntents", + "description": "Provides methods for resolving the current intent. Always available for intent render extensions since they are always invoked inside an intent workflow." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface IntentRenderApi\n extends StandardRenderingExtensionApi {\n /**\n * Provides methods for resolving the current intent. Always available for intent render extensions since they are always invoked inside an intent workflow.\n */\n intents: IntentRenderIntents;\n}" + } + }, + "IntentRenderIntents": { + "src/surfaces/admin/api/intents/intent-render.ts": { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "name": "IntentRenderIntents", + "description": "The intents API available to intent render extensions. Unlike other targets where `response` is optional, intent render extensions always run inside an intent workflow so `response` is guaranteed.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intent-render.ts", + "syntaxKind": "PropertySignature", + "name": "response", + "value": "IntentResponseApi", + "description": "Resolves the current intent from within the invoked extension. Use `ok()` to signal success, `error()` to report failure, or `closed()` to indicate the merchant cancelled." + } + ], + "value": "export interface IntentRenderIntents {\n /**\n * Resolves the current intent from within the invoked extension. Use `ok()` to signal success, `error()` to report failure, or `closed()` to indicate the merchant cancelled.\n */\n response: IntentResponseApi;\n}" + } + }, + "StandardApi": { + "src/surfaces/admin/api/standard/standard.ts": { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "name": "StandardApi", + "description": "The `StandardApi` object provides core methods available to all extension targets. Access the following properties on the `StandardApi` object to authenticate users, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, handle intents, and persist data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface StandardApi {\n /**\n * The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context.\n */\n extension: {\n target: ExtensionTarget;\n };\n\n /**\n * Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations.\n */\n auth: Auth;\n\n /**\n * Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience.\n */\n i18n: I18n;\n\n /**\n * Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation.\n */\n intents: Intents;\n\n /**\n * Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension.\n */\n storage: Storage;\n\n /**\n * Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query.\n */\n query: (\n query: string,\n options?: {variables?: Variables; version?: Omit},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n}" + } + }, + "CustomerSegmentTemplateApi": { + "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts": { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "name": "CustomerSegmentTemplateApi", + "description": "The `CustomerSegmentTemplateApi` object provides methods for creating customer segment templates. Access the following properties on the `CustomerSegmentTemplateApi` object to build templates with translated content.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "__enabledFeatures", + "value": "string[]", + "description": "", + "isPrivate": true + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating template content into the merchant's language." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface CustomerSegmentTemplateApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardApi {\n /** Utilities for translating template content into the merchant's language. */\n i18n: I18n;\n /** @private */\n __enabledFeatures: string[];\n}" + } + }, + "CustomerSegmentTemplate": { + "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts": { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "name": "CustomerSegmentTemplate", + "description": "Defines a customer segment template that merchants can use to create targeted customer groups.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "createdOn", + "value": "string", + "description": "The creation date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Templates created within the last month display a \"New\" badge." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "dependencies", + "value": "{ standardMetafields?: \"facts.birth_date\"[]; customMetafields?: string[]; }", + "description": "Customer metafields required by this template's query. Declare dependencies so the admin can guide merchants to set up required metafields before using the template.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string | string[]", + "description": "The template description in the merchant's language. Use an array for multiple paragraphs." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "string", + "description": "The segment query code to display in the template with syntax highlighting. This code is shown to merchants but not validated. Test your queries in the Shopify admin segment editor before including them in templates." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "queryToInsert", + "value": "string", + "description": "The segment query code to insert when the merchant selects this template. If omitted, the `query` value is used instead. This code is inserted into the editor but not validated. Test your queries in the Shopify admin segment editor before including them in templates." + }, + { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The template title in the merchant's language." + } + ], + "value": "export interface CustomerSegmentTemplate {\n /**\n * The template title in the merchant's language.\n */\n title: string;\n /**\n * The template description in the merchant's language. Use an array for multiple paragraphs.\n */\n description: string | string[];\n /**\n * The segment query code to display in the template with syntax highlighting. This code is shown to merchants but not validated. Test your queries in the Shopify admin segment editor before including them in templates.\n */\n query: string;\n /**\n * The segment query code to insert when the merchant selects this template. If omitted, the `query` value is used instead. This code is inserted into the editor but not validated. Test your queries in the Shopify admin segment editor before including them in templates.\n */\n queryToInsert: string;\n /**\n * Customer metafields required by this template's query. Declare dependencies so the admin can guide merchants to set up required metafields before using the template.\n */\n dependencies?: {\n /** Standard Shopify customer metafields used in the query. */\n standardMetafields?: CustomerStandardMetafieldDependency[];\n /** Custom [metafield](/docs/apps/build/metafields) definitions used in the query. */\n customMetafields?: string[];\n };\n /**\n * The creation date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Templates created within the last month display a \"New\" badge.\n */\n createdOn: string;\n}" + } + }, + "DiscountFunctionSettingsApi": { + "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "name": "DiscountFunctionSettingsApi", + "description": "The `DiscountFunctionSettingsApi` object provides methods for configuring discount functions. Access the following properties on the `DiscountFunctionSettingsApi` object to manage function settings and metafields.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "applyMetafieldChange", + "value": "ApplyMetafieldChange", + "description": "Updates or removes [metafields](/docs/apps/build/metafields) that store discount function configuration. Use this to save merchant settings for your discount function." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "DiscountFunctionSettingsData", + "description": "The discount being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "discounts", + "value": "DiscountsApi", + "description": "The `discounts` object provides reactive access to discount configuration, including discount classes and the discount method. Use the signals to read current values and the update functions to modify discount classes in your settings UI. These values automatically update when changed by the merchant or system." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface DiscountFunctionSettingsApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends Omit, 'data'> {\n /**\n * Updates or removes [metafields](/docs/apps/build/metafields) that store discount function configuration. Use this to save merchant settings for your discount function.\n */\n applyMetafieldChange: ApplyMetafieldChange;\n /** The discount being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings. */\n data: DiscountFunctionSettingsData;\n /** The `discounts` object provides reactive access to discount configuration, including discount classes and the discount method. Use the signals to read current values and the update functions to modify discount classes in your settings UI. These values automatically update when changed by the merchant or system. */\n discounts: DiscountsApi;\n}" + } + }, + "ApplyMetafieldChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "ApplyMetafieldChange", + "description": "A function that applies metafield changes to discount function settings. Call this function with an update or removal operation, then await the Promise to receive a result indicating success or failure. Use the result to provide feedback or handle errors in your settings interface.", + "isPublicDocs": true, + "params": [ + { + "name": "change", + "description": "", + "value": "MetafieldChange", + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "description": "", + "name": "Promise", + "value": "Promise" + }, + "value": "(\n change: MetafieldChange,\n) => Promise" + } + }, + "MetafieldChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldChange", + "value": "MetafieldUpdateChange | MetafieldRemoveChange", + "description": "A metafield change operation that can either update or remove a metafield. Pass this to `applyMetafieldChange` to modify discount settings stored in metafields.", + "isPublicDocs": true + } + }, + "MetafieldUpdateChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldUpdateChange", + "description": "A metafield update or creation operation. Use this to set or modify metafield values that store discount function configuration data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The unique key identifying the metafield within its namespace. Use descriptive keys that indicate the setting's purpose (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`)." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace that organizes related metafields. When omitted, a default namespace is assigned. Use consistent namespaces to group related settings.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updateMetafield'", + "description": "Identifies this as an update operation. Always set to `'updateMetafield'` for updates." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string | number", + "description": "The metafield value to store. Can be a string or number depending on your configuration needs." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "valueType", + "value": "SupportedDefinitionType", + "description": "The [data type](/docs/apps/build/metafields/list-of-data-types) that defines how the value is formatted and validated. When omitted, preserves the existing type for updates or uses a default for new metafields. Choose a type that matches your value format.", + "isOptional": true + } + ], + "value": "export interface MetafieldUpdateChange {\n /** Identifies this as an update operation. Always set to `'updateMetafield'` for updates. */\n type: 'updateMetafield';\n /** The unique key identifying the metafield within its namespace. Use descriptive keys that indicate the setting's purpose (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`). */\n key: string;\n /** The namespace that organizes related metafields. When omitted, a default namespace is assigned. Use consistent namespaces to group related settings. */\n namespace?: string;\n /** The metafield value to store. Can be a string or number depending on your configuration needs. */\n value: string | number;\n /** The [data type](/docs/apps/build/metafields/list-of-data-types) that defines how the value is formatted and validated. When omitted, preserves the existing type for updates or uses a default for new metafields. Choose a type that matches your value format. */\n valueType?: SupportedDefinitionType;\n}" + } + }, + "MetafieldRemoveChange": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldRemoveChange", + "description": "A metafield removal operation. Use this to delete metafields that are no longer needed for your discount configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The unique key of the metafield to remove. Must match the key used when the metafield was created." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace containing the metafield to remove. Required to ensure the correct metafield is targeted, as the same key can exist in different namespaces." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'removeMetafield'", + "description": "Identifies this as a removal operation. Always set to `'removeMetafield'` for deletions." + } + ], + "value": "export interface MetafieldRemoveChange {\n /** Identifies this as a removal operation. Always set to `'removeMetafield'` for deletions. */\n type: 'removeMetafield';\n /** The unique key of the metafield to remove. Must match the key used when the metafield was created. */\n key: string;\n /** The namespace containing the metafield to remove. Required to ensure the correct metafield is targeted, as the same key can exist in different namespaces. */\n namespace: string;\n}" + } + }, + "MetafieldChangeResult": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldChangeResult", + "value": "MetafieldChangeSuccess | MetafieldChangeResultError", + "description": "The result returned after attempting to change a metafield. Check the `type` property to determine if the operation succeeded (`'success'`) or failed (`'error'`), then handle the result appropriately in your extension.", + "isPublicDocs": true + } + }, + "MetafieldChangeSuccess": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldChangeSuccess", + "description": "A successful metafield change operation result. The metafield was updated or removed as requested and the changes are now saved.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates the operation succeeded. When this value is `'success'`, the metafield change was applied successfully." + } + ], + "value": "export interface MetafieldChangeSuccess {\n /** Indicates the operation succeeded. When this value is `'success'`, the metafield change was applied successfully. */\n type: 'success';\n}" + } + }, + "MetafieldChangeResultError": { + "src/surfaces/admin/api/discount-function-settings/metafields.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "name": "MetafieldChangeResultError", + "description": "A failed metafield change operation result. Use the error message to understand what went wrong and fix the issue, such as validation errors, permission problems, or invalid metafield types.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A human-readable error message explaining why the operation failed. Use this to debug issues or display feedback to merchants." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates the operation failed. Check this value to determine if you need to handle an error." + } + ], + "value": "export interface MetafieldChangeResultError {\n /** Indicates the operation failed. Check this value to determine if you need to handle an error. */\n type: 'error';\n /** A human-readable error message explaining why the operation failed. Use this to debug issues or display feedback to merchants. */\n message: string;\n}" + } + }, + "DiscountFunctionSettingsData": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "name": "DiscountFunctionSettingsData", + "description": "The `data` object exposed to discount function settings extensions in the `admin.discount-details.function-settings.render` target. Use this to access the current discount configuration and populate your settings interface with existing values.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The discount's unique global identifier (GID) in the [GraphQL Admin API](/docs/api/admin-graphql) format (for example, `gid://shopify/DiscountAutomaticApp/123`). Use this ID to associate settings with the correct discount or query discount data." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "An array of [metafields](/docs/apps/build/metafields) that store the discount function's configuration values. Use these metafields to populate your settings UI with the current discount configuration and display existing settings to merchants." + } + ], + "value": "export interface DiscountFunctionSettingsData {\n /** The discount's unique global identifier (GID) in the [GraphQL Admin API](/docs/api/admin-graphql) format (for example, `gid://shopify/DiscountAutomaticApp/123`). Use this ID to associate settings with the correct discount or query discount data. */\n id: string;\n /** An array of [metafields](/docs/apps/build/metafields) that store the discount function's configuration values. Use these metafields to populate your settings UI with the current discount configuration and display existing settings to merchants. */\n metafields: Metafield[];\n}" + } + }, + "Metafield": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "name": "Metafield", + "description": "A [metafield](/docs/apps/build/metafields) that stores discount function configuration data. Use metafields to persist settings that control how your discount function behaves, such as discount thresholds, eligibility rules, or custom discount logic parameters.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "A human-readable description explaining the metafield's purpose and how it affects discount behavior. Use this to document your settings for other developers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique global identifier (GID) for this metafield. Use this ID to reference the metafield in GraphQL queries or updates." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The unique key identifying this metafield within its namespace. This key determines how you access the metafield value (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`)." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace that organizes related metafields together. All metafields for a discount should use a consistent namespace to group related settings." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The metafield [definition type](/docs/apps/build/metafields/list-of-data-types) that specifies the value format and validation rules. Use this to determine how to parse and display the value." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The metafield value stored as a string. Parse this value according to the metafield type to use it in your settings UI." + } + ], + "value": "export interface Metafield {\n /** A human-readable description explaining the metafield's purpose and how it affects discount behavior. Use this to document your settings for other developers. */\n description?: string;\n /** The unique global identifier (GID) for this metafield. Use this ID to reference the metafield in GraphQL queries or updates. */\n id: string;\n /** The namespace that organizes related metafields together. All metafields for a discount should use a consistent namespace to group related settings. */\n namespace: string;\n /** The unique key identifying this metafield within its namespace. This key determines how you access the metafield value (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`). */\n key: string;\n /** The metafield value stored as a string. Parse this value according to the metafield type to use it in your settings UI. */\n value: string;\n /** The metafield [definition type](/docs/apps/build/metafields/list-of-data-types) that specifies the value format and validation rules. Use this to determine how to parse and display the value. */\n type: string;\n}" + } + }, + "DiscountsApi": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "name": "DiscountsApi", + "description": "The `DiscountsApi` object provides reactive access to discount configuration. Use the signals to read discount classes and method, and the update function to change which parts of the purchase (products, order, or shipping) the discount affects.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "discountClasses", + "value": "ReadonlySignalLike", + "description": "A signal that contains the discount classes (Product, Order, or Shipping). Read this to determine where the discount applies in the purchase flow. A discount can apply to multiple classes simultaneously." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "discountMethod", + "value": "ReadonlySignalLike", + "description": "A signal that contains the discount method (`'automatic'` or `'code'`). Read this to determine whether the discount applies automatically at checkout or requires a customer-entered code." + }, + { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "updateDiscountClasses", + "value": "UpdateSignalFunction", + "description": "A function that updates the discount classes to change where the discount applies. Call this function with an array of `DiscountClass` values to set which parts of the purchase (products, order total, or shipping) the discount affects." + } + ], + "value": "export interface DiscountsApi {\n /**\n * A signal that contains the discount classes (Product, Order, or Shipping). Read this to determine where the discount applies in the purchase flow. A discount can apply to multiple classes simultaneously.\n */\n discountClasses: ReadonlySignalLike;\n /**\n * A function that updates the discount classes to change where the discount applies. Call this function with an array of `DiscountClass` values to set which parts of the purchase (products, order total, or shipping) the discount affects.\n */\n updateDiscountClasses: UpdateSignalFunction;\n /**\n * A signal that contains the discount method (`'automatic'` or `'code'`). Read this to determine whether the discount applies automatically at checkout or requires a customer-entered code.\n */\n discountMethod: ReadonlySignalLike;\n}" + } + }, + "ReadonlySignalLike": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "ReadonlySignalLike", + "description": "Represents a reactive signal interface that provides both immediate value access and subscription-based updates. Enables real-time synchronization with changing data through the observer pattern.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "MethodSignature", + "name": "subscribe", + "value": "(fn: (value: T) => void) => () => void", + "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "T", + "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." + } + ], + "value": "export interface ReadonlySignalLike {\n /**\n * The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup.\n */\n readonly value: T;\n /**\n * Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value.\n */\n subscribe(fn: (value: T) => void): () => void;\n}" + } + }, + "DiscountClass": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DiscountClass", + "value": "'product' | 'order' | 'shipping'", + "description": "The discount class that determines where the discount applies in the purchase flow. Use this to understand what type of discount the merchant is configuring (product-level, order-level, or shipping).", + "isPublicDocs": true + } + }, + "DiscountMethod": { + "src/surfaces/admin/api/discount-function-settings/launch-options.ts": { + "filePath": "src/surfaces/admin/api/discount-function-settings/launch-options.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DiscountMethod", + "value": "'automatic' | 'code'", + "description": "The method used to apply a discount. Use `'automatic'` for discounts that apply automatically at checkout, or `'code'` for discounts that require a code entered by the customer.", + "isPublicDocs": true + } + }, + "UpdateSignalFunction": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "UpdateSignalFunction", + "description": "A function that updates a signal and returns a result indicating success or failure. The function is typically used along with a `ReadonlySignalLike` object.", + "params": [ + { + "name": "value", + "description": "", + "value": "T", + "filePath": "src/shared.ts" + } + ], + "returns": { + "filePath": "src/shared.ts", + "description": "", + "name": "Result", + "value": "Result" + }, + "value": "(value: T) => Result" + } + }, + "Result": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Result", + "value": "{success: true; value: T} | {success: false; errors: ValidationError[]}", + "description": "A result type that indicates the success or failure of an operation." + } + }, + "ValidationError": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "ValidationError", + "description": "A validation error object that is returned when an operation fails.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A code identifier for the error." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "issues", + "value": "{ message: string; path: string[]; }[]", + "description": "Field-level validation issues", + "isOptional": true + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message describing the error." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "" + } + ], + "value": "interface ValidationError {\n type: 'error';\n /**\n * A message describing the error.\n */\n message: string;\n /**\n * A code identifier for the error.\n */\n code: string;\n /**\n * Field-level validation issues\n */\n issues?: {\n message: string;\n path: string[];\n }[];\n}" + } + }, + "FunctionSettingsComponents": { + "src/surfaces/admin/components/FunctionSettingsComponents.ts": { + "filePath": "src/surfaces/admin/components/FunctionSettingsComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "FunctionSettingsComponents", + "value": "FormExtensionComponents | 'FunctionSettings'", + "description": "The components available for building function settings extensions. Includes all form components plus the function settings component required for function settings configuration." + } + }, + "FunctionSettings": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionSettings", + "description": "Configure the following properties on the function settings component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class FunctionSettings\n extends PreactCustomElement\n implements FunctionSettingsProps\n{\n constructor();\n}" + } + }, + "PrintActionExtensionApi": { + "src/surfaces/admin/api/print-action/print-action.ts": { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "name": "PrintActionExtensionApi", + "description": "The `PrintActionExtensionApi` object provides methods for print action extensions that generate custom printable documents. Access the following properties on the `PrintActionExtensionApi` object to access selected resources and display picker dialogs for print configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "An array of currently viewed or selected resource identifiers. Use this to access the IDs of items to include in the print document, such as selected orders or products." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/print-action/print-action.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface PrintActionExtensionApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardRenderingExtensionApi {\n /**\n * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items to include in the print document, such as selected orders or products.\n */\n data: Data;\n}" + } + }, + "PrintActionExtensionComponents": { + "src/surfaces/admin/components/PrintActionExtensionComponents.ts": { + "filePath": "src/surfaces/admin/components/PrintActionExtensionComponents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PrintActionExtensionComponents", + "value": "StandardComponents | 'AdminPrintAction'", + "description": "The components available for building print action extensions. Includes all standard components plus the admin print action component required for print action setup." + } + }, + "AdminPrintAction": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminPrintAction", + "description": "Configure the following properties on the admin print action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "src", + "value": "string", + "description": "The `src` URL of the preview and the document to print. If not provided, the preview will show an empty state and the print button will be disabled. HTML, PDFs, and images are supported.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class AdminPrintAction\n extends PreactCustomElement\n implements AdminPrintActionProps\n{\n /**\n * The `src` URL of the preview and the document to print.\n * If not provided, the preview will show an empty state and the print button will be disabled.\n * HTML, PDFs, and images are supported.\n */\n src: string;\n constructor();\n}" + } + }, + "ProductDetailsConfigurationApi": { + "src/surfaces/admin/api/product-configuration/product-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "name": "ProductDetailsConfigurationApi", + "description": "The `ProductDetailsConfigurationApi` object provides methods for configuring product bundles and relationships. Access the following properties on the `ProductDetailsConfigurationApi` object to build product configuration interfaces.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data & { product: Product; app: { launchUrl: string; applicationUrl: string; }; }", + "description": "Product configuration data including the current product, selected items, and app URLs. Use this to access the product being configured and build your configuration interface." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ProductDetailsConfigurationApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends BlockExtensionApi {\n /** Product configuration data including the current product, selected items, and app URLs. Use this to access the product being configured and build your configuration interface. */\n data: Data & {\n /**\n * The product currently being viewed in the admin.\n * @deprecated\n */\n product: Product;\n /** URLs for launching and navigating to your app, including the launch URL and base application URL. Use these to create links or redirect merchants to your app. */\n app: {\n launchUrl: string;\n applicationUrl: string;\n };\n };\n}" + } + }, + "Product": { + "src/surfaces/admin/api/product-configuration/product-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "name": "Product", + "description": "A product configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The URL-friendly unique identifier used in product URLs (for example, `'blue-t-shirt'`)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "hasOnlyDefaultVariant", + "value": "boolean", + "description": "Whether the product has only the default variant with no custom options. When `true`, the product has no size, color, or other option variations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The product's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "onlineStoreUrl", + "value": "string", + "description": "The URL to view this product on the online store. Use this to create \"View in store\" links.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "options", + "value": "{ id: string; name: string; position: number; values: string[]; }[]", + "description": "Product options that define how variants differ (for example, Size, Color, Material). Each option has an ID, name, position, and array of possible values." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productCategory", + "value": "string", + "description": "The standardized product category taxonomy. Use this for product classification in search and organization.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productComponents", + "value": "ProductComponent[]", + "description": "An array of component products that make up this bundle. Each component represents a product included in the bundle configuration." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productType", + "value": "string", + "description": "The product category or type used for organization (for example, \"T-Shirt\", \"Shoes\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "status", + "value": "'ACTIVE' | 'ARCHIVED' | 'DRAFT'", + "description": "The publication status indicating whether the product is active (published), archived (discontinued), or draft (unpublished)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The product's display name shown to merchants and customers." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "totalInventory", + "value": "number", + "description": "The total available inventory summed across all variants and locations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "totalVariants", + "value": "number", + "description": "The total number of variants this product has." + } + ], + "value": "export interface Product {\n /** The product's unique global identifier (GID). */\n id: string;\n /** The product's display name shown to merchants and customers. */\n title: string;\n /** The URL-friendly unique identifier used in product URLs (for example, `'blue-t-shirt'`). */\n handle: string;\n /** The publication status indicating whether the product is active (published), archived (discontinued), or draft (unpublished). */\n status: 'ACTIVE' | 'ARCHIVED' | 'DRAFT';\n /** The total number of variants this product has. */\n totalVariants: number;\n /** The total available inventory summed across all variants and locations. */\n totalInventory: number;\n /** Whether the product has only the default variant with no custom options. When `true`, the product has no size, color, or other option variations. */\n hasOnlyDefaultVariant: boolean;\n /** The URL to view this product on the online store. Use this to create \"View in store\" links. */\n onlineStoreUrl?: string;\n /** Product options that define how variants differ (for example, Size, Color, Material). Each option has an ID, name, position, and array of possible values. */\n options: {\n id: string;\n name: string;\n position: number;\n values: string[];\n }[];\n /** The product category or type used for organization (for example, \"T-Shirt\", \"Shoes\"). */\n productType: string;\n /** The standardized product category taxonomy. Use this for product classification in search and organization. */\n productCategory?: string;\n /** An array of component products that make up this bundle. Each component represents a product included in the bundle configuration. */\n productComponents: ProductComponent[];\n}" + } + }, + "ProductComponent": { + "src/surfaces/admin/api/product-configuration/product-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "name": "ProductComponent", + "description": "A component product that is part of a bundle. Represents an individual product included in a bundle configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "componentVariantsCount", + "value": "number", + "description": "The count of variants from this product that are used as bundle components. Use this to understand how many variants are configured in bundles." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "featuredImage", + "value": "{\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null", + "description": "The featured image displayed for this component product with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The component product's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "nonComponentVariantsCount", + "value": "number", + "description": "The count of variants from this product that aren't used in any bundles. Use this to identify available variants for adding to bundle configurations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productUrl", + "value": "string", + "description": "The admin URL for this component product. Use this to create links to the product's details page in the admin." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The product's display name. Use this to show which product is included in the bundle." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "totalVariants", + "value": "number", + "description": "The total number of variants this component product has. Use this to determine if variant selection is needed for this component." + } + ], + "value": "export interface ProductComponent {\n /** The component product's unique global identifier (GID). */\n id: string;\n /** The product's display name. Use this to show which product is included in the bundle. */\n title: string;\n /** The featured image displayed for this component product with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces. */\n featuredImage?: {\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null;\n /** The total number of variants this component product has. Use this to determine if variant selection is needed for this component. */\n totalVariants: number;\n /** The admin URL for this component product. Use this to create links to the product's details page in the admin. */\n productUrl: string;\n /** The count of variants from this product that are used as bundle components. Use this to understand how many variants are configured in bundles. */\n componentVariantsCount: number;\n /** The count of variants from this product that aren't used in any bundles. Use this to identify available variants for adding to bundle configurations. */\n nonComponentVariantsCount: number;\n}" + } + }, + "PurchaseOptionsCardConfigurationApi": { + "src/surfaces/admin/api/purchase-options-card-action.ts": { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "name": "PurchaseOptionsCardConfigurationApi", + "description": "The `PurchaseOptionsCardConfigurationApi` object provides methods for action extensions that interact with purchase options and selling plans. Access the following properties on the `PurchaseOptionsCardConfigurationApi` object to work with selected products and their associated subscription configurations.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "close", + "value": "() => void", + "description": "Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ selected: { id: string; sellingPlanId?: string; }[]; }", + "description": "Selected purchase option data including product and selling plan identifiers." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/purchase-options-card-action.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface PurchaseOptionsCardConfigurationApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends ActionExtensionApi {\n /** Selected purchase option data including product and selling plan identifiers. */\n data: {\n /** Array of selected items with their product IDs and optional selling plan IDs for subscription configurations. */\n selected: {\n /** The product or variant identifier. */\n id: string;\n /** The associated selling plan identifier, if a subscription option is selected. */\n sellingPlanId?: string;\n }[];\n };\n}" + } + }, + "ProductVariantDetailsConfigurationApi": { + "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "name": "ProductVariantDetailsConfigurationApi", + "description": "The `ProductVariantDetailsConfigurationApi` object provides methods for configuring product variant bundles and relationships. Access the following properties on the `ProductVariantDetailsConfigurationApi` object to build variant configuration interfaces.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data & { variant: ProductVariant; app: { launchUrl: string; applicationUrl: string; }; }", + "description": "Product variant configuration data including the current variant, selected items, and app URLs. Use this to access the variant being configured and build your configuration interface." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "navigation", + "value": "Navigation", + "description": "Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ProductVariantDetailsConfigurationApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends BlockExtensionApi {\n /** Product variant configuration data including the current variant, selected items, and app URLs. Use this to access the variant being configured and build your configuration interface. */\n data: Data & {\n /**\n * The product variant currently being viewed in the admin.\n * @deprecated\n */\n variant: ProductVariant;\n /** URLs for launching and navigating to your app, including the launch URL and base application URL. Use these to create links or redirect merchants to your app. */\n app: {\n launchUrl: string;\n applicationUrl: string;\n };\n };\n}" + } + }, + "ProductVariant": { + "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "name": "ProductVariant", + "description": "A product variant configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "barcode", + "value": "string", + "description": "The barcode, UPC, or ISBN number for the variant." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "compareAtPrice", + "value": "string", + "description": "The original price before any discounts or markdowns." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The variant's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "price", + "value": "string", + "description": "The current selling price for this variant." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productVariantComponents", + "value": "ProductVariantComponent[]", + "description": "An array of component variants that make up this bundle variant. Each component represents a product variant included in the bundle." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "selectedOptions", + "value": "{ name: string; value: string; }[]", + "description": "The option values that define this specific variant with name and value pairs (for example, Size: Large, Color: Blue)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "sku", + "value": "string", + "description": "The Stock Keeping Unit (SKU) identifier for inventory tracking." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "taxable", + "value": "boolean", + "description": "Whether this variant is subject to taxes. When `true`, applicable taxes are calculated at checkout." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "taxCode", + "value": "string", + "description": "The harmonized system (HS) tax code for international shipping and customs." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The display name showing only the variant's option values (for example, \"Medium / Blue\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "weight", + "value": "number", + "description": "The physical weight of the variant as a number." + } + ], + "value": "export interface ProductVariant {\n /** The variant's unique global identifier (GID). */\n id: string;\n /** The Stock Keeping Unit (SKU) identifier for inventory tracking. */\n sku: string;\n /** The barcode, UPC, or ISBN number for the variant. */\n barcode: string;\n /** The display name showing only the variant's option values (for example, \"Medium / Blue\"). */\n title: string;\n /** A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\"). */\n displayName: string;\n /** The current selling price for this variant. */\n price: string;\n /** The original price before any discounts or markdowns. */\n compareAtPrice: string;\n /** Whether this variant is subject to taxes. When `true`, applicable taxes are calculated at checkout. */\n taxable: boolean;\n /** The harmonized system (HS) tax code for international shipping and customs. */\n taxCode: string;\n /** The physical weight of the variant as a number. */\n weight: number;\n /** The option values that define this specific variant with name and value pairs (for example, Size: Large, Color: Blue). */\n selectedOptions: {\n name: string;\n value: string;\n }[];\n /** An array of component variants that make up this bundle variant. Each component represents a product variant included in the bundle. */\n productVariantComponents: ProductVariantComponent[];\n}" + } + }, + "ProductVariantComponent": { + "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts": { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "name": "ProductVariantComponent", + "description": "A component variant that is part of a product bundle. Represents an individual product variant included in a bundle configuration.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\")." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The component variant's unique global identifier (GID)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "{\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null", + "description": "The image displayed for this component variant with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "productVariantUrl", + "value": "string", + "description": "The admin URL for this product variant. Use this to create links to the variant's details page in the admin." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "selectedOptions", + "value": "{ name: string; value: string; }[]", + "description": "The option values that define this specific component variant with name and value pairs (for example, Size: Large, Color: Blue)." + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "sku", + "value": "string", + "description": "The Stock Keeping Unit (SKU) identifier for this component variant.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The display name showing only the variant's option values (for example, \"Medium / Blue\")." + } + ], + "value": "export interface ProductVariantComponent {\n /** The component variant's unique global identifier (GID). */\n id: string;\n /** A human-readable display name that combines the product title with the variant's option values (for example, \"T-Shirt - Medium / Blue\"). */\n displayName: string;\n /** The display name showing only the variant's option values (for example, \"Medium / Blue\"). */\n title: string;\n /** The Stock Keeping Unit (SKU) identifier for this component variant. */\n sku?: string;\n /** The image displayed for this component variant with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces. */\n image?: {\n id?: string | null;\n url?: string | null;\n altText?: string | null;\n } | null;\n /** The admin URL for this product variant. Use this to create links to the variant's details page in the admin. */\n productVariantUrl: string;\n /** The option values that define this specific component variant with name and value pairs (for example, Size: Large, Color: Blue). */\n selectedOptions: {\n name: string;\n value: string;\n }[];\n}" + } + }, + "OrderRoutingRuleApi": { + "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "name": "OrderRoutingRuleApi", + "description": "The `OrderRoutingRuleApi` object provides methods for configuring order routing rules. Access the following properties on the `OrderRoutingRuleApi` object to manage rule settings and metafields.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "applyMetafieldsChange", + "value": "ApplyMetafieldsChange", + "description": "Updates or removes [metafields](/docs/apps/build/metafields) that store order routing rule configuration." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "Data", + "description": "The order routing rule being configured, including its metadata and associated [metafields](/docs/apps/build/metafields)." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface OrderRoutingRuleApi\n extends StandardRenderingExtensionApi {\n /** Updates or removes [metafields](/docs/apps/build/metafields) that store order routing rule configuration. */\n applyMetafieldsChange: ApplyMetafieldsChange;\n /** The order routing rule being configured, including its metadata and associated [metafields](/docs/apps/build/metafields). */\n data: Data;\n}" + } + }, + "ApplyMetafieldsChange": { + "src/surfaces/admin/api/order-routing-rule/metafields.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts", + "name": "ApplyMetafieldsChange", + "description": "A function that applies metafield changes to order routing rule settings. Call this function with one or more change operations to update or remove metafields in batch. Use batch operations to apply multiple configuration changes efficiently.", + "isPublicDocs": true, + "params": [ + { + "name": "changes", + "description": "", + "value": "MetafieldsChange[]", + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(changes: MetafieldsChange[]) => void" + } + }, + "MetafieldsChange": { + "src/surfaces/admin/api/order-routing-rule/metafields.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/metafields.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldsChange", + "value": "MetafieldUpdateChange | MetafieldRemoveChange | MetafieldUpdateChange[] | MetafieldRemoveChange[]", + "description": "One or more metafield change operations to apply to order routing rule settings. Can be a single change or an array of changes for batch operations. Use arrays to apply multiple changes at once.", + "isPublicDocs": true + } + }, + "ValidationSettingsApi": { + "src/surfaces/admin/api/checkout-rules/validation-settings.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "name": "ValidationSettingsApi", + "description": "The `ValidationSettingsApi` object provides methods for configuring cart and checkout validation functions. Access the following properties on the `ValidationSettingsApi` object to manage validation settings and metafields.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "applyMetafieldChange", + "value": "ApplyMetafieldChange", + "description": "Updates or removes [metafields](/docs/apps/build/metafields) that store validation function configuration. Use this to save merchant settings for your validation function." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "ValidationData", + "description": "The validation being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/validation-settings.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface ValidationSettingsApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardRenderingExtensionApi {\n /**\n * Updates or removes [metafields](/docs/apps/build/metafields) that store validation function configuration. Use this to save merchant settings for your validation function.\n */\n applyMetafieldChange: ApplyMetafieldChange;\n /** The validation being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings. */\n data: ValidationData;\n}" + } + }, + "ValidationData": { + "src/surfaces/admin/api/checkout-rules/launch-options.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "name": "ValidationData", + "description": "The `data` object exposed to validation settings extensions in the `admin.settings.validation.render` target. Use this to access the current validation configuration and populate your settings interface with existing values.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "shopifyFunction", + "value": "ShopifyFunction", + "description": "The [Shopify Function](/docs/apps/build/functions) that implements the validation logic. Use this ID to associate configuration changes with the correct function." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "validation", + "value": "Validation", + "description": "The validation configuration containing the validation ID and metafields. Present when editing an existing validation, absent when creating a new validation. Use the presence of this value to determine if you're in create or edit mode.", + "isOptional": true + } + ], + "value": "export interface ValidationData {\n /** The validation configuration containing the validation ID and metafields. Present when editing an existing validation, absent when creating a new validation. Use the presence of this value to determine if you're in create or edit mode. */\n validation?: Validation;\n /** The [Shopify Function](/docs/apps/build/functions) that implements the validation logic. Use this ID to associate configuration changes with the correct function. */\n shopifyFunction: ShopifyFunction;\n}" + } + }, + "ShopifyFunction": { + "src/surfaces/admin/api/checkout-rules/launch-options.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "name": "ShopifyFunction", + "description": "A [Shopify Function](/docs/apps/build/functions) that implements cart and checkout validation logic. This identifies which function the settings interface is configuring.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The [Shopify Function's](/docs/apps/build/functions) unique global identifier (GID). Use this ID to associate settings changes with the correct function." + } + ], + "value": "export interface ShopifyFunction {\n /** The [Shopify Function's](/docs/apps/build/functions) unique global identifier (GID). Use this ID to associate settings changes with the correct function. */\n id: string;\n}" + } + }, + "Validation": { + "src/surfaces/admin/api/checkout-rules/launch-options.ts": { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "name": "Validation", + "description": "A validation configuration that exists and is active in the shop. Use this object to access the validation's current settings and metafields when merchants edit an existing validation.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The validation's unique global identifier (GID). Use this ID to reference the validation in GraphQL operations or when saving updated settings." + }, + { + "filePath": "src/surfaces/admin/api/checkout-rules/launch-options.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "An array of [metafields](/docs/apps/build/metafields) that store the validation's configuration values. Use these metafields to populate your settings UI with the current validation configuration." + } + ], + "value": "export interface Validation {\n /** The validation's unique global identifier (GID). Use this ID to reference the validation in GraphQL operations or when saving updated settings. */\n id: string;\n /** An array of [metafields](/docs/apps/build/metafields) that store the validation's configuration values. Use these metafields to populate your settings UI with the current validation configuration. */\n metafields: Metafield[];\n}" + } + }, + "ClosedIntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "ClosedIntentResponse", + "description": "The response returned when a merchant closes or cancels the workflow without completing it. Check for this response to handle cancellation gracefully in your extension.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'closed'", + "description": "Indicates the workflow was closed without completion. When `'closed'`, the merchant exited the workflow before finishing.", + "isOptional": true + } + ], + "value": "export interface ClosedIntentResponse {\n /** Indicates the workflow was closed without completion. When `'closed'`, the merchant exited the workflow before finishing. */\n code?: 'closed';\n}" + } + }, + "SuccessIntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "SuccessIntentResponse", + "description": "The response returned when a merchant successfully completes the workflow. Use this to access the created or updated resource data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'ok'", + "description": "Indicates successful completion. When `'ok'`, the merchant completed the workflow and the resource was created or updated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ [key: string]: unknown; }", + "description": "Additional data returned by the workflow, such as the created or updated resource information with IDs and properties.", + "isOptional": true + } + ], + "value": "export interface SuccessIntentResponse {\n /** Indicates successful completion. When `'ok'`, the merchant completed the workflow and the resource was created or updated. */\n code?: 'ok';\n /** Additional data returned by the workflow, such as the created or updated resource information with IDs and properties. */\n data?: {[key: string]: unknown};\n}" + } + }, + "ErrorIntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "ErrorIntentResponse", + "description": "The response returned when the workflow fails due to validation errors or other issues. Use this to display error messages and help merchants fix problems.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "'error'", + "description": "Indicates the workflow failed. When `'error'`, the workflow encountered validation errors or other issues that prevented completion.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "issues", + "value": "Issue[]", + "description": "Specific validation issues or field errors. Present when validation fails on particular fields, allowing you to show targeted error messages.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A general error message describing what went wrong. Use this to display feedback when specific field errors aren't available.", + "isOptional": true + } + ], + "value": "export interface ErrorIntentResponse {\n /** Indicates the workflow failed. When `'error'`, the workflow encountered validation errors or other issues that prevented completion. */\n code?: 'error';\n /** A general error message describing what went wrong. Use this to display feedback when specific field errors aren't available. */\n message?: string;\n /** Specific validation issues or field errors. Present when validation fails on particular fields, allowing you to show targeted error messages. */\n issues?: Issue[];\n}" + } + }, + "IntentResponse": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentResponse", + "value": "SuccessIntentResponse | ErrorIntentResponse | ClosedIntentResponse", + "description": "The result of an intent workflow. Check the `code` property to determine the outcome: `'ok'` for success, `'error'` for failure, or `'closed'` if the merchant cancelled.", + "isPublicDocs": true + } + }, + "IntentActivity": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentActivity", + "description": "A handle for tracking an in-progress intent workflow.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "complete", + "value": "Promise", + "description": "A Promise that resolves when the workflow completes. Await this to get the outcome and handle success, failure, or cancellation appropriately.", + "isOptional": true + } + ], + "value": "export interface IntentActivity {\n /**\n * A Promise that resolves when the workflow completes. Await this to get the outcome and handle success, failure, or cancellation appropriately.\n */\n complete?: Promise;\n}" + } + }, + "IntentAction": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentAction", + "value": "'create' | 'edit' | 'pick'", + "description": "The type of operation to perform: creating a new resource, editing an existing one, or picking existing resources.", + "isPublicDocs": true + } + }, + "IntentType": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IntentType", + "value": "'shopify/Article' | 'shopify/Catalog' | 'shopify/Collection' | 'shopify/Customer' | 'shopify/Discount' | 'shopify/File' | 'shopify/Location' | 'shopify/Market' | 'shopify/Menu' | 'shopify/MetafieldDefinition' | 'shopify/Metaobject' | 'shopify/MetaobjectDefinition' | 'shopify/Page' | 'shopify/Product' | 'shopify/ProductVariant'", + "description": "The types of Shopify resources that support intent-based creation and editing workflows.", + "isPublicDocs": true + } + }, + "Collection": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Collection", + "description": "A collection resource selected from the resource picker. Collections are groups of products organized by manual curation or automated rules. Use collection data to access product groupings, organizational information, and collection metadata.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "availablePublicationCount", + "value": "number", + "description": "The number of sales channels where this collection can be published. Use this to understand the collection's potential reach across different storefronts." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "The collection description as plain text without HTML formatting. Use this when you need the description without markup." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "descriptionHtml", + "value": "string", + "description": "The collection description formatted as HTML. Use this to display rich text descriptions with formatting and styling in your UI." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The URL-friendly unique identifier used in collection URLs (for example, `'summer-collection'` in `/collections/summer-collection`). Use this to generate collection links or match URL paths." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The collection's unique global identifier (GID). Use this ID for collection-related GraphQL operations." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "ResourceImage | null", + "description": "The featured image displayed for the collection. Use this for collection thumbnails, headers, or preview images.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "productsAutomaticallySortedCount", + "value": "number", + "description": "The count of products automatically added to the collection based on automation rules. Use this to understand how many products match the collection's criteria." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "productsCount", + "value": "number", + "description": "The total number of products in the collection, including both manually added and automatically included products. Use this to show collection size or for pagination." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "productsManuallySortedCount", + "value": "number", + "description": "The count of products manually added by the merchant. Use this to understand how much manual curation the collection has." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "publicationCount", + "value": "number", + "description": "The number of sales channels where the collection is currently published. Use this to check the collection's actual visibility across storefronts." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "ruleSet", + "value": "RuleSet | null", + "description": "The automation rules that determine which products are automatically included. Present only for automated (smart) collections. When `null`, the collection is manually curated. Use this to understand the collection's filtering logic.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "seo", + "value": "{ description?: string; title?: string; }", + "description": "Search engine optimization metadata for the collection. Use this to understand how the collection appears in search engine results." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "sortOrder", + "value": "CollectionSortOrder", + "description": "The default sort order that determines how products are arranged in the collection. This controls the product sequence customers see on the storefront." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "storefrontId", + "value": "string", + "description": "The Storefront API identifier for this collection. Use this ID when making Storefront API queries for this collection." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "templateSuffix", + "value": "string | null", + "description": "The theme template suffix for using custom theme templates (for example, `'featured'` to use `collection.featured.liquid`). When `null`, uses the default collection template.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The collection's display name shown to merchants and customers. Use this as the primary collection identifier in lists and displays." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "updatedAt", + "value": "string", + "description": "ISO 8601 timestamp when the collection was last updated. Use this to track changes, sync with external systems, or show freshness indicators." + } + ], + "value": "export interface Collection extends Resource {\n /** The number of sales channels where this collection can be published. Use this to understand the collection's potential reach across different storefronts. */\n availablePublicationCount: number;\n /** The collection description as plain text without HTML formatting. Use this when you need the description without markup. */\n description: string;\n /** The collection description formatted as HTML. Use this to display rich text descriptions with formatting and styling in your UI. */\n descriptionHtml: string;\n /** The URL-friendly unique identifier used in collection URLs (for example, `'summer-collection'` in `/collections/summer-collection`). Use this to generate collection links or match URL paths. */\n handle: string;\n /** The collection's unique global identifier (GID). Use this ID for collection-related GraphQL operations. */\n id: string;\n /** The featured image displayed for the collection. Use this for collection thumbnails, headers, or preview images. */\n image?: ResourceImage | null;\n /** The count of products automatically added to the collection based on automation rules. Use this to understand how many products match the collection's criteria. */\n productsAutomaticallySortedCount: number;\n /** The total number of products in the collection, including both manually added and automatically included products. Use this to show collection size or for pagination. */\n productsCount: number;\n /** The count of products manually added by the merchant. Use this to understand how much manual curation the collection has. */\n productsManuallySortedCount: number;\n /** The number of sales channels where the collection is currently published. Use this to check the collection's actual visibility across storefronts. */\n publicationCount: number;\n /** The automation rules that determine which products are automatically included. Present only for automated (smart) collections. When `null`, the collection is manually curated. Use this to understand the collection's filtering logic. */\n ruleSet?: RuleSet | null;\n /** Search engine optimization metadata for the collection. Use this to understand how the collection appears in search engine results. */\n seo: {\n /** The SEO meta description that appears in search engine result snippets. This summarizes the collection for search engines. */\n description?: string | null;\n /** The SEO page title that appears in browser tabs and search results. When `null`, the collection's regular title is used. */\n title?: string | null;\n };\n /** The default sort order that determines how products are arranged in the collection. This controls the product sequence customers see on the storefront. */\n sortOrder: CollectionSortOrder;\n /** The Storefront API identifier for this collection. Use this ID when making Storefront API queries for this collection. */\n storefrontId: string;\n /** The theme template suffix for using custom theme templates (for example, `'featured'` to use `collection.featured.liquid`). When `null`, uses the default collection template. */\n templateSuffix?: string | null;\n /** The collection's display name shown to merchants and customers. Use this as the primary collection identifier in lists and displays. */\n title: string;\n /** ISO 8601 timestamp when the collection was last updated. Use this to track changes, sync with external systems, or show freshness indicators. */\n updatedAt: string;\n}" + } + }, + "ResourceImage": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ResourceImage", + "description": "An image associated with a product, variant, or collection. Use image data to display thumbnails, galleries, or product previews in your extension.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "altText", + "value": "string", + "description": "Alternative text describing the image for screen readers and accessibility. This text appears when images fail to load. Use descriptive alt text to make your extension accessible.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique identifier for the image file. Use this ID for image-related GraphQL operations." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "originalSrc", + "value": "string", + "description": "The full URL to the original image file. Use this URL to display the image in your extension UI." + } + ], + "value": "export interface ResourceImage {\n /** The unique identifier for the image file. Use this ID for image-related GraphQL operations. */\n id: string;\n /** Alternative text describing the image for screen readers and accessibility. This text appears when images fail to load. Use descriptive alt text to make your extension accessible. */\n altText?: string;\n /** The full URL to the original image file. Use this URL to display the image in your extension UI. */\n originalSrc: string;\n}" + } + }, + "RuleSet": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "RuleSet", + "description": "A set of rules that determine which products are automatically included in a collection. Use this to understand how an automated collection populates itself with products.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "appliedDisjunctively", + "value": "boolean", + "description": "The logical operator for combining multiple rules. When `true`, products are included if they match ANY rule (OR logic). When `false`, products must match ALL rules (AND logic). Use this to understand the collection's filtering strategy." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "rules", + "value": "CollectionRule[]", + "description": "An array of rules that define product inclusion criteria. Each rule checks a different product attribute. Products are added to the collection based on how these rules are combined (see `appliedDisjunctively`)." + } + ], + "value": "export interface RuleSet {\n /** The logical operator for combining multiple rules. When `true`, products are included if they match ANY rule (OR logic). When `false`, products must match ALL rules (AND logic). Use this to understand the collection's filtering strategy. */\n appliedDisjunctively: boolean;\n /** An array of rules that define product inclusion criteria. Each rule checks a different product attribute. Products are added to the collection based on how these rules are combined (see `appliedDisjunctively`). */\n rules: CollectionRule[];\n}" + } + }, + "CollectionRule": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "CollectionRule", + "description": "A single rule that defines product inclusion criteria for an automated collection. Rules filter products based on their attributes to automatically populate a collection.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "column", + "value": "string", + "description": "The product field to evaluate (for example, `'title'`, `'tag'`, `'vendor'`, or `'product_type'`). This determines which product attribute the rule checks." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "condition", + "value": "string", + "description": "The value to compare against. For example, if checking tags, this might be `'summer'` or `'featured'`. The product attribute must match this condition value according to the relation." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "PropertySignature", + "name": "relation", + "value": "string", + "description": "The comparison operator that determines how the field is matched (for example, `'equals'`, `'contains'`, `'starts_with'`, `'ends_with'`, `'not_equals'`). This defines the matching logic between the column and condition." + } + ], + "value": "export interface CollectionRule {\n /** The product field to evaluate (for example, `'title'`, `'tag'`, `'vendor'`, or `'product_type'`). This determines which product attribute the rule checks. */\n column: string;\n /** The value to compare against. For example, if checking tags, this might be `'summer'` or `'featured'`. The product attribute must match this condition value according to the relation. */\n condition: string;\n /** The comparison operator that determines how the field is matched (for example, `'equals'`, `'contains'`, `'starts_with'`, `'ends_with'`, `'not_equals'`). This defines the matching logic between the column and condition. */\n relation: string;\n}" + } + }, + "CollectionSortOrder": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "CollectionSortOrder", + "value": "export enum CollectionSortOrder {\n /** Products arranged in the custom order set by the merchant. Use this when merchants have manually organized products for specific merchandising. */\n Manual = 'MANUAL',\n /** Products sorted by sales volume, with best-sellers first. Use this to highlight popular products. */\n BestSelling = 'BEST_SELLING',\n /** Products sorted alphabetically by title from A to Z. Use this for easy browsing of product names. */\n AlphaAsc = 'ALPHA_ASC',\n /** Products sorted alphabetically by title from Z to A. Use this for reverse alphabetical ordering. */\n AlphaDesc = 'ALPHA_DESC',\n /** Products sorted by price from highest to lowest. Use this to show premium or expensive items first. */\n PriceDesc = 'PRICE_DESC',\n /** Products sorted by price from lowest to highest. Use this to show affordable options first. */\n PriceAsc = 'PRICE_ASC',\n /** Products sorted by creation date with newest products first. Use this to highlight recently added items. */\n CreatedDesc = 'CREATED_DESC',\n /** Products sorted by creation date with oldest products first. Use this for chronological ordering. */\n Created = 'CREATED',\n /** Products sorted by search relevance based on query terms. Use this when the collection is filtered by search. */\n MostRelevant = 'MOST_RELEVANT',\n}", + "description": "The sort order that determines how products appear in a collection. This controls the default product arrangement that customers see when viewing the collection on the storefront.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Manual", + "value": "MANUAL", + "description": "Products arranged in the custom order set by the merchant. Use this when merchants have manually organized products for specific merchandising." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "BestSelling", + "value": "BEST_SELLING", + "description": "Products sorted by sales volume, with best-sellers first. Use this to highlight popular products." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "AlphaAsc", + "value": "ALPHA_ASC", + "description": "Products sorted alphabetically by title from A to Z. Use this for easy browsing of product names." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "AlphaDesc", + "value": "ALPHA_DESC", + "description": "Products sorted alphabetically by title from Z to A. Use this for reverse alphabetical ordering." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "PriceDesc", + "value": "PRICE_DESC", + "description": "Products sorted by price from highest to lowest. Use this to show premium or expensive items first." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "PriceAsc", + "value": "PRICE_ASC", + "description": "Products sorted by price from lowest to highest. Use this to show affordable options first." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "CreatedDesc", + "value": "CREATED_DESC", + "description": "Products sorted by creation date with newest products first. Use this to highlight recently added items." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Created", + "value": "CREATED", + "description": "Products sorted by creation date with oldest products first. Use this for chronological ordering." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "MostRelevant", + "value": "MOST_RELEVANT", + "description": "Products sorted by search relevance based on query terms. Use this when the collection is filtered by search." + } + ] + } + }, + "IntentQuery": { + "src/surfaces/admin/api/intents/intents.ts": { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "name": "IntentQuery", + "description": "A structured intent specification defining what workflow to launch. Use this format when you prefer object syntax over string query format.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "action", + "value": "IntentAction", + "description": "The operation to perform: `'create'` for new resources or `'edit'` for existing ones." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "data", + "value": "{ [key: string]: unknown; }", + "description": "Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "IntentType", + "description": "The type of resource to create or edit (for example, `'shopify/Product'`)." + }, + { + "filePath": "src/surfaces/admin/api/intents/intents.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.", + "isOptional": true + } + ], + "value": "export interface IntentQuery extends IntentQueryOptions {\n /**\n * The operation to perform: `'create'` for new resources or `'edit'` for existing ones.\n */\n action: IntentAction;\n /**\n * The type of resource to create or edit (for example, `'shopify/Product'`).\n */\n type: IntentType;\n}" + } + }, + "LoadingOptions": { + "src/surfaces/admin/api/loading/loading.ts": { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "name": "LoadingOptions", + "description": "Options to configure the Admin page-level loading indicator.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/loading/loading.ts", + "syntaxKind": "PropertySignature", + "name": "isLoading", + "value": "boolean", + "description": "Pass `true` to show the loading indicator, `false` to hide it.", + "isOptional": true + } + ], + "value": "export interface LoadingOptions {\n /**\n * Pass `true` to show the loading indicator, `false` to hide it.\n */\n isLoading?: boolean;\n}" + } + }, + "Money": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Money", + "value": "string", + "description": "A monetary value represented as a string (for example, `\"19.99\"` or `\"0.00\"`). The format always includes the decimal point and cents, even for whole dollar amounts. Use this type for prices, costs, and other currency values.", + "isPublicDocs": true + } + }, + "FulfillmentServiceType": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "FulfillmentServiceType", + "value": "export enum FulfillmentServiceType {\n /** Digital gift card fulfillment with automatic delivery. No physical shipping required. */\n GiftCard = 'GIFT_CARD',\n /** Manual fulfillment handled directly by the merchant. The merchant packs and ships orders themselves. */\n Manual = 'MANUAL',\n /** Third-party fulfillment service that handles warehousing and shipping (for example, ShipBob, Amazon FBA, or custom 3PL providers). */\n ThirdParty = 'THIRD_PARTY',\n}", + "description": "The types of fulfillment services that can handle order fulfillment. This determines how products are delivered to customers.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "GiftCard", + "value": "GIFT_CARD", + "description": "Digital gift card fulfillment with automatic delivery. No physical shipping required." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Manual", + "value": "MANUAL", + "description": "Manual fulfillment handled directly by the merchant. The merchant packs and ships orders themselves." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "ThirdParty", + "value": "THIRD_PARTY", + "description": "Third-party fulfillment service that handles warehousing and shipping (for example, ShipBob, Amazon FBA, or custom 3PL providers)." + } + ] + } + }, + "WeightUnit": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "WeightUnit", + "value": "export enum WeightUnit {\n /** Weight measured in kilograms (kg). Commonly used in metric system countries. */\n Kilograms = 'KILOGRAMS',\n /** Weight measured in grams (g). Used for lightweight items in metric system. */\n Grams = 'GRAMS',\n /** Weight measured in pounds (lb). Commonly used in the United States. */\n Pounds = 'POUNDS',\n /** Weight measured in ounces (oz). Used for lightweight items in imperial system. */\n Ounces = 'OUNCES',\n}", + "description": "The unit of measurement for product weight. Use this with the weight value to calculate shipping costs or display product specifications.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Kilograms", + "value": "KILOGRAMS", + "description": "Weight measured in kilograms (kg). Commonly used in metric system countries." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Grams", + "value": "GRAMS", + "description": "Weight measured in grams (g). Used for lightweight items in metric system." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Pounds", + "value": "POUNDS", + "description": "Weight measured in pounds (lb). Commonly used in the United States." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Ounces", + "value": "OUNCES", + "description": "Weight measured in ounces (oz). Used for lightweight items in imperial system." + } + ] + } + }, + "ProductVariantInventoryPolicy": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "ProductVariantInventoryPolicy", + "value": "export enum ProductVariantInventoryPolicy {\n /** Prevents purchases when inventory reaches zero. Customers can't add out-of-stock variants to their cart. Use this to avoid overselling. */\n Deny = 'DENY',\n /** Allows purchases even when inventory is zero or negative. Customers can continue buying out-of-stock variants. Use this for backorders or made-to-order products. */\n Continue = 'CONTINUE',\n}", + "description": "The inventory policy that determines whether customers can purchase a variant when it's out of stock. Use this to control checkout behavior for low or zero inventory items.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Deny", + "value": "DENY", + "description": "Prevents purchases when inventory reaches zero. Customers can't add out-of-stock variants to their cart. Use this to avoid overselling." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Continue", + "value": "CONTINUE", + "description": "Allows purchases even when inventory is zero or negative. Customers can continue buying out-of-stock variants. Use this for backorders or made-to-order products." + } + ] + } + }, + "ProductVariantInventoryManagement": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "ProductVariantInventoryManagement", + "value": "export enum ProductVariantInventoryManagement {\n /** Inventory tracked and managed by Shopify. Stock levels update through Shopify admin or API. Use this for standard inventory management. */\n Shopify = 'SHOPIFY',\n /** Inventory not tracked. The variant is always considered in stock. Use this for services, digital goods, or custom products with unlimited availability. */\n NotManaged = 'NOT_MANAGED',\n /** Inventory tracked by an external fulfillment service. The third-party system manages stock levels. Use this when a 3PL or fulfillment app controls inventory. */\n FulfillmentService = 'FULFILLMENT_SERVICE',\n}", + "description": "The system responsible for tracking inventory levels for a variant. This determines where stock counts are managed and updated.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Shopify", + "value": "SHOPIFY", + "description": "Inventory tracked and managed by Shopify. Stock levels update through Shopify admin or API. Use this for standard inventory management." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "NotManaged", + "value": "NOT_MANAGED", + "description": "Inventory not tracked. The variant is always considered in stock. Use this for services, digital goods, or custom products with unlimited availability." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "FulfillmentService", + "value": "FULFILLMENT_SERVICE", + "description": "Inventory tracked by an external fulfillment service. The third-party system manages stock levels. Use this when a 3PL or fulfillment app controls inventory." + } + ] + } + }, + "ProductStatus": { + "src/surfaces/admin/api/resource-picker/resource-picker.ts": { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "syntaxKind": "EnumDeclaration", + "name": "ProductStatus", + "value": "export enum ProductStatus {\n /** The product is published and available for sale on active sales channels. Customers can view and purchase this product. */\n Active = 'ACTIVE',\n /** The product is archived and no longer available. Archived products don't appear on storefronts and can't be purchased. Use this for discontinued items. */\n Archived = 'ARCHIVED',\n /** The product is an unpublished draft not visible to customers. Draft products are still being prepared or reviewed. */\n Draft = 'DRAFT',\n}", + "description": "The publication status indicating a product's availability state. Use this to filter products or determine which products customers can see and purchase.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Active", + "value": "ACTIVE", + "description": "The product is published and available for sale on active sales channels. Customers can view and purchase this product." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Archived", + "value": "ARCHIVED", + "description": "The product is archived and no longer available. Archived products don't appear on storefronts and can't be purchased. Use this for discontinued items." + }, + { + "filePath": "src/surfaces/admin/api/resource-picker/resource-picker.ts", + "name": "Draft", + "value": "DRAFT", + "description": "The product is an unpublished draft not visible to customers. Draft products are still being prepared or reviewed." + } + ] + } + }, + "StandardRenderingExtensionApi": { + "src/surfaces/admin/api/standard/standard-rendering.ts": { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "name": "StandardRenderingExtensionApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "auth", + "value": "Auth", + "description": "Provides methods for authenticating calls to your app backend. Use the `idToken()` method to retrieve a signed JWT token that verifies the current user's identity for secure server-side operations." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "{ target: ExtensionTarget; }", + "description": "The identifier of the running extension target. Use this to determine which target your extension is rendering in and conditionally adjust functionality or UI based on the extension context." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content according to the current localization of the admin. Use these methods to provide translated strings that match the merchant's language preferences, ensuring your extension is accessible to a global audience." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "intents", + "value": "Intents", + "description": "Provides information to the receiver of an intent. Use this to access data passed from other extensions or parts of the admin when your extension is launched through intent-based navigation." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "picker", + "value": "PickerApi", + "description": "Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": "(query: string, options?: { variables?: Variables; version?: Omit; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "Executes GraphQL queries against the [GraphQL Admin API](/docs/api/admin-graphql). Use this to fetch shop data, manage resources, or perform mutations. Queries are automatically authenticated with the current user's permissions. Optionally specify GraphQL variables and API version for your query." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "resourcePicker", + "value": "ResourcePickerApi", + "description": "Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel." + }, + { + "filePath": "src/surfaces/admin/api/standard/standard-rendering.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Provides methods for persisting data in browser storage that is scoped to your extension. Use this to store user preferences, cache data, maintain state across sessions, or save temporary working data. Storage is persistent across page reloads and isolated per extension." + } + ], + "value": "export interface StandardRenderingExtensionApi<\n ExtensionTarget extends AnyExtensionTarget,\n> extends StandardApi {\n /**\n * Opens the [resource picker](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel.\n */\n resourcePicker: ResourcePickerApi;\n\n /**\n * Opens a custom selection dialog with your app-specific data. Use the [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) to define the picker's heading, items, headers, and selection behavior. Returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.\n */\n picker: PickerApi;\n}" + } + }, + "CustomerStandardMetafieldDependency": { + "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts": { + "filePath": "src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CustomerStandardMetafieldDependency", + "value": "'facts.birth_date'", + "description": "Standard customer metafields that can be referenced as template dependencies.", + "isPublicDocs": true + } + }, + "OrderRoutingRule": { + "src/surfaces/admin/api/order-routing-rule/data.ts": { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "name": "OrderRoutingRule", + "description": "An order routing rule configuration that determines how orders are routed to fulfillment locations. Use this to access the rule's current settings and populate your configuration interface.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "A description explaining the rule's purpose and how it routes orders. Use this to help merchants understand what the rule does." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique global identifier (GID) for the order routing rule. Use this ID to associate configuration changes with the correct rule." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The display label for the order routing rule shown to merchants in the admin. Use this to identify the rule in lists and settings pages." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "An array of [metafields](/docs/apps/build/metafields) that store the routing rule's configuration values. Use these metafields to populate your settings UI with the current rule configuration." + }, + { + "filePath": "src/surfaces/admin/api/order-routing-rule/data.ts", + "syntaxKind": "PropertySignature", + "name": "priority", + "value": "number", + "description": "The priority order for rule evaluation when multiple rules exist. Lower numbers are evaluated first (for example, a rule with priority 1 runs before priority 2). Use this to understand the rule's position in the evaluation sequence.", + "isOptional": true + } + ], + "value": "export interface OrderRoutingRule {\n /** The display label for the order routing rule shown to merchants in the admin. Use this to identify the rule in lists and settings pages. */\n label: string;\n /** A description explaining the rule's purpose and how it routes orders. Use this to help merchants understand what the rule does. */\n description: string;\n /** The unique global identifier (GID) for the order routing rule. Use this ID to associate configuration changes with the correct rule. */\n id: string;\n /** The priority order for rule evaluation when multiple rules exist. Lower numbers are evaluated first (for example, a rule with priority 1 runs before priority 2). Use this to understand the rule's position in the evaluation sequence. */\n priority?: number;\n /** An array of [metafields](/docs/apps/build/metafields) that store the routing rule's configuration values. Use these metafields to populate your settings UI with the current rule configuration. */\n metafields: Metafield[];\n}" + } + }, + "ComponentChildren": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentChildren", + "value": "preact.ComponentChildren", + "description": "Represents any valid children that can be rendered within a component, including elements, strings, numbers, or arrays of these types. This is an alias for Preact's `ComponentChildren` type.", + "isPublicDocs": true + } + }, + "StringChildren": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "StringChildren", + "value": "string", + "description": "Represents string-only children for components that specifically require text content.", + "isPublicDocs": true + } + }, + "ActionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ActionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The text to use as the action modal's title. If not provided, the name of the extension will be used.", + "isOptional": true + } + ], + "value": "export interface ActionProps {\n /**\n * The text to use as the action modal's title. If not provided, the name of the extension will be used.\n */\n heading?: string;\n}" + } + }, + "ActionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ActionSlots", + "description": "The action component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + } + ], + "value": "export interface ActionSlots {\n /**\n * The primary action button or link, representing the main or most important action available in this context.\n * Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.\n */\n primaryAction?: ComponentChildren;\n /**\n * Additional action buttons or links that provide alternative or supporting actions.\n * Visually de-emphasized compared to the primary action.\n */\n secondaryActions?: ComponentChildren;\n}" + } + }, + "BaseOverlayProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseOverlayProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterShow", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + } + ], + "value": "export interface BaseOverlayProps {\n /**\n * A callback fired immediately after the overlay is shown.\n */\n onShow?: (event: Event) => void;\n /**\n * A callback fired when the overlay is shown, after any show animations have completed.\n */\n onAfterShow?: (event: Event) => void;\n /**\n * A callback fired immediately after the overlay is hidden.\n */\n onHide?: (event: Event) => void;\n /**\n * A callback fired when the overlay is hidden, after any hide animations have completed.\n */\n onAfterHide?: (event: Event) => void;\n}" + } + }, + "BaseOverlayMethods": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseOverlayMethods", + "description": "Shared interface for web component methods that control overlay visibility.\n\nAll methods are required (not optional) because components implementing this interface must provide consistent JavaScript APIs. Unlike props/attributes, methods are not rendered in HTML and consumers expect them to be available on all component instances.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "showOverlay", + "value": "() => void", + "description": "A method to programmatically show the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "toggleOverlay", + "value": "() => void", + "description": "A method to programmatically toggle the visibility of the overlay." + } + ], + "value": "export interface BaseOverlayMethods {\n /**\n * A method to programmatically show the overlay.\n *\n * @implementation This is a method to be called on the element and not a callback and should hence be camelCase\n */\n showOverlay: () => void;\n /**\n * A method to programmatically hide the overlay.\n *\n * @implementation This is a method to be called on the element and not a callback and should hence be camelCase\n */\n hideOverlay: () => void;\n /**\n * A method to programmatically toggle the visibility of the overlay.\n *\n * @implementation This is a method to be called on the element and not a callback and should hence be camelCase\n */\n toggleOverlay: () => void;\n}" + } + }, + "FocusEventProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FocusEventProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface FocusEventProps {\n /**\n * A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n onBlur?: (event: FocusEvent) => void;\n /**\n * A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n onFocus?: (event: FocusEvent) => void;\n}" + } + }, + "ToggleEventProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ToggleEventProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + } + ], + "value": "export interface ToggleEventProps {\n /**\n * A callback fired when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n onAfterToggle?: (event: ToggleEvent$1) => void;\n /**\n * A callback fired immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n onToggle?: (event: ToggleEvent$1) => void;\n}" + } + }, + "ToggleState": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ToggleState", + "value": "'open' | 'closed'", + "description": "Represents the visibility state of a toggleable element.\n\n- `open`: The element is visible or expanded.\n- `closed`: The element is hidden or collapsed.", + "isPublicDocs": true + } + }, + "ExtendableEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ExtendableEvent", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "waitUntil", + "value": "(promise: Promise) => void", + "description": "A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.\n\nCan be called multiple times to add promises to the event, but must be called synchronously during event dispatch. Cannot be called after a `setTimeout` or within a microtask.", + "isOptional": true + } + ], + "value": "export interface ExtendableEvent extends Event {\n /**\n * A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.\n *\n * Can be called multiple times to add promises to the event, but must be called synchronously during event dispatch.\n * Cannot be called after a `setTimeout` or within a microtask.\n */\n waitUntil?: (promise: Promise) => void;\n}" + } + }, + "AggregateError": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AggregateError", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "errors", + "value": "T[]", + "description": "An array of individual errors that have been aggregated together. Each error in this array represents a separate failure that occurred." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "stack", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface AggregateError extends Error {\n /**\n * An array of individual errors that have been aggregated together.\n * Each error in this array represents a separate failure that occurred.\n */\n errors: T[];\n}" + } + }, + "AggregateErrorEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AggregateErrorEvent", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "colno", + "value": "number", + "description": "The **`colno`** read-only property of the ErrorEvent interface returns an integer containing the column number of the script file on which the error occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "AggregateError", + "description": "The aggregated error object containing multiple individual errors. Access the `errors` property to retrieve the array of individual error instances." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "filename", + "value": "string", + "description": "The **`filename`** read-only property of the ErrorEvent interface returns a string containing the name of the script file in which the error occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lineno", + "value": "number", + "description": "The **`lineno`** read-only property of the ErrorEvent interface returns an integer containing the line number of the script file on which the error occurred.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "The **`message`** read-only property of the ErrorEvent interface returns a string containing a human-readable error message describing the problem.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/ErrorEvent/message)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + } + ], + "value": "export interface AggregateErrorEvent extends ErrorEvent {\n /**\n * The aggregated error object containing multiple individual errors.\n * Access the `errors` property to retrieve the array of individual error instances.\n */\n error: AggregateError;\n}" + } + }, + "ToneKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ToneKeyword", + "value": "'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical' | 'accent' | 'custom'", + "description": "Defines the semantic color treatment of a component to convey specific intent or status.\n\nTones apply coordinated color schemes (text, background, icons) across the component. Some components, like banner, also use tone to determine accessibility attributes and screen reader announcements.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General-purpose information without specific sentiment.\n- `info`: Informational content that provides helpful details or guidance.\n- `success`: Positive outcomes, successful operations, or confirmations.\n- `caution`: Warnings about potential issues that require attention but aren't critical.\n- `warning`: Similar to caution, indicates something that needs user awareness.\n- `critical`: Errors, failures, or urgent issues that require immediate attention.\n- `accent`: Highlighted or emphasized content that doesn't fit other semantic tones.\n- `custom`: Custom color treatment defined by your theme or implementation.", + "isPublicDocs": true + } + }, + "IconType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "IconType", + "value": "'replace' | 'search' | 'split' | 'link' | 'edit' | 'info' | 'incomplete' | 'complete' | 'product' | 'variant' | 'collection' | 'select' | 'color' | 'money' | 'order' | 'code' | 'adjust' | 'affiliate' | 'airplane' | 'alert-bubble' | 'alert-circle' | 'alert-diamond' | 'alert-location' | 'alert-octagon' | 'alert-octagon-filled' | 'alert-triangle' | 'alert-triangle-filled' | 'app-extension' | 'apps' | 'archive' | 'arrow-down' | 'arrow-down-circle' | 'arrow-down-right' | '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' | 'battery-low' | 'bill' | 'blank' | 'blog' | 'bolt' | 'bolt-filled' | 'book' | 'book-open' | '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-filled' | 'cart-sale' | 'cart-send' | 'cart-up' | 'cash-dollar' | 'cash-euro' | 'cash-pound' | 'cash-rupee' | 'cash-yen' | 'catalog-product' | 'categories' | 'channels' | '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-add' | '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' | 'delivered' | 'delivery' | 'desktop' | 'disabled' | 'disabled-filled' | 'discount' | 'discount-add' | 'discount-automatic' | 'discount-code' | 'discount-remove' | 'dns-settings' | 'dock-floating' | 'dock-side' | 'domain' | 'domain-landing-page' | 'domain-new' | 'domain-redirect' | 'download' | 'drag-drop' | 'drag-handle' | 'drawer' | 'duplicate' | 'email' | 'email-follow-up' | 'email-newsletter' | 'empty' | 'enabled' | 'enter' | 'envelope' | 'envelope-soft-pack' | 'eraser' | 'exchange' | 'exit' | 'export' | 'external' | 'eye-check-mark' | 'eye-dropper' | 'eye-dropper-list' | 'eye-first' | 'eyeglasses' | 'fav' | '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' | 'geolocation' | 'gift' | 'gift-card' | 'git-branch' | 'git-commit' | 'git-repository' | 'globe' | 'globe-asia' | 'globe-europe' | 'globe-lines' | 'globe-list' | 'graduation-hat' | 'grid' | 'hashtag' | 'hashtag-decimal' | 'hashtag-list' | 'heart' | 'hide' | 'hide-filled' | 'home' | 'home-filled' | 'icons' | 'identity-card' | 'image' | 'image-add' | 'image-alt' | 'image-explore' | 'image-magic' | 'image-none' | 'image-with-text-overlay' | 'images' | 'import' | 'in-progress' | 'incentive' | 'incoming' | 'info-filled' | 'inheritance' | 'inventory' | 'inventory-edit' | 'inventory-list' | 'inventory-transfer' | 'inventory-updated' | 'iq' | 'key' | 'keyboard' | 'keyboard-filled' | 'keyboard-hide' | 'keypad' | 'label-printer' | 'language' | 'language-translate' | '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-list' | 'list-bulleted' | 'list-bulleted-filled' | 'list-numbered' | 'live' | 'live-critical' | 'live-none' | '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-filled' | 'menu-horizontal' | 'menu-vertical' | 'merge' | 'metafields' | 'metaobject' | 'metaobject-list' | 'metaobject-reference' | 'microphone' | 'microphone-muted' | 'minimize' | 'minus' | 'minus-circle' | 'mobile' | 'money-none' | 'money-split' | 'moon' | 'nature' | 'note' | 'note-add' | 'notification' | 'number-one' | 'order-batches' | 'order-draft' | 'order-filled' | 'order-first' | 'order-fulfilled' | 'order-repeat' | 'order-unfulfilled' | 'orders-status' | 'organization' | 'outdent' | 'outgoing' | 'package' | 'package-cancel' | 'package-fulfilled' | 'package-on-hold' | 'package-reassign' | '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' | 'partially-complete' | 'passkey' | 'paste' | 'pause-circle' | 'payment' | 'payment-capture' | 'payout' | 'payout-dollar' | 'payout-euro' | 'payout-pound' | 'payout-rupee' | 'payout-yen' | 'person' | 'person-add' | 'person-exit' | 'person-filled' | 'person-list' | 'person-lock' | 'person-remove' | 'person-segment' | 'personalized-text' | 'phablet' | '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' | 'point-of-sale-register' | 'price-list' | 'print' | 'product-add' | 'product-cost' | 'product-filled' | '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-folded' | 'receipt-paid' | 'receipt-pound' | 'receipt-refund' | 'receipt-rupee' | 'receipt-yen' | 'receivables' | 'redo' | 'referral-code' | 'refresh' | 'remove-background' | 'reorder' | 'replay' | 'reset' | 'return' | 'reward' | 'rocket' | 'rotate-left' | 'rotate-right' | 'sandbox' | 'save' | 'savings' | 'scan-qr-code' | 'search-add' | 'search-list' | 'search-recent' | 'search-resource' | 'send' | 'settings' | 'share' | 'shield-check-mark' | 'shield-none' | 'shield-pending' | 'shield-person' | 'shipping-label' | 'shipping-label-cancel' | 'shopcodes' | 'slideshow' | 'smiley-happy' | 'smiley-joy' | 'smiley-neutral' | 'smiley-sad' | 'social-ad' | 'social-post' | 'sort' | 'sort-ascending' | 'sort-descending' | 'sound' | 'sports' | 'star' | 'star-circle' | 'star-filled' | 'star-half' | '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-indent-remove' | 'text-italic' | 'text-quote' | 'text-title' | 'text-underline' | 'text-with-image' | 'theme' | 'theme-edit' | 'theme-store' | 'theme-template' | 'three-d-environment' | 'thumbs-down' | 'thumbs-up' | 'tip-jar' | 'toggle-off' | 'toggle-on' | 'transaction' | 'transaction-fee-add' | 'transaction-fee-dollar' | 'transaction-fee-euro' | 'transaction-fee-pound' | 'transaction-fee-rupee' | 'transaction-fee-yen' | 'transfer' | 'transfer-in' | 'transfer-internal' | 'transfer-out' | 'truck' | 'undo' | 'unknown-device' | 'unlock' | 'upload' | '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' | 'x-circle-filled'", + "description": "Represents the available icon names that can be used in icon components. This is derived from the complete list of supported icons in the design system.", + "isPublicDocs": true + } + }, + "ExtractStrict": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtractStrict", + "value": "", + "description": "A type-safe version of TypeScript's `Extract` utility that constrains the second type parameter to be assignable to the first. This provides compile-time validation that you're only extracting types that actually exist within the union, catching potential errors earlier in development.", + "isPublicDocs": true + } + }, + "optionalSpace": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "optionalSpace", + "value": "'' | ' '", + "description": "A utility type representing an optional space character for use in string literal type composition. Allows flexible formatting of compound values where spacing is a matter of preference rather than semantic difference.", + "isPublicDocs": true + } + }, + "DisplayProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DisplayProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface DisplayProps {\n /**\n * The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n *\n * - `auto`: the component’s initial value. The actual value depends on the component and context.\n * - `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n *\n * Learn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).\n *\n * @default 'auto'\n */\n display?: MaybeResponsive<'auto' | 'none'>;\n}" + } + }, + "AccessibilityRoleProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AccessibilityRoleProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + } + ], + "value": "export interface AccessibilityRoleProps {\n /**\n * The semantic meaning of the component’s content. When set,\n * the role will be used by assistive technologies to help users\n * navigate the page.\n *\n * @implementation Although, in HTML hosts, this property changes the element used,\n * changing this property must not impact the visual styling of inside or outside of the box.\n *\n * @default 'generic'\n */\n accessibilityRole?: AccessibilityRole;\n}" + } + }, + "LabelAccessibilityVisibilityProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LabelAccessibilityVisibilityProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + } + ], + "value": "export interface LabelAccessibilityVisibilityProps {\n /**\n * Controls whether the label is visible to all users or only to screen readers.\n *\n * - `visible`: The label is shown to everyone (default).\n * - `exclusive`: The label is visually hidden but still announced by screen readers.\n *\n * Use `exclusive` when the surrounding context makes the label redundant visually,\n * but screen reader users still need it for clarity.\n *\n * @default 'visible'\n */\n labelAccessibilityVisibility?: ExtractStrict<\n AccessibilityVisibilityProps['accessibilityVisibility'],\n 'visible' | 'exclusive'\n >;\n}" + } + }, + "BorderRadiusKeyword": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderRadiusKeyword", + "value": "SizeKeyword | 'max' | 'none'", + "description": "Defines the radius of rounded corners, using the standard size scale, `max` for fully rounded, or `none` for sharp corners.", + "isPublicDocs": true + } + }, + "OverflowProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OverflowProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + } + ], + "value": "export interface OverflowProps {\n /**\n * The overflow behavior of the element.\n *\n * - `visible`: the content that extends beyond the element’s container is visible.\n * - `hidden`: clips the content when it is larger than the element’s container.\n * The element will not be scrollable and the users will not be able\n * to access the clipped content by dragging or using a scroll wheel on a mouse.\n *\n * @default 'visible'\n */\n overflow?: 'hidden' | 'visible';\n}" + } + }, + "BaseBoxProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseBoxProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface BaseBoxProps\n extends AccessibilityVisibilityProps,\n BackgroundProps,\n DisplayProps,\n SizingProps,\n PaddingProps,\n BorderProps,\n OverflowProps {\n /**\n * The content displayed within the box component, which serves as a flexible container for organizing and styling other components.\n */\n children?: ComponentChildren;\n /**\n * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.\n */\n accessibilityLabel?: string;\n}" + } + }, + "BaseBoxPropsWithRole": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseBoxPropsWithRole", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface BaseBoxPropsWithRole\n extends BaseBoxProps,\n AccessibilityRoleProps {}" + } + }, + "ButtonBehaviorProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonBehaviorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ], + "value": "export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {\n /**\n * The behavior of the button component.\n *\n * - `button`: Used to indicate the component acts as a button, meaning it has no default action.\n * - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n * - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n *\n * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.\n *\n * @default 'button'\n */\n type?: 'submit' | 'button' | 'reset';\n /**\n * A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n onClick?: (event: Event) => void;\n /**\n * Whether the button is disabled, preventing it from being clicked or receiving focus.\n *\n * @default false\n */\n disabled?: boolean;\n /**\n * Whether to replace the button content with a loading indicator while a background action is being performed.\n *\n * This also disables the button component.\n *\n * @default false\n */\n loading?: boolean;\n}" + } + }, + "LinkBehaviorProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LinkBehaviorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {\n /**\n * The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.\n */\n href?: string;\n /**\n * The browsing context where the linked URL should be displayed.\n *\n * - `auto`: The target is automatically determined based on the origin of the URL.\n * - `_blank`: Opens the URL in a new window or tab.\n * - `_self`: Opens the URL in the same browsing context as the current one.\n * - `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n * - `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.\n *\n * @implementation Surfaces can set specific rules on how they handle each URL.\n * @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.\n * @implementation For example, a surface could decide to open cross-origin URLs in a new window (as `_blank`).\n *\n * Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n *\n * @default 'auto'\n */\n target?: 'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString;\n /**\n * Prompts the browser to download the linked URL rather than navigate to it.\n * When set, the value specifies the suggested filename for the downloaded file.\n *\n * The filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes.\n * Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n *\n * Learn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).\n */\n download?: string;\n /**\n * A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n onClick?: (event: Event) => void;\n}" + } + }, + "InteractionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "InteractionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + } + ], + "value": "export interface InteractionProps {\n /**\n * The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n */\n commandFor?: string;\n /**\n * The action that `commandFor` should take when this component is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the visibility of the target component.\n * - `--copy`: Copies the target `ClipboardItem`.\n *\n * Learn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n *\n * @default '--auto'\n */\n command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy';\n /**\n * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.\n */\n interestFor?: string;\n}" + } + }, + "BaseClickableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseClickableProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ], + "value": "export interface BaseClickableProps\n extends ButtonBehaviorProps,\n LinkBehaviorProps {}" + } + }, + "BaseInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseInputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + } + ], + "value": "export interface BaseInputProps {\n /**\n * The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.\n */\n name?: string;\n /**\n * Whether the field is disabled, preventing any user interaction.\n *\n * @default false\n */\n disabled?: boolean;\n}" + } + }, + "InputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "InputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface InputProps extends BaseInputProps {\n /**\n * A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n onChange?: (event: Event) => void;\n /**\n * A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).\n */\n onInput?: (event: Event) => void;\n value?: string;\n /**\n * The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.\n *\n * @implementation `defaultValue` reflects to the `value` attribute.\n */\n defaultValue?: string;\n}" + } + }, + "MultipleInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MultipleInputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user selects or deselects options. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "values", + "value": "string[]", + "description": "An array of `value` attributes for the currently selected options. When provided, this property automatically sets the `selected` state on child option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.", + "isOptional": true + } + ], + "value": "export interface MultipleInputProps extends BaseInputProps {\n /**\n * A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n onChange?: (event: Event) => void;\n /**\n * A callback fired when the user selects or deselects options. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).\n */\n onInput?: (event: Event) => void;\n /**\n * An array of `value` attributes for the currently selected options. When provided, this property automatically sets the `selected` state on child option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected.\n */\n values?: string[];\n}" + } + }, + "FileInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FileInputProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "files", + "value": "ReadonlyArray", + "description": "An array of File objects representing the files currently selected by the user.\n\nThis property is read-only and cannot be directly modified. To clear the selected files, set the `value` prop to an empty string or null.", + "isOptional": true, + "defaultValue": "[]" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished selecting one or more files.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes to the file selection.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "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.\n\nLearn more about the [file input value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value).", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface FileInputProps extends BaseInputProps {\n /**\n * A callback fired when the user has finished selecting one or more files.\n */\n onChange?: (event: Event) => void;\n /**\n * A callback fired when the user makes any changes to the file selection.\n */\n onInput?: (event: Event) => void;\n /**\n * A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\").\n * When the user selected multiple files, the value represents the first file in the list of files they selected.\n * The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file.\n *\n * Learn more about the [file input value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value).\n *\n * @default ''\n */\n value?: string;\n /**\n * An array of File objects representing the files currently selected by the user.\n *\n * This property is read-only and cannot be directly modified.\n * To clear the selected files, set the `value` prop to an empty string or null.\n *\n * @default []\n */\n files?: ReadonlyArray;\n}" + } + }, + "FieldErrorProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldErrorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + } + ], + "value": "export interface FieldErrorProps {\n /**\n * An error message displayed below the checkbox to indicate validation problems.\n * When set, the checkbox is styled with error indicators and the message is announced to screen readers.\n */\n error?: string;\n}" + } + }, + "BasicFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BasicFieldProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface BasicFieldProps\n extends FieldErrorProps,\n LabelAccessibilityVisibilityProps {\n /**\n * Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.\n *\n * @default false\n */\n required?: boolean;\n /**\n * The text displayed as the field label, which identifies the purpose of the field to users.\n * This label is associated with the field for accessibility and helps users understand what information to provide.\n */\n label?: string;\n}" + } + }, + "FieldDetailsProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldDetailsProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + } + ], + "value": "export interface FieldDetailsProps {\n /**\n * Supplementary text displayed below the checkbox to provide additional context, instructions, or help.\n * Use this to explain what checking the box means or provide guidance to users.\n * This text is announced to screen readers.\n */\n details?: string;\n}" + } + }, + "FieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FieldProps\n extends BasicFieldProps,\n InputProps,\n FocusEventProps,\n FieldDetailsProps {\n /**\n * The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.\n */\n placeholder?: string;\n}" + } + }, + "BaseTextFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseTextFieldProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface BaseTextFieldProps extends FieldProps {\n /**\n * Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.\n *\n * @default false\n */\n readOnly?: boolean;\n}" + } + }, + "FieldDecorationProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FieldDecorationProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "ComponentChildren", + "description": "Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconType | AnyString", + "description": "An icon displayed inside the field to provide visual context about the expected input or field purpose. Commonly used for search fields, currency inputs, or to indicate field type. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string", + "description": "A non-editable text value 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`.\n\nThis text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "string", + "description": "A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n\nThis text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface FieldDecorationProps {\n /**\n * A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.\n *\n * This text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field.\n *\n * @default ''\n */\n suffix?: string;\n /**\n * A non-editable text value 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`.\n *\n * This text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field.\n *\n * @default ''\n */\n prefix?: string;\n /**\n * An icon displayed inside the field to provide visual context about the expected input or field purpose.\n * Commonly used for search fields, currency inputs, or to indicate field type.\n * Accepts any icon name from the icon library or a custom string identifier.\n *\n * @default ''\n */\n icon?: IconType | AnyString;\n /**\n * Additional content to be displayed in the field.\n * Commonly used to display an icon that activates a tooltip providing more information.\n */\n accessory?: ComponentChildren;\n}" + } + }, + "NumberConstraintsProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "NumberConstraintsProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "controls", + "value": "'auto' | 'stepper' | 'none'", + "description": "The type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + } + ], + "value": "export interface NumberConstraintsProps {\n /**\n * The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n *\n * Users can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.\n *\n * @default Infinity\n */\n max?: number;\n /**\n * The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n *\n * Users can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.\n *\n * @default -Infinity\n */\n min?: number;\n /**\n * The amount the value can increase or decrease by. This can be an integer or decimal.\n * If a `max` or `min` is specified with `step` when increasing/decreasing the value\n * via the buttons, the final value will always round to the `max` or `min`\n * rather than the closest valid amount.\n *\n * @default 1\n */\n step?: number;\n /**\n * The type of controls displayed in the field.\n *\n * - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property.\n * Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n * - `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n * - `auto`: the presence of the controls depends on the surface and context.\n *\n * @default 'auto'\n */\n controls?: 'auto' | 'stepper' | 'none';\n}" + } + }, + "MinMaxLengthProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MinMaxLengthProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "The maximum number of characters allowed in the field.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "The minimum number of characters required in the field.", + "isOptional": true, + "defaultValue": "0" + } + ], + "value": "export interface MinMaxLengthProps {\n /**\n * The maximum number of characters allowed in the field.\n *\n * @default Infinity\n */\n maxLength?: number;\n /**\n * The minimum number of characters required in the field.\n *\n * @default 0\n */\n minLength?: number;\n}" + } + }, + "BaseSelectableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseSelectableProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + } + ], + "value": "export interface BaseSelectableProps {\n /**\n * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.\n */\n accessibilityLabel?: string;\n /**\n * Whether the checkbox is disabled, preventing user interaction.\n * Disabled checkboxes appear dimmed and their values aren't submitted with forms.\n *\n * @default false\n */\n disabled?: boolean;\n /**\n * The value submitted with the form when this checkbox is checked.\n * If not specified, the default value is \"on\".\n */\n value?: string;\n}" + } + }, + "BaseOptionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseOptionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultSelected", + "value": "boolean", + "description": "The initial selected state for uncontrolled components. Use this when you want the option to start selected but don't need to control its state afterward.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the option is currently selected. Use this for controlled components where you manage the selection state.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + } + ], + "value": "export interface BaseOptionProps extends BaseSelectableProps {\n /**\n * Whether the option is currently selected. Use this for controlled components where you manage the selection state.\n *\n * @default false\n */\n selected?: boolean;\n /**\n * The initial selected state for uncontrolled components. Use this when you want the option to start selected\n * but don't need to control its state afterward.\n *\n * @implementation `defaultSelected` reflects to the `selected` attribute.\n *\n * @default false\n */\n defaultSelected?: boolean;\n}" + } + }, + "BaseCheckableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseCheckableProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked. Use this for controlled components where you manage the checked state.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "The initial checked state for uncontrolled components. Use this when you want the control to start checked but don't need to control its state afterward.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the checkbox is disabled, preventing user interaction. Disabled checkboxes appear dimmed and their values aren't submitted with forms.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text label displayed next to the checkbox that describes what the checkbox controls. Clicking the label will also toggle the checkbox state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name used to identify this checkbox in form submissions. When the checkbox is checked, its `name` and `value` are included in the form data. Must be unique within the containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value submitted with the form when this checkbox is checked. If not specified, the default value is \"on\".", + "isOptional": true + } + ], + "value": "export interface BaseCheckableProps\n extends BaseSelectableProps,\n InteractionProps {\n /**\n * The text label displayed next to the checkbox that describes what the checkbox controls.\n * Clicking the label will also toggle the checkbox state.\n */\n label?: string;\n /**\n * Whether the control is currently checked. Use this for controlled components where you manage the checked state.\n *\n * @default false\n */\n checked?: boolean;\n /**\n * The initial checked state for uncontrolled components. Use this when you want the control to start checked\n * but don't need to control its state afterward.\n *\n * @implementation `defaultChecked` reflects to the `checked` attribute.\n *\n * @default false\n */\n defaultChecked?: boolean;\n /**\n * The name used to identify this checkbox in form submissions.\n * When the checkbox is checked, its `name` and `value` are included in the form data.\n * Must be unique within the containing form.\n */\n name?: string;\n /**\n * A callback that is run whenever the control is changed. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n onChange?: (event: Event) => void;\n /**\n * A callback that is run whenever the control is changed. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).\n */\n onInput?: (event: Event) => void;\n}" + } + }, + "ChipProps$1": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChipProps$1", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "ComponentChildren", + "description": "The graphic to display inside of the chip.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface ChipProps$1 extends GlobalProps {\n /**\n * The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.\n */\n children?: ComponentChildren;\n /**\n * The graphic to display inside of the chip.\n *\n * @implementation Only `s-icon` is supported.\n */\n graphic?: ComponentChildren;\n /**\n * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.\n */\n accessibilityLabel?: string;\n /**\n * The color emphasis level that controls visual intensity.\n *\n * @default 'base'\n */\n color?: ColorKeyword;\n}" + } + }, + "AutocompleteProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AutocompleteProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "| AutocompleteField\n | `${AutocompleteSection} ${AutocompleteField}`\n | `${AutocompleteGroup} ${AutocompleteField}`\n | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`\n | 'on'\n | 'off'", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on' for everything else" + } + ], + "value": "export interface AutocompleteProps<\n AutocompleteField extends AnyAutocompleteField,\n> {\n /**\n * A hint about the intended content of the field for browser autofill.\n *\n * When set to `on` (the default), this property indicates that the field should support\n * autofill, but you do not have any more semantic information on the intended\n * contents.\n *\n * When set to `off`, you are indicating that this field contains sensitive\n * information, or contents that are never saved, like one-time codes.\n *\n * Alternatively, you can provide value which describes the\n * specific data you would like to be entered into this field during autofill.\n *\n * Learn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.\n *\n * @default 'tel' for PhoneField\n * @default 'email' for EmailField\n * @default 'url' for URLField\n * @default 'on' for everything else\n */\n autocomplete?:\n | AutocompleteField\n | `${AutocompleteSection} ${AutocompleteField}`\n | `${AutocompleteGroup} ${AutocompleteField}`\n | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`\n | 'on'\n | 'off';\n}" + } + }, + "AutocompleteSection": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteSection", + "value": "`section-${string}`", + "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page.", + "isPublicDocs": true + } + }, + "AutocompleteGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteGroup", + "value": "'shipping' | 'billing'", + "description": "The contact information group the autocomplete data should be sourced from.", + "isPublicDocs": true + } + }, + "AutocompleteAddressGroup": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteAddressGroup", + "value": "'fax' | 'home' | 'mobile' | 'pager'", + "description": "The contact information subgroup the autocomplete data should be sourced from.", + "isPublicDocs": true + } + }, + "AnyAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyAutocompleteField", + "value": "'additional-name' | 'address-level1' | 'address-level2' | 'address-level3' | 'address-level4' | 'address-line1' | 'address-line2' | 'address-line3' | 'country-name' | 'country' | 'current-password' | 'email' | 'family-name' | 'given-name' | 'honorific-prefix' | 'honorific-suffix' | 'language' | 'name' | 'new-password' | 'nickname' | 'one-time-code' | 'organization-title' | 'organization' | 'photo' | 'postal-code' | 'sex' | 'street-address' | 'transaction-amount' | 'transaction-currency' | 'url' | 'username' | 'bday-day' | 'bday-month' | 'bday-year' | 'bday' | 'cc-additional-name' | 'cc-expiry-month' | 'cc-expiry-year' | 'cc-expiry' | 'cc-family-name' | 'cc-given-name' | 'cc-name' | 'cc-number' | 'cc-csc' | 'cc-type' | `${AutocompleteAddressGroup} email` | 'impp' | `${AutocompleteAddressGroup} impp` | 'tel' | 'tel-area-code' | 'tel-country-code' | 'tel-extension' | 'tel-local-prefix' | 'tel-local-suffix' | 'tel-local' | 'tel-national' | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`", + "description": "Represents all possible autocomplete field values as defined by the HTML autocomplete specification. These values help browsers provide appropriate autofill suggestions for form fields.\n\nLearn more about [autocomplete values](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete).", + "isPublicDocs": true + } + }, + "FunctionSettingsError": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionSettingsError", + "description": "Represents an error that occurs when saving function settings data.\n\nThese errors are returned when the extension-provided data fails validation or causes issues during the commit process to Shopify's servers. Handle these errors in the `onError` callback to provide feedback to users about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A unique identifier describing the “class” of error. These will match the GraphQL error codes as closely as possible. For example the enums returned by the `metafieldsSet` mutation.\n\nLearn more about [MetafieldsSetUserErrorCode](/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode)." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "'FunctionSettingsError'", + "description": "The error type name, always set to `FunctionSettingsError`.\n\nThis helps identify errors specific to function settings, distinguishing them from other error types." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "stack", + "value": "string", + "description": "", + "isOptional": true + } + ], + "value": "export interface FunctionSettingsError extends Error {\n /**\n * A unique identifier describing the “class” of error. These will match\n * the GraphQL error codes as closely as possible. For example the enums\n * returned by the `metafieldsSet` mutation.\n *\n * Learn more about [MetafieldsSetUserErrorCode](/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode).\n */\n code: string;\n /**\n * The error type name, always set to `FunctionSettingsError`.\n *\n * This helps identify errors specific to function settings, distinguishing them from other error types.\n */\n name: 'FunctionSettingsError';\n}" + } + }, + "BaseTypographyProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseTypographyProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "ColorKeyword", + "description": "The color emphasis level that controls visual intensity.\n\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "'ltr' | 'rtl' | 'auto' | ''", + "description": "Indicates the directionality of the element’s text.\n\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n- `auto`: The user agent determines the direction based on the content.\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "fontVariantNumeric", + "value": "'auto' | 'normal' | 'tabular-nums'", + "description": "The rendering style for numbers in the font.\n\n- `auto`: Inherits the setting from the parent element.\n- `normal`: Uses the font's default numeric glyphs.\n- `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n\nLearn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `caution`: Advisory notices that need attention.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `accent`: Highlighted or promotional content.\n- `custom`: Custom styling controlled by your theme.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface BaseTypographyProps {\n /**\n * The color emphasis level that controls visual intensity.\n *\n * - `base`: Primary color for body text, standard UI elements, and general content with good readability.\n * - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n *\n * @default 'base'\n */\n color?: ColorKeyword;\n /**\n * The semantic meaning and color treatment of the component.\n *\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent.\n * - `info`: Informational content or helpful tips.\n * - `success`: Positive outcomes or successful states.\n * - `caution`: Advisory notices that need attention.\n * - `warning`: Important warnings about potential issues.\n * - `critical`: Urgent problems or destructive actions.\n * - `accent`: Highlighted or promotional content.\n * - `custom`: Custom styling controlled by your theme.\n *\n * @default 'auto'\n */\n tone?: ToneKeyword;\n /**\n * The rendering style for numbers in the font.\n *\n * - `auto`: Inherits the setting from the parent element.\n * - `normal`: Uses the font's default numeric glyphs.\n * - `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.\n *\n * Learn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).\n *\n * @default 'auto'\n */\n fontVariantNumeric?: 'auto' | 'normal' | 'tabular-nums';\n /**\n * The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n *\n * The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n *\n * It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.\n *\n * @default ''\n */\n lang?: string;\n /**\n * Indicates the directionality of the element’s text.\n *\n * - `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n * - `auto`: The user agent determines the direction based on the content.\n * - `ltr`: The languages written from left to right (such as English).\n * - `rtl`: The languages written from right to left (such as Arabic).\n *\n * Learn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).\n *\n * @default ''\n */\n dir?: 'ltr' | 'rtl' | 'auto' | '';\n}" + } + }, + "BlockTypographyProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BlockTypographyProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lineClamp", + "value": "number", + "description": "The maximum number of lines to display before truncating the text content.\n\nLearn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).", + "isOptional": true, + "defaultValue": "Infinity - no truncation is applied" + } + ], + "value": "export interface BlockTypographyProps {\n /**\n * The maximum number of lines to display before truncating the text content.\n *\n * Learn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).\n *\n * @default Infinity - no truncation is applied\n */\n lineClamp?: number;\n}" + } + }, + "BaseImageProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BaseImageProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true, + "defaultValue": "``" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes.\n\nLearn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. This overrides the `src` property.\n\nLearn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset).", + "isOptional": true + } + ], + "value": "export interface BaseImageProps {\n /**\n * Alternative text that describes the image for accessibility.\n *\n * Provides a text description of the image for users with assistive technology\n * and serves as a fallback when the image fails to load. A well-written description\n * enables people with visual impairments to understand non-text content.\n *\n * When a screen reader encounters an image, it reads this description aloud.\n * When an image fails to load, this text displays on screen, helping all users\n * understand what content was intended.\n *\n * Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4)\n * and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).\n *\n * @default ``\n */\n alt?: string;\n /**\n * A set of media conditions and their corresponding sizes.\n *\n * Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).\n */\n sizes?: string;\n /**\n * The image source (either a remote URL or a local file resource).\n *\n * When the image is loading or no `src` is provided, a placeholder is rendered.\n *\n * @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be\n * reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare.\n *\n * Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).\n */\n src?: string;\n /**\n * A set of image sources and their width or pixel density descriptors. This overrides the `src` property.\n *\n * Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset).\n */\n srcSet?: string;\n}" + } + }, + "MoneyAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MoneyAutocompleteField", + "value": "'transaction-amount'", + "description": "Represents autocomplete values that are valid for money/currency input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for monetary inputs.", + "isPublicDocs": true + } + }, + "ParagraphType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ParagraphType", + "value": "'paragraph' | 'small'", + "description": "", + "isPublicDocs": true + } + }, + "PaginationProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PaginationProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hasNextPage", + "value": "boolean", + "description": "Whether there's an additional page of data.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hasPreviousPage", + "value": "boolean", + "description": "Whether there's a previous page of data.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table. When `true`, the table might be in an inert state that prevents user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onNextPage", + "value": "(event: Event) => void", + "description": "A callback fired when the next page button is clicked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onPreviousPage", + "value": "(event: Event) => void", + "description": "A callback fired when the previous page button is clicked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paginate", + "value": "boolean", + "description": "Whether to use pagination controls.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PaginationProps {\n /**\n * Whether to use pagination controls.\n *\n * @default false\n */\n paginate?: boolean;\n /**\n * A callback fired when the previous page button is clicked.\n */\n onPreviousPage?: (event: Event) => void;\n /**\n * A callback fired when the next page button is clicked.\n */\n onNextPage?: (event: Event) => void;\n /**\n * Whether there's an additional page of data.\n *\n * @default false\n */\n hasNextPage?: boolean;\n /**\n * Whether there's a previous page of data.\n *\n * @default false\n */\n hasPreviousPage?: boolean;\n /**\n * Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table.\n * When `true`, the table might be in an inert state that prevents user interaction.\n *\n * @default false\n */\n loading?: boolean;\n}" + } + }, + "TextType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextType", + "value": "'address' | 'redundant' | 'mark' | 'emphasis' | 'offset' | 'strong' | 'small' | 'generic'", + "description": "Defines the semantic type and styling treatment for text content. Each type maps to appropriate HTML elements and applies specific styling for different contexts.", + "isPublicDocs": true + } + }, + "URLAutocompleteField": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "URLAutocompleteField", + "value": "'url' | 'photo' | 'impp' | 'home impp' | 'mobile impp' | 'fax impp' | 'pager impp'", + "description": "Represents autocomplete values that are valid for URL input fields. This is a subset of `AnyAutocompleteField` containing only fields suitable for URL inputs.\n\nAvailable values:\n- `url` - General URL or web address\n- `photo` - URL to a photo or image\n- `impp` - Instant messaging protocol URL\n- `home impp` - Home instant messaging protocol URL\n- `mobile impp` - Mobile instant messaging protocol URL\n- `fax impp` - Fax instant messaging protocol URL\n- `pager impp` - Pager instant messaging protocol URL", + "isPublicDocs": true + } + }, + "Key": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Key", + "value": "string | number | any", + "description": "Represents a unique key for identifying elements in lists. Can be a string, number, or any other value.", + "isPublicDocs": true + } + }, + "RefCallback": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "RefCallback", + "description": "Represents a callback function that receives a reference to a DOM element or component instance. Called when the element is mounted or unmounted.", + "isPublicDocs": true, + "params": [ + { + "name": "instance", + "description": "", + "value": "T", + "filePath": "src/surfaces/admin/components.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/components.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(instance: T | null) => void" + } + }, + "Ref": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Ref", + "value": "RefObject | RefCallback | null", + "description": "Represents a reference to a DOM element or component instance. Can be either a ref object, callback function, or null.", + "isPublicDocs": true + } + }, + "RefObject": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "RefObject", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "current", + "value": "T | null", + "description": "The current value of the ref, which holds a reference to the DOM element or component instance. Will be `null` if the element is not yet mounted or has been unmounted." + } + ], + "value": "export interface RefObject {\n /**\n * The current value of the ref, which holds a reference to the DOM element or component instance.\n * Will be `null` if the element is not yet mounted or has been unmounted.\n */\n current: T | null;\n}" + } + }, + "ComponentChild": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentChild", + "value": "VNode | object | string | number | bigint | boolean | null | undefined", + "description": "Represents a single child element that can be rendered, including VNodes, primitives, or null/undefined values.", + "isPublicDocs": true + } + }, + "VNode": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "VNode", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "endTime", + "value": "number", + "description": "The time that the rendering of this `vnode` was completed. Will only be set when the devtools are attached. Default value: `-1`", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "Key", + "description": "A unique key used to identify this element in lists for efficient reconciliation." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "props", + "value": "P & { children: ComponentChildren$1; }", + "description": "The properties passed to this component or element, including children." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "Ref | null", + "description": "A ref to the element, which is not guaranteed by React.ReactElement. For compatibility reasons with popular react libs we define it as optional too.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "startTime", + "value": "number", + "description": "The time this `vnode` started rendering. Will only be set when the devtools are attached. Default value: `0`", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "ComponentType

| string", + "description": "The component type or HTML element tag name that this VNode represents." + } + ], + "value": "export interface VNode

{\n /**\n * The component type or HTML element tag name that this VNode represents.\n */\n type: ComponentType

| string;\n /**\n * The properties passed to this component or element, including children.\n */\n props: P & {\n children: ComponentChildren$1;\n };\n /**\n * A unique key used to identify this element in lists for efficient reconciliation.\n */\n key: Key;\n /**\n * A ref to the element, which is not guaranteed by React.ReactElement. For compatibility reasons with popular react libs we define it as optional too.\n */\n ref?: Ref | null;\n /**\n * The time this `vnode` started rendering. Will only be set when\n * the devtools are attached.\n * Default value: `0`\n */\n startTime?: number;\n /**\n * The time that the rendering of this `vnode` was completed. Will only be\n * set when the devtools are attached.\n * Default value: `-1`\n */\n endTime?: number;\n}" + } + }, + "ComponentType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentType", + "value": "ComponentClass

| FunctionComponent

", + "description": "Represents any valid component type, either a class component or a function component.", + "isPublicDocs": true + } + }, + "ComponentClass": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ComponentClass", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "contextType", + "value": "Context", + "description": "The context type this component can consume. When set, the component will have access to this context's value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

", + "description": "The default values for props that will be used when props are not explicitly provided to component instances.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component class, used in debugging and dev tools.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "getDerivedStateFromError", + "value": "(error: any) => Partial", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "getDerivedStateFromProps", + "value": "(props: Readonly

, state: Readonly) => Partial", + "description": "", + "isOptional": true + } + ], + "value": "export interface ComponentClass

{\n new (props: P, context?: any): Component;\n /**\n * A human-readable name for this component class, used in debugging and dev tools.\n */\n displayName?: string;\n /**\n * The default values for props that will be used when props are not explicitly provided to component instances.\n */\n defaultProps?: Partial

;\n /**\n * The context type this component can consume. When set, the component will have access to this context's value.\n */\n contextType?: Context;\n getDerivedStateFromProps?(\n props: Readonly

,\n state: Readonly,\n ): Partial | null;\n getDerivedStateFromError?(error: any): Partial | null;\n}" + } + }, + "Context": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Context", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "Consumer", + "value": "Consumer", + "description": "A component that consumes the context value and re-renders when it changes." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "T", + "description": "The default value for this context, used when no Provider is found in the component tree." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this context, used in debugging and dev tools.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "Provider", + "value": "Provider", + "description": "A component that provides the context value to its descendants." + } + ], + "value": "export interface Context {\n /**\n * The default value for this context, used when no Provider is found in the component tree.\n */\n readonly defaultValue: T;\n}" + } + }, + "Consumer": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Consumer", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component, used in debugging and dev tools.", + "isOptional": true + } + ], + "value": "export interface Consumer\n extends FunctionComponent<{\n /**\n * A render function that receives the current context value and returns elements to render.\n * This function is called whenever the context value changes, allowing components to re-render with the updated value.\n */\n children: (value: T) => ComponentChildren$1;\n }> {}" + } + }, + "Provider": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Provider", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component, used in debugging and dev tools.", + "isOptional": true + } + ], + "value": "export interface Provider\n extends FunctionComponent<{\n /**\n * The context value to provide to consuming components.\n */\n value: T;\n /**\n * The child components that will have access to this context value.\n */\n children?: ComponentChildren$1;\n }> {}" + } + }, + "FunctionComponent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionComponent", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultProps", + "value": "Partial

| undefined", + "description": "The default values for props that will be used when props are not explicitly provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "displayName", + "value": "string", + "description": "A human-readable name for this component, used in debugging and dev tools.", + "isOptional": true + } + ], + "value": "export interface FunctionComponent

{\n (props: RenderableProps

, context?: any): ComponentChildren$1;\n /**\n * A human-readable name for this component, used in debugging and dev tools.\n */\n displayName?: string;\n /**\n * The default values for props that will be used when props are not explicitly provided.\n */\n defaultProps?: Partial

| undefined;\n}" + } + }, + "ErrorInfo": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ErrorInfo", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "componentStack", + "value": "string", + "description": "A string representation of the component stack trace at the point where an error occurred. Useful for debugging to understand which components were rendering when the error happened.", + "isOptional": true + } + ], + "value": "export interface ErrorInfo {\n /**\n * A string representation of the component stack trace at the point where an error occurred.\n * Useful for debugging to understand which components were rendering when the error happened.\n */\n componentStack?: string;\n}" + } + }, + "RenderableProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RenderableProps", + "value": "P & Readonly<\n Attributes & {\n /**\n * The child elements to be rendered within this component.\n */\n children?: ComponentChildren$1;\n /**\n * A reference to the DOM element or component instance, allowing direct access to the underlying element.\n */\n ref?: Ref;\n }\n >", + "description": "Represents the props that can be rendered by a component, combining custom props with standard attributes like children and ref.", + "isPublicDocs": true + } + }, + "Attributes": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Attributes", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "jsx", + "value": "boolean | undefined", + "description": "An internal flag indicating whether this element was created using JSX syntax.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "Key | undefined", + "description": "A unique key used to identify this element in lists for efficient reconciliation during re-renders.", + "isOptional": true + } + ], + "value": "export interface Attributes {\n /**\n * A unique key used to identify this element in lists for efficient reconciliation during re-renders.\n */\n key?: Key | undefined;\n /**\n * An internal flag indicating whether this element was created using JSX syntax.\n */\n jsx?: boolean | undefined;\n}" + } + }, + "Component": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Component", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "state", + "value": "Readonly", + "description": "The current state of the component." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "props", + "value": "RenderableProps", + "description": "The props passed to this component." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "context", + "value": "any", + "description": "The context value this component can access if a contextType is specified." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "base", + "value": "Element | Text", + "description": "The underlying DOM element or text node that this component rendered." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setState", + "value": "(state: Partial | ((prevState: Readonly, props: Readonly

) => Partial | Pick) | Pick, callback?: () => void) => void", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "forceUpdate", + "value": "(callback?: () => void) => void", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "render", + "value": "(props?: RenderableProps, state?: Readonly, context?: any) => ComponentChildren$1", + "description": "" + } + ], + "value": "declare abstract class Component {\n constructor(props?: P, context?: any);\n static displayName?: string;\n static defaultProps?: any;\n static contextType?: Context;\n // Static members cannot reference class type parameters. This is not\n // supported in TypeScript. Reusing the same type arguments from `Component`\n // will lead to an impossible state where one cannot satisfy the type\n // constraint under no circumstances, see #1356.In general type arguments\n // seem to be a bit buggy and not supported well at the time of this\n // writing with TS 3.3.3333.\n static getDerivedStateFromProps?(\n props: Readonly,\n state: Readonly,\n ): object | null;\n\n static getDerivedStateFromError?(error: any): object | null;\n /**\n * The current state of the component.\n */\n state: Readonly;\n /**\n * The props passed to this component.\n */\n props: RenderableProps

;\n /**\n * The context value this component can access if a contextType is specified.\n */\n context: any;\n /**\n * The underlying DOM element or text node that this component rendered.\n */\n base?: Element | Text;\n // From https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e836acc75a78cf0655b5dfdbe81d69fdd4d8a252/types/react/index.d.ts#L402\n // // We MUST keep setState() as a unified signature because it allows proper checking of the method return type.\n // // See: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/18365#issuecomment-351013257\n setState(\n state:\n | ((\n prevState: Readonly,\n props: Readonly

,\n ) => Pick | Partial | null)\n | (Pick | Partial | null),\n callback?: () => void,\n ): void;\n\n forceUpdate(callback?: () => void): void;\n abstract render(\n props?: RenderableProps

,\n state?: Readonly,\n context?: any,\n ): ComponentChildren$1;\n}" + } + }, + "Styles": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Styles", + "value": "string", + "description": "Represents CSS styles as a string, typically used for inline styles or style injection.", + "isPublicDocs": true + } + }, + "RenderImpl": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RenderImpl", + "value": "Omit & {\n ShadowRoot: (element: any) => ComponentChildren;\n styles?: Styles;\n}", + "description": "Represents the implementation details for rendering components within a shadow DOM. Extends `ShadowRootInit` with a render function and optional styles.", + "isPublicDocs": true + } + }, + "CallbackEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackEvent", + "value": "Event & {\n currentTarget: HTMLElementTagNameMap[T];\n}", + "description": "An event object with a strongly-typed `currentTarget` property that references the specific HTML element that triggered the event.\n\nThis type extends the standard DOM `Event` interface and ensures type safety when accessing the element that fired the event.", + "isPublicDocs": true + } + }, + "CallbackToggleEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackToggleEvent", + "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", + "description": "A toggle event with a strongly-typed `currentTarget` property. Extends the `ToggleEvent` interface with type-safe access to the element that triggered the toggle.", + "isPublicDocs": true + } + }, + "CallbackEventListener": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackEventListener", + "value": "(EventListener & {\n (event: CallbackEvent): void;\n }) | null", + "description": "A function that handles events from UI components.\n\nThis type represents an event listener callback that receives a `CallbackEvent` with a strongly-typed `currentTarget`. Use this for component event handlers like `click`, `focus`, `blur`, and other DOM events.", + "isPublicDocs": true + } + }, + "CallbackErrorEventListener": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackErrorEventListener", + "value": "(EventListener & {\n (\n event: CallbackEvent & {\n error: TError;\n },\n ): void;\n }) | null", + "description": "A function that handles error events from UI components. This type represents an event listener callback that receives both the event and an error object.", + "isPublicDocs": true + } + }, + "CallbackExtendableEventListener": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackExtendableEventListener", + "value": "(EventListener & {\n (event: CallbackExtendableEvent): void;\n }) | null", + "description": "A function that handles extendable events from UI components. This type represents an event listener callback that can use `waitUntil` to extend the event lifetime.", + "isPublicDocs": true + } + }, + "CallbackExtendableEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "CallbackExtendableEvent", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "waitUntil", + "value": "(promise: Promise) => void", + "description": "A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.\n\nCan be called multiple times to add promises to the event, but must be called synchronously during event dispatch. Cannot be called after a `setTimeout` or within a microtask.", + "isOptional": true + } + ], + "value": "export interface CallbackExtendableEvent<\n TTagName extends keyof HTMLElementTagNameMap,\n> extends CallbackEvent,\n Pick {}" + } + }, + "PreactBaseElementProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PreactBaseElementProps", + "description": "Base props for Preact custom elements without children support. Includes common properties like key, ref, and slot for elements that don't accept child content.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "preact.Key", + "description": "A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists. Essential for maintaining component state and optimizing re-renders when lists change.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "preact.Ref", + "description": "A reference to access the underlying DOM element directly. Typically created using `useRef()` to interact with the element imperatively or measure its properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "Lowercase", + "description": "The named slot to which this element is assigned in the parent component's shadow DOM.\n\nUsed for advanced component composition with web components.", + "isOptional": true + } + ], + "value": "export interface PreactBaseElementProps {\n /**\n * A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.\n * Essential for maintaining component state and optimizing re-renders when lists change.\n */\n key?: preact.Key;\n /**\n * A reference to access the underlying DOM element directly.\n * Typically created using `useRef()` to interact with the element imperatively or measure its properties.\n */\n ref?: preact.Ref;\n /**\n * The named slot to which this element is assigned in the parent component's shadow DOM.\n *\n * Used for advanced component composition with web components.\n */\n slot?: Lowercase;\n}" + } + }, + "PreactBaseElementPropsWithChildren": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PreactBaseElementPropsWithChildren", + "description": "Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "preact.ComponentChildren", + "description": "The child elements to be rendered within this component.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "preact.Key", + "description": "A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists. Essential for maintaining component state and optimizing re-renders when lists change.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "preact.Ref", + "description": "A reference to access the underlying DOM element directly. Typically created using `useRef()` to interact with the element imperatively or measure its properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "Lowercase", + "description": "The named slot to which this element is assigned in the parent component's shadow DOM.\n\nUsed for advanced component composition with web components.", + "isOptional": true + } + ], + "value": "export interface PreactBaseElementPropsWithChildren\n extends PreactBaseElementProps {\n /**\n * The child elements to be rendered within this component.\n */\n children?: preact.ComponentChildren;\n}" + } + }, + "RequiredBannerProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredBannerProps", + "value": "Required", + "description": "Represents the banner component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The main message content displayed within the banner, providing important information or guidance to users.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "collapsible", + "value": "boolean", + "description": "Whether the banner content can be collapsed. When true, child elements are initially hidden but can be revealed by the user expanding the banner.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "dismissible", + "value": "boolean", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event fires, then `hidden` is set to `true`, any animation completes, and the `afterhide` event fires.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the banner.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property will be `true` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "(event: Event) => void", + "description": "A callback fired when the banner is dismissed by the user clicking the close button. Does not fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "MakeResponsive": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MakeResponsive", + "value": "T | `@container${string}`", + "description": "Makes a type responsive by allowing it to be either the base value or a container query string. This enables conditional styling based on container dimensions.", + "isPublicDocs": true + } + }, + "MakeResponsivePick": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MakeResponsivePick", + "value": "{\n [P in TProperty]: MakeResponsive;\n}", + "description": "Makes a property's value potentially responsive.", + "isPublicDocs": true + } + }, + "RequiredBoxProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredBoxProps", + "value": "Required", + "description": "Represents the box component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ResponsiveBoxProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResponsiveBoxProps", + "value": "MakeResponsivePick<\n RequiredBoxProps,\n | 'padding'\n | 'paddingBlock'\n | 'paddingBlockStart'\n | 'paddingBlockEnd'\n | 'paddingInline'\n | 'paddingInlineStart'\n | 'paddingInlineEnd'\n | 'display'\n>", + "description": "Represents box props with responsive capabilities for layout properties.\n\nThis enables conditional styling based on container queries.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ButtonOnlyProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ButtonOnlyProps", + "value": "", + "description": "Represents button props that are specific to button-type elements only. Extracts the subset of `ButtonProps` that includes the `type` property.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The label text or elements displayed inside the button component, describing the action that will be performed when clicked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconType | AnyString", + "description": "An icon displayed inside the button, typically positioned before the button text. Use icons to help users quickly identify the button's action or to improve scannability. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The displayed inline width of the button.\n\n- `auto`: the size of the button depends on the surface and context.\n- `fill`: the button will takes up 100% of the available inline size.\n- `fit-content`: the button will take up the minimum inline-size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary' | 'tertiary'", + "description": "The visual appearance of the button component.\n\n- `auto`: The variant is automatically determined by the button component's context.\n- `primary`: High emphasis button for the primary action on the page. Should be used sparingly.\n- `secondary`: Medium emphasis button for secondary actions.\n- `tertiary`: Low emphasis button for less important actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "ButtonBaseProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ButtonBaseProps", + "value": "Required<\n Pick<\n ButtonOnlyProps,\n | 'accessibilityLabel'\n | 'disabled'\n | 'command'\n | 'commandFor'\n | 'icon'\n | 'interestFor'\n | 'lang'\n | 'loading'\n | 'type'\n | 'tone'\n | 'variant'\n | 'target'\n | 'href'\n | 'download'\n >\n>", + "description": "Represents the base button props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconType | AnyString", + "description": "An icon displayed inside the button, typically positioned before the button text. Use icons to help users quickly identify the button's action or to improve scannability. Accepts any icon name from the icon library or a custom string identifier.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether to replace the button content with a loading indicator while a background action is being performed.\n\nThis also disables the button component.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary' | 'tertiary'", + "description": "The visual appearance of the button component.\n\n- `auto`: The variant is automatically determined by the button component's context.\n- `primary`: High emphasis button for the primary action on the page. Should be used sparingly.\n- `secondary`: Medium emphasis button for secondary actions.\n- `tertiary`: Low emphasis button for less important actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "PreactInputProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PreactInputProps", + "value": "Required<\n Pick\n>", + "description": "Represents the essential input props required for Preact-based input elements. Includes properties like `disabled`, `id`, `name`, and `value`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ] + } + }, + "ClickableBaseProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ClickableBaseProps", + "value": "Required<\n Pick<\n ClickableProps$1,\n | 'command'\n | 'commandFor'\n | 'interestFor'\n | 'disabled'\n | 'download'\n | 'href'\n | 'lang'\n | 'loading'\n | 'overflow'\n | 'target'\n | 'type'\n >\n>", + "description": "Represents the base clickable props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the component is disabled, preventing clicks and focus. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You shouldapply disabled styling as needed.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content.\n\nUse this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the component is in a loading state, which indicates to assistive technology that an action is in progress and prevents interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button' | 'reset'", + "description": "The behavior of the button component.\n\n- `button`: Used to indicate the component acts as a button, meaning it has no default action.\n- `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).\n- `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.\n\nThis property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ] + } + }, + "PreactFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PreactFieldProps", + "value": "PreactInputProps & Required<\n Pick<\n TextFieldProps$1,\n | 'defaultValue'\n | 'details'\n | 'error'\n | 'label'\n | 'labelAccessibilityVisibility'\n | 'placeholder'\n | 'readOnly'\n | 'required'\n >\n > & {\n /**\n * Controls browser autofill behavior for the field.\n *\n * Basic values:\n * - `on` - Enables autofill without specifying content type (default)\n * - `off` - Disables autofill for sensitive data or one-time codes\n *\n * Specific field values describe the expected data type. You can optionally prefix these with:\n * - `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page)\n * - `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes\n * - Both section and group (for example, `section-primary shipping email`)\n *\n * Providing a specific autofill token helps browsers suggest more relevant saved data.\n *\n * Learn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.\n *\n * @default 'tel' for PhoneField\n * @default 'email' for EmailField\n * @default 'url' for URLField\n * @default 'on' for everything else\n */\n autocomplete: Autocomplete;\n }", + "description": "Represents the props for Preact-based form field components with autocomplete support. The generic type parameter allows specifying the valid autocomplete values for the field.", + "isPublicDocs": true + } + }, + "TextFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextFieldProps", + "value": "PreactFieldProps<\n /** @default 'on' */\n Required['autocomplete']\n> & Required<\n Pick<\n TextFieldProps$1,\n 'icon' | 'maxLength' | 'minLength' | 'prefix' | 'suffix'\n >\n >", + "description": "Represents the props for text input field components. Extends `PreactFieldProps` with autocomplete support for text-related fields.", + "isPublicDocs": true + } + }, + "ColorFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ColorFieldProps", + "value": "Omit<\n PreactFieldProps['autocomplete']>,\n 'value' | 'defaultValue'\n> & Required>", + "description": "Represents the props for color input field components. Extends `PreactFieldProps` with autocomplete support for color-related fields.", + "isPublicDocs": true + } + }, + "ReplaceType": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReplaceType", + "value": "Exclude | TTo", + "description": "A utility type that replaces occurrences of one type with another within a union type. Useful for type transformations where you need to swap out specific types.", + "isPublicDocs": true + } + }, + "EmailFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "EmailFieldProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required>", + "description": "Represents the props for email input field components. Extends `PreactFieldProps` with autocomplete support for email-related fields.", + "isPublicDocs": true + } + }, + "RequiredAlignedProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredAlignedProps", + "value": "Required", + "description": "Represents the grid component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive", + "description": "The vertical alignment of the entire grid within its container (in horizontal layouts).\n\nUse this to distribute grid rows along the block axis (vertical in left-to-right/right-to-left layouts, horizontal in vertical writing modes). This property overrides the block value set by `placeContent`.\n\nLearn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive", + "description": "The vertical alignment of grid items within their grid areas (in horizontal layouts).\n\nUse this to position items along the block axis (vertical in left-to-right/right-to-left layouts, horizontal in vertical writing modes). This property overrides the block value set by `placeItems`.\n\nLearn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateColumns", + "value": "MaybeResponsive", + "description": "The columns in the grid and their sizes.\n\nUse values like `1fr 2fr` to create fluid columns, `200px 1fr` to mix fixed and flexible columns, or `repeat(3, 1fr)` to create equal-width columns.\n\nLearn more about the [grid-template-columns property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateRows", + "value": "MaybeResponsive", + "description": "The rows in the grid and their sizes.\n\nUse values like `100px auto` to create rows with fixed and automatic heights, or `repeat(3, 100px)` to create equal-height rows.\n\nLearn more about the [grid-template-rows property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive", + "description": "The horizontal alignment of the entire grid within its container (in horizontal layouts).\n\nUse this to distribute grid columns along the inline axis (horizontal in left-to-right/right-to-left layouts, vertical in vertical writing modes). This property overrides the inline value set by `placeContent`.\n\nLearn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "justifyItems", + "value": "MaybeResponsive", + "description": "The horizontal alignment of grid items within their grid areas (in horizontal layouts).\n\nUse this to position items along the inline axis (horizontal in left-to-right/right-to-left layouts, vertical in vertical writing modes). This property overrides the inline value set by `placeItems`.\n\nLearn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeContent", + "value": "MaybeResponsive<\n `${AlignContentKeyword} ${JustifyContentKeyword}` | AlignContentKeyword\n >", + "description": "A shorthand property for `justify-content` and `align-content`.\n\nLearn more about the [place-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-content).", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeItems", + "value": "MaybeResponsive<\n `${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword\n >", + "description": "A shorthand for setting both `justify-items` and `align-items` in a single declaration.\n\nAccepts either a single value (applied to both axes) or two space-separated values (align-items justify-items).\n\nLearn more about the [place-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-items).", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ResponsiveGridProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResponsiveGridProps", + "value": "MakeResponsivePick<\n RequiredAlignedProps,\n 'rowGap' | 'columnGap' | 'gap' | 'gridTemplateColumns' | 'gridTemplateRows'\n>", + "description": "Represents grid props with responsive capabilities for layout properties.\n\nThis enables conditional styling based on container queries.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateColumns", + "value": "MaybeResponsive", + "description": "The columns in the grid and their sizes.\n\nUse values like `1fr 2fr` to create fluid columns, `200px 1fr` to mix fixed and flexible columns, or `repeat(3, 1fr)` to create equal-width columns.\n\nLearn more about the [grid-template-columns property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateRows", + "value": "MaybeResponsive", + "description": "The rows in the grid and their sizes.\n\nUse values like `100px auto` to create rows with fixed and automatic heights, or `repeat(3, 100px)` to create equal-height rows.\n\nLearn more about the [grid-template-rows property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "RequiredGridItemProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredGridItemProps", + "value": "Required", + "description": "Represents the grid item component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridColumn", + "value": "`span ${number}` | 'auto'", + "description": "The number of columns the item will span across.\n\nLearn more about the [grid-column property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gridRow", + "value": "`span ${number}` | 'auto'", + "description": "The number of rows the item will span across.\n\nLearn more about the [grid-row property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "RequiredLinkProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredLinkProps", + "value": "Required", + "description": "Represents the link component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The text or elements displayed within the link component, which navigates users to a different location when activated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "LinkBaseProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "LinkBaseProps", + "value": "Required<\n Pick<\n LinkProps$1,\n | 'accessibilityLabel'\n | 'command'\n | 'commandFor'\n | 'interestFor'\n | 'download'\n | 'href'\n | 'lang'\n | 'target'\n | 'tone'\n >\n>", + "description": "Represents the base link props with all core properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "The action that `commandFor` should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.\n- `--copy`: Copies the target `ClipboardItem`.\n\nLearn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "download", + "value": "string", + "description": "Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.\n\nThe filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.\n\nLearn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString", + "description": "The browsing context where the linked URL should be displayed.\n\n- `auto`: The target is automatically determined based on the origin of the URL.\n- `_blank`: Opens the URL in a new window or tab.\n- `_self`: Opens the URL in the same browsing context as the current one.\n- `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.\n- `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "ToneKeyword", + "description": "The semantic meaning and color treatment of the component.\n\n- `critical`: Urgent problems or destructive actions.\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.", + "isOptional": true, + "defaultValue": "'auto'" + } + ] + } + }, + "PolyfillCommandEventInit": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PolyfillCommandEventInit", + "value": "EventInit & {\n source: HTMLElement | null | undefined;\n command: PreactOverlayControlProps['command'];\n}", + "description": "Represents the initialization object for creating a polyfill command event. Used for overlay control commands in environments that require polyfills.", + "isPublicDocs": true + } + }, + "PreactOverlayControlProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PreactOverlayControlProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n\n- `--auto`: A default action for the target component.\n- `--show`: Shows the target component.\n- `--hide`: Hides the target component.\n- `--toggle`: Toggles the visibility of the target component.", + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information." + } + ], + "value": "export interface PreactOverlayControlProps\n extends Pick {\n /**\n * The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.\n *\n * - `--auto`: A default action for the target component.\n * - `--show`: Shows the target component.\n * - `--hide`: Hides the target component.\n * - `--toggle`: Toggles the visibility of the target component.\n *\n * @default '--auto'\n */\n command: Extract<\n InteractionProps['command'],\n '--show' | '--hide' | '--toggle' | '--auto'\n >;\n /**\n * The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.\n */\n commandFor: Extract;\n /**\n * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.\n */\n interestFor: Extract;\n}" + } + }, + "PolyfillCommandEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PolyfillCommandEvent", + "value": "Event & {\n source: PolyfillCommandEventInit['source'];\n command: PolyfillCommandEventInit['command'];\n /** Have to use `_s_shadowSource` because `source` is retargeted to the shadow host by browsers */\n _s_shadowSource: PolyfillCommandEventInit['source'];\n}", + "description": "Represents a polyfill command event for overlay controls. Used in environments where native command events are not available.", + "isPublicDocs": true + } + }, + "RequiredAlignedModalProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredAlignedModalProps", + "value": "Required", + "description": "Represents the modal component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.\n\nThis overrides the `heading` prop for screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterShow", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "Adjust the padding around the modal content.\n\n`base`: applies padding that is appropriate for the element.\n\n`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.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "showOverlay", + "value": "() => void", + "description": "A method to programmatically show the overlay." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "SizeKeyword | 'max'", + "description": "Adjust the size of the modal.\n\n`max`: expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "toggleOverlay", + "value": "() => void", + "description": "A method to programmatically toggle the visibility of the overlay." + } + ] + } + }, + "ContextCallback": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ContextCallback", + "description": "A callback which is provided by a context requester and is called with the value satisfying the request. This callback can be called multiple times by context providers as the requested value is changed.", + "isPublicDocs": true, + "params": [ + { + "name": "value", + "description": "", + "value": "T", + "filePath": "src/surfaces/admin/components.ts" + } + ], + "returns": { + "filePath": "src/surfaces/admin/components.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "(value: T) => void" + } + }, + "RequiredMoneyFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredMoneyFieldProps", + "value": "Required", + "description": "Represents the money field component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "| AutocompleteField\n | `${AutocompleteSection} ${AutocompleteField}`\n | `${AutocompleteGroup} ${AutocompleteField}`\n | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}`\n | 'on'\n | 'off'", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on' for everything else" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "controls", + "value": "'auto' | 'stepper' | 'none'", + "description": "The type of controls displayed in the field.\n\n- `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled.\n- `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.\n- `auto`: the presence of the controls depends on the surface and context.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "string", + "description": "Supplementary text displayed below the checkbox to provide additional context, instructions, or help. Use this to explain what checking the box means or provide guidance to users. This text is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the checkbox to indicate validation problems. When set, the checkbox is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone (default).\n- `exclusive`: The label is visually hidden but still announced by screen readers.\n\nUse `exclusive` when the surrounding context makes the label redundant visually, but screen reader users still need it for clarity.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "description": "The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.\n\nUsers can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "description": "The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum number.\n\nUsers can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the component receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "description": "Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "", + "isOptional": true + } + ] + } + }, + "PasswordFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PasswordFieldProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required<\n Pick<\n PasswordFieldProps$1,\n | 'defaultValue'\n | 'details'\n | 'disabled'\n | 'error'\n | 'labelAccessibilityVisibility'\n | 'minLength'\n | 'maxLength'\n | 'label'\n | 'name'\n | 'placeholder'\n | 'readOnly'\n | 'required'\n | 'value'\n >\n >", + "description": "Represents the props for password input field components. Extends `PreactFieldProps` with autocomplete support for password-related fields.", + "isPublicDocs": true + } + }, + "Popover": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "Popover", + "description": "Configure the following properties on the popover component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "defaultValue": "'auto'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "defaultValue": "'0'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "defaultValue": "'none'", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHidden@2725", + "value": "boolean", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayActivator@2726", + "value": "HTMLElement", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertyDeclaration", + "name": "__@overlayHideFrameId@2727", + "value": "number", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "setAttribute", + "value": "(name: string, value: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "attributeChangedCallback", + "value": "(name: string) => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "connectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "disconnectedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "adoptedCallback", + "value": "() => void", + "description": "", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "queueRender", + "value": "() => void", + "description": "A method that queues a run of the render function. You shouldn't need to call this manually - it should be handled by changes to", + "isPrivate": true, + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "MethodDeclaration", + "name": "click", + "value": "({ sourceEvent }?: ClickOptions) => void", + "description": "A method like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.\n\nFor example, if the `sourceEvent` was a middle click, or has particular keys held down, components will attempt to produce the desired behavior on links, such as opening the page in the background tab.", + "isPrivate": true, + "isOptional": true + } + ], + "value": "declare class Popover\n extends PreactPopoverElement\n implements PopoverProps\n{\n constructor();\n}" + } + }, + "SearchFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SearchFieldProps", + "value": "PreactFieldProps<\n /**\n * @default 'on'\n */\n Required['autocomplete']\n> & Required<\n Pick<\n TextFieldProps$1,\n | 'defaultValue'\n | 'details'\n | 'disabled'\n | 'error'\n | 'labelAccessibilityVisibility'\n | 'minLength'\n | 'maxLength'\n | 'label'\n | 'name'\n | 'placeholder'\n | 'readOnly'\n | 'required'\n | 'value'\n >\n >", + "description": "Represents the props for search input field components. Extends `PreactFieldProps` for search-specific functionality.", + "isPublicDocs": true + } + }, + "RequiredSectionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RequiredSectionProps", + "value": "Required", + "description": "Represents the section component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "The padding applied to all edges of the element.\n\n- `base`: applies padding that is appropriate for the element. Note that it might result in no padding if this is the right design decision in a particular context.\n- `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.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primaryAction", + "value": "ComponentChildren", + "description": "The primary action button or link, representing the main or most important action available in this context. Typically displayed with higher visual prominence than secondary actions to establish clear hierarchy.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryActions", + "value": "ComponentChildren", + "description": "Additional action buttons or links that provide alternative or supporting actions. Visually de-emphasized compared to the primary action.", + "isOptional": true + } + ] + } + }, + "AlignedStackProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AlignedStackProps", + "value": "Required", + "description": "Represents the stack component props with all properties marked as required.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "The visibility mode of the element for both visual and assistive technology users.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive", + "description": "The alignment of multiple lines of content along the stack component's cross axis.\n\nThis only applies when content wraps to multiple lines (typically in inline direction).\n\nLearn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive", + "description": "The alignment of individual children along the stack component's cross axis (perpendicular to the stacking direction).\n\nFor example, in a vertical stack (block direction), this controls horizontal alignment of each child.\n\nLearn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "BackgroundColorKeyword", + "description": "The background color of the element. Use `transparent` for no background, `subdued` for a subtle background, `base` for standard background, or `strong` for a prominent background.\n\n- `transparent`: No background, allowing the underlying surface to show through.\n- `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).\n\nBlock size adjusts based on the writing direction: in horizontal layouts, it controls the height; in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.\n\nLearn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A border applied using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "ColorKeyword | ''", + "description": "The color of the border using the design system's color scale.\n\nWhen set, this overrides the color value specified in the `border` property. Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty", + "description": "The roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\n- `small`: Thin border for subtle definition.\n- `small-100`: Extra thin border for minimal emphasis.\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `none`: No border.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "MaybeResponsive<'block' | 'inline'>", + "description": "The direction in which children are arranged within the stack.\n\n- `block`: Arranges children vertically in a column (in horizontal writing modes). Children will not wrap.\n- `inline`: Arranges children horizontally in a row (in horizontal writing modes). Children will wrap to the next line if needed.\n\nThis uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values) to ensure proper behavior across different writing modes.", + "isOptional": true, + "defaultValue": "'block'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<'auto' | 'none'>", + "description": "The outer display type of the component, The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: the component’s initial value. The actual value depends on the component and context.\n- `none`: hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The horizontal size of the element in standard layouts (width in left-to-right or right-to-left writing modes).\n\nInline size adjusts based on the writing direction: in horizontal layouts, it controls the width; in vertical layouts, it controls the height. This ensures consistent behavior across different text directions.\n\nLearn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive", + "description": "The distribution of children along the stack component's main axis (the direction of stacking).\n\nFor example, in a vertical stack (block direction), this controls vertical distribution. Use this to space out children or align them to the start, center, or end.\n\nLearn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum vertical size of the element in standard layouts (max-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the block axis.\n\nLearn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum horizontal size of the element in standard layouts (max-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming larger than this size along the inline axis.\n\nLearn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum vertical size of the element in standard layouts (min-height in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the block axis.\n\nLearn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum horizontal size of the element in standard layouts (min-width in left-to-right or right-to-left writing modes).\n\nPrevents the element from becoming smaller than this size along the inline axis.\n\nLearn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: the content that extends beyond the element’s container is visible.\n- `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.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive<\n MaybeTwoValuesShorthandProperty | ''\n >", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "ResponsiveStackProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ResponsiveStackProps", + "value": "MakeResponsivePick<\n AlignedStackProps,\n 'gap' | 'rowGap' | 'columnGap' | 'direction'\n>", + "description": "Represents stack props with responsive capabilities for layout properties.\n\nThis enables conditional styling based on container queries.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The horizontal spacing between elements (in horizontal writing modes).\n\nSets the gap along the inline axis. This overrides the column value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "MaybeResponsive<'block' | 'inline'>", + "description": "The direction in which children are arranged within the stack.\n\n- `block`: Arranges children vertically in a column (in horizontal writing modes). Children will not wrap.\n- `inline`: Arranges children horizontally in a row (in horizontal writing modes). Children will wrap to the next line if needed.\n\nThis uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values) to ensure proper behavior across different writing modes.", + "isOptional": true, + "defaultValue": "'block'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements.\n\nAccepts a single value to apply to both axes, or two space-separated values to set the row and column gaps independently. For example: `large-100 large-500` sets the row gap to `large-100` and column gap to `large-500`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The vertical spacing between elements (in horizontal writing modes).\n\nSets the gap along the block axis. This overrides the row value specified in `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ] + } + }, + "TextAreaProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TextAreaProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required>", + "description": "Represents the props for textarea components. Extends `PreactFieldProps` for multi-line text input functionality.", + "isPublicDocs": true + } + }, + "URLFieldProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "URLFieldProps", + "value": "PreactFieldProps<\n Required['autocomplete']\n> & Required>", + "description": "Represents the props for URL input field components. Extends `PreactFieldProps` with autocomplete support for URL-related fields.", + "isPublicDocs": true + } + }, + "AdminActionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminActionProps", + "description": "Configure the following properties on the admin action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The text to use as the action modal's title. If not provided, the name of the extension will be used.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the action is in a loading state, such as during initial page load or when the action is being opened. When `true`, the action is in an inert state that prevents user interaction.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface AdminActionProps\n extends Pick {}" + } + }, + "AdminBlockProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminBlockProps", + "description": "Configure the following properties on the admin block component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "collapsedSummary", + "value": "string", + "description": "The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The text displayed as the block's title in the header. If not provided, the extension name will be used.", + "isOptional": true + } + ], + "value": "export interface AdminBlockProps\n extends Pick {}" + } + }, + "AdminPrintActionProps": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminPrintActionProps", + "description": "Configure the following properties on the admin print action component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The URL of the document to preview and print. Supports HTML, PDF, and image formats. If not provided, the preview will show an empty state and the print button will be disabled.", + "isOptional": true + } + ], + "value": "export interface AdminPrintActionProps\n extends Pick {}" + } + }, + "FunctionSettingsErrorEvent": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "FunctionSettingsErrorEvent", + "value": "AggregateErrorEvent", + "description": "Represents the event type for function settings errors. Extracted from the parameters of the `onFunctionSettingsError` callback.", + "isPublicDocs": true + } + }, + "AvatarEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AvatarEvents", + "description": "The avatar component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "OnErrorEventHandler", + "description": "A callback fired when the avatar image fails to load.\n\nLearn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "load", + "value": "CallbackEventListener | null", + "description": "A callback fired when the avatar image successfully loads.\n\nLearn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).", + "isOptional": true + } + ], + "value": "export interface AvatarEvents {\n /**\n * A callback fired when the avatar image successfully loads.\n *\n * Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).\n */\n load: CallbackEventListener | null = null;\n /**\n * A callback fired when the avatar image fails to load.\n *\n * Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).\n */\n error: OnErrorEventHandler = null;\n}" + } + }, + "BadgeSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BadgeSlots", + "description": "The badge component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text label displayed within the badge component, typically a short status indicator or category label.", + "isOptional": true + } + ], + "value": "export interface BadgeSlots {\n /**\n * The text label displayed within the badge component, typically a short status indicator or category label.\n */\n children?: HTMLElement;\n}" + } + }, + "BannerEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BannerEvents", + "description": "The banner component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the banner is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "dismiss", + "value": "CallbackEventListener | null", + "description": "A callback fired when the banner is dismissed.", + "isOptional": true + } + ], + "value": "export interface BannerEvents {\n /**\n * A callback fired when the banner is dismissed.\n */\n dismiss: CallbackEventListener | null = null;\n /**\n * A callback fired after the banner is hidden.\n */\n afterhide: CallbackEventListener | null = null;\n}" + } + }, + "BannerSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BannerSlots", + "description": "The banner component supports slots for additional content placement within the banner. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The main message content displayed within the banner component, providing important information or guidance to users.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Action buttons displayed at the bottom of the banner that let users respond to the message. Accepts up to two button components with `variant=\"secondary\"` or `variant=\"auto\"`.", + "isOptional": true + } + ], + "value": "export interface BannerSlots {\n /**\n * The main message content displayed within the banner component, providing important information or guidance to users.\n */\n children?: HTMLElement;\n /**\n * Action buttons displayed at the bottom of the banner that let users respond to the message.\n * Accepts up to two button components with `variant=\"secondary\"` or `variant=\"auto\"`.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "BoxSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "BoxSlots", + "description": "The box component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the box component, which serves as a flexible container for organizing and styling other components.", + "isOptional": true + } + ], + "value": "export interface BoxSlots {\n /**\n * The content displayed within the box component, which serves as a flexible container for organizing and styling other components.\n */\n children?: HTMLElement;\n}" + } + }, + "ButtonEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonEvents", + "description": "The button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener | null", + "description": "A callback fired when the button loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the button is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener | null", + "description": "A callback fired when the button receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface ButtonEvents {\n /**\n * A callback fired when the button is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n /**\n * A callback fired when the button loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener | null = null;\n /**\n * A callback fired when the button receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener | null = null;\n}" + } + }, + "ButtonSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonSlots", + "description": "The button component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The label text or elements displayed inside the button component, describing the action that will be performed when clicked.", + "isOptional": true + } + ], + "value": "export interface ButtonSlots {\n /**\n * The label text or elements displayed inside the button component, describing the action that will be performed when clicked.\n */\n children?: HTMLElement;\n}" + } + }, + "ButtonGroupSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ButtonGroupSlots", + "description": "The button group component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The buttons displayed within the button group component, which are arranged together as a cohesive set of related actions.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action for this group, displayed with high visual emphasis. Accepts a single button with `variant=\"primary\"`.\n\nUse this for the primary action you want users to take. This can't be used when `gap=\"none\"`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Supporting actions displayed with less emphasis than the primary action. Accepts one or more button components with `variant=\"secondary\"` or `variant=\"auto\"`.\n\nUse these for alternative or less critical actions.", + "isOptional": true + } + ], + "value": "export interface ButtonGroupSlots {\n /**\n * The buttons displayed within the button group component, which are arranged together as a cohesive set of related actions.\n */\n children?: HTMLElement;\n /**\n * The main action for this group, displayed with high visual emphasis.\n * Accepts a single button with `variant=\"primary\"`.\n *\n * Use this for the primary action you want users to take. This can't be used when `gap=\"none\"`.\n */\n 'primary-action'?: HTMLElement;\n /**\n * Supporting actions displayed with less emphasis than the primary action.\n * Accepts one or more button components with `variant=\"secondary\"` or `variant=\"auto\"`.\n *\n * Use these for alternative or less critical actions.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "CheckboxEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "CheckboxEvents", + "description": "The checkbox component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the checkbox.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface CheckboxEvents {\n /**\n * A callback fired when the checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the checkbox.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n}" + } + }, + "ChipSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChipSlots", + "description": "The chip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "HTMLElement", + "description": "An optional icon to display at the start of the chip. Accepts only icon components.", + "isOptional": true + } + ], + "value": "export interface ChipSlots {\n /**\n * The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.\n */\n children?: HTMLElement;\n /**\n * An optional icon to display at the start of the chip. Accepts only icon components.\n */\n graphic?: HTMLElement;\n}" + } + }, + "ChoiceSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceSlots", + "description": "The choice list component supports slots for additional content placement within each choice. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The label text or elements that identify this selectable choice to users.\n\nThe label is produced by extracting and concatenating the text nodes from the provided content; any markup or element structure is ignored.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "HTMLElement", + "description": "Additional text to provide context or guidance for the input.\n\nThis text is displayed along with the input and its label to offer more information or instructions to the user.", + "isOptional": true + } + ], + "value": "export interface ChoiceSlots {\n /**\n * The label text or elements that identify this selectable choice to users.\n *\n * The label is produced by extracting and\n * concatenating the text nodes from the provided content;\n * any markup or element structure is ignored.\n */\n children?: HTMLElement;\n /**\n * Additional text to provide context or guidance for the input.\n *\n * This text is displayed along with the input and its label\n * to offer more information or instructions to the user.\n *\n * @implementation this content should be linked to the input with an `aria-describedby` attribute.\n */\n details?: HTMLElement;\n}" + } + }, + "ChoiceListEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceListEvents", + "description": "The choice list component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener | null", + "description": "A callback fired when the choice list selection changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user inputs data into the choice list.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ChoiceListEvents {\n /**\n * A callback fired when the choice list selection changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener | null = null;\n /**\n * A callback fired when the user inputs data into the choice list.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener | null = null;\n}" + } + }, + "ChoiceListSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ChoiceListSlots", + "description": "The choice list component supports slots for additional content placement within each choice. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The choices a user can select from.\n\nAccepts choice components.", + "isOptional": true + } + ], + "value": "export interface ChoiceListSlots {\n /**\n * The choices a user can select from.\n *\n * Accepts choice components.\n */\n children?: HTMLElement;\n}" + } + }, + "ClickableEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableEvents", + "description": "The clickable component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener | null", + "description": "A callback fired when the component loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the component is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener | null", + "description": "A callback fired when the component receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface ClickableEvents {\n /**\n * A callback fired when the component is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n /**\n * A callback fired when the component loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener | null = null;\n /**\n * A callback fired when the component receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener | null = null;\n}" + } + }, + "ClickableSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableSlots", + "description": "The clickable component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the clickable component, which makes any content interactive and clickable without the semantic meaning of a button or link.", + "isOptional": true + } + ], + "value": "export interface ClickableSlots {\n /**\n * The content displayed within the clickable component, which makes any content interactive and clickable without the semantic meaning of a button or link.\n */\n children?: HTMLElement;\n}" + } + }, + "ClickableChipEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableChipEvents", + "description": "The clickable chip component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the chip is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the chip is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "remove", + "value": "CallbackEventListener | null", + "description": "A callback fired when the chip is removed.", + "isOptional": true + } + ], + "value": "export interface ClickableChipEvents {\n /**\n * A callback fired when the chip is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n /**\n * A callback fired when the chip is removed.\n */\n remove: CallbackEventListener | null = null;\n /**\n * A callback fired after the chip is hidden.\n */\n afterhide: CallbackEventListener | null = null;\n}" + } + }, + "ClickableChipSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ClickableChipSlots", + "description": "The clickable chip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text label displayed within the chip, which represents an interactive filter, tag, or selectable item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "HTMLElement", + "description": "An optional icon to display at the start of the chip. Accepts only icon components.", + "isOptional": true + } + ], + "value": "export interface ClickableChipSlots {\n /**\n * The text label displayed within the chip, which represents an interactive filter, tag, or selectable item.\n */\n children?: HTMLElement;\n /**\n * An optional icon to display at the start of the chip. Accepts only icon components.\n */\n graphic?: HTMLElement;\n}" + } + }, + "ColorFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorFieldEvents", + "description": "The color field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the color field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the color field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the color field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the color field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ColorFieldEvents {\n /**\n * A callback fired when the color field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the color field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the color field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the color field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "ColorPickerEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ColorPickerEvents", + "description": "The color picker component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener | null", + "description": "A callback fired when the color picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user inputs data into the color picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ColorPickerEvents {\n /**\n * A callback fired when the color picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener | null = null;\n /**\n * A callback fired when the user inputs data into the color picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener | null = null;\n}" + } + }, + "DateFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DateFieldEvents", + "description": "The date field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the date field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the date field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the date field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the date field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "invalid", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date field value is invalid.\n\nLearn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "viewchange", + "value": "CallbackEventListener | null", + "description": "A callback fired when the calendar view changes (such as when navigating between months).", + "isOptional": true + } + ], + "value": "export interface DateFieldEvents {\n /**\n * A callback fired when the date field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the date field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the date field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the date field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n /**\n * A callback fired when the calendar view changes (such as when navigating between months).\n */\n viewchange: CallbackEventListener | null = null;\n /**\n * A callback fired when the date field value is invalid.\n *\n * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).\n */\n invalid: CallbackEventListener | null = null;\n}" + } + }, + "DatePickerEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DatePickerEvents", + "description": "The date picker component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date picker loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener | null", + "description": "A callback fired when the date picker receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user inputs data into the date picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "viewchange", + "value": "CallbackEventListener | null", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", + "isOptional": true + } + ], + "value": "export interface DatePickerEvents {\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewchange: CallbackEventListener | null = null;\n /**\n * A callback fired when the date picker receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener | null = null;\n /**\n * A callback fired when the date picker loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener | null = null;\n /**\n * A callback fired when the user inputs data into the date picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener | null = null;\n /**\n * A callback fired when the date picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener | null = null;\n}" + } + }, + "DropZoneEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DropZoneEvents", + "description": "The drop zone component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the drop zone value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "droprejected", + "value": "CallbackEventListener", + "description": "A callback fired when a dropped file is rejected due to file type or size restrictions.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the drop zone.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface DropZoneEvents {\n /**\n * A callback fired when the drop zone value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener = null;\n /**\n * A callback fired when the user inputs data into the drop zone.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener = null;\n /**\n * A callback fired when a dropped file is rejected due to file type or size restrictions.\n */\n droprejected: CallbackEventListener = null;\n}" + } + }, + "DropZoneSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "DropZoneSlots", + "description": "The drop zone component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content to include inside the drop zone container", + "isOptional": true + } + ], + "value": "export interface DropZoneSlots {\n /**\n * The content to include inside the drop zone container\n */\n children?: HTMLElement;\n}" + } + }, + "EmailFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "EmailFieldEvents", + "description": "The email field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the email field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the email field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the email field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the email field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface EmailFieldEvents {\n /**\n * A callback fired when the email field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the email field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the email field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "GridSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "GridSlots", + "description": "The grid component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The child elements displayed within the grid component, which are arranged in a flexible grid layout with configurable columns, rows, and spacing.", + "isOptional": true + } + ], + "value": "export interface GridSlots {\n /**\n * The child elements displayed within the grid component, which are arranged in a flexible grid layout with configurable columns, rows, and spacing.\n */\n children?: HTMLElement;\n}" + } + }, + "GridItemSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "GridItemSlots", + "description": "The grid item component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the grid item component, which represents a single cell in the grid layout and can span multiple columns or rows.", + "isOptional": true + } + ], + "value": "export interface GridItemSlots {\n /**\n * The content displayed within the grid item component, which represents a single cell in the grid layout and can span multiple columns or rows.\n */\n children?: HTMLElement;\n}" + } + }, + "HeadingSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "HeadingSlots", + "description": "The heading component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The heading text displayed within the heading component, which provides a title or section header for content.", + "isOptional": true + } + ], + "value": "export interface HeadingSlots {\n /**\n * The heading text displayed within the heading component, which provides a title or section header for content.\n */\n children?: HTMLElement;\n}" + } + }, + "ImageEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ImageEvents", + "description": "The image component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "OnErrorEventHandler", + "description": "A callback fired when the image fails to load.\n\nLearn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "load", + "value": "CallbackEventListener | null", + "description": "A callback fired when the image successfully loads.\n\nLearn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).", + "isOptional": true + } + ], + "value": "export interface ImageEvents {\n /**\n * A callback fired when the image successfully loads.\n *\n * Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).\n */\n load: CallbackEventListener | null = null;\n /**\n * A callback fired when the image fails to load.\n *\n * Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).\n */\n error: OnErrorEventHandler = null;\n}" + } + }, + "LinkEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LinkEvents", + "description": "The link component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener | null", + "description": "A callback fired when the link is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + } + ], + "value": "export interface LinkEvents {\n /**\n * A callback fired when the link is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click: CallbackEventListener | null = null;\n}" + } + }, + "LinkSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "LinkSlots", + "description": "The link component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text or elements displayed within the link component, which navigates users to a different location when activated.", + "isOptional": true + } + ], + "value": "export interface LinkSlots {\n /**\n * The text or elements displayed within the link component, which navigates users to a different location when activated.\n */\n children?: HTMLElement;\n}" + } + }, + "ListItemSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ListItemSlots", + "description": "The list item component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the list item, which represents a single entry in an ordered or unordered list.", + "isOptional": true + } + ], + "value": "export interface ListItemSlots {\n /**\n * The content displayed within the list item, which represents a single entry in an ordered or unordered list.\n */\n children?: HTMLElement;\n}" + } + }, + "MenuSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MenuSlots", + "description": "The menu component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The items displayed within the menu. Only accepts button and section components. Use button for individual menu actions and section to group related items.", + "isOptional": true + } + ], + "value": "export interface MenuSlots {\n /**\n * The items displayed within the menu. Only accepts button and section components. Use button for individual menu actions and section to group related items.\n */\n children?: HTMLElement;\n}" + } + }, + "ModalEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ModalEvents", + "description": "The modal component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the modal is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aftershow", + "value": "CallbackEventListener | null", + "description": "A callback fired after the modal is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "CallbackEventListener | null", + "description": "A callback fired when the modal is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "CallbackEventListener | null", + "description": "A callback fired when the modal is shown.", + "isOptional": true + } + ], + "value": "export interface ModalEvents {\n /**\n * A callback fired when the modal is hidden.\n */\n hide: CallbackEventListener | null = null;\n /**\n * A callback fired when the modal is shown.\n */\n show: CallbackEventListener | null = null;\n /**\n * A callback fired after the modal is hidden.\n */\n afterhide: CallbackEventListener | null = null;\n /**\n * A callback fired after the modal is shown.\n */\n aftershow: CallbackEventListener | null = null;\n}" + } + }, + "ModalSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ModalSlots", + "description": "The modal component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the modal component, typically including form fields, information, or interactive elements.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action button displayed in the modal footer, representing the primary action users should take.\n\nOnly accepts a single button component with a `variant` of `primary`. This action should align with the modal's main purpose.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Additional action buttons displayed in the modal footer, providing alternative or supporting actions.\n\nOnly accepts button components with a `variant` of `secondary` or `auto`. These are visually de-emphasized to establish clear hierarchy.", + "isOptional": true + } + ], + "value": "export interface ModalSlots {\n /**\n * The content displayed within the modal component, typically including form fields, information, or interactive elements.\n */\n children?: HTMLElement;\n /**\n * The main action button displayed in the modal footer, representing the primary action users should take.\n *\n * Only accepts a single button component with a `variant` of `primary`. This action should align with the modal's main purpose.\n */\n 'primary-action'?: HTMLElement;\n /**\n * Additional action buttons displayed in the modal footer, providing alternative or supporting actions.\n *\n * Only accepts button components with a `variant` of `secondary` or `auto`. These are visually de-emphasized to establish clear hierarchy.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "MoneyFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "MoneyFieldEvents", + "description": "The money field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the money field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the money field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the money field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the money field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface MoneyFieldEvents {\n /**\n * A callback fired when the money field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the money field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the money field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "NumberFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "NumberFieldEvents", + "description": "The number field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the number field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the number field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the number field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the number field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface NumberFieldEvents {\n /**\n * A callback fired when the number field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the number field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the number field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "OptionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OptionSlots", + "description": "The option component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text or elements displayed as the option label, which identifies the selectable choice to users in a dropdown or selection list.", + "isOptional": true + } + ], + "value": "export interface OptionSlots {\n /**\n * The text or elements displayed as the option label, which identifies the selectable choice to users in a dropdown or selection list.\n */\n children?: HTMLElement;\n}" + } + }, + "OptionGroupSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OptionGroupSlots", + "description": "The option group component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.", + "isOptional": true + } + ], + "value": "export interface OptionGroupSlots {\n /**\n * The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.\n */\n children?: HTMLElement;\n}" + } + }, + "OrderedListSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "OrderedListSlots", + "description": "The ordered list component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The list entries displayed within the ordered list, where each item is numbered sequentially. Only accepts list item components as children. Each list item represents a single numbered entry in the sequence.", + "isOptional": true + } + ], + "value": "export interface OrderedListSlots {\n /**\n * The list entries displayed within the ordered list, where each item is numbered sequentially. Only accepts list item components as children. Each list item represents a single numbered entry in the sequence.\n */\n children?: HTMLElement;\n}" + } + }, + "PageSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PageSlots", + "description": "The page component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aside", + "value": "HTMLElement", + "description": "The content to display in the aside section of the page.\n\nThis slot is only rendered when `inlineSize` is \"base\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "breadcrumb-actions", + "value": "HTMLElement", + "description": "The navigation back actions for the page.\n\nOnly accepts link components.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The main page content displayed within the page component, which serves as the primary container for the page's information and interface elements.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The primary action for the page.\n\nOnly accepts a single button component with a `variant` of `primary`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "The secondary actions for the page.\n\nOnly accepts button group and button components with a `variant` of `secondary` or `auto`.", + "isOptional": true + } + ], + "value": "export interface PageSlots {\n /**\n * The main page content displayed within the page component, which serves as the primary container for the page's information and interface elements.\n */\n children?: HTMLElement;\n /**\n * The content to display in the aside section of the page.\n *\n * This slot is only rendered when `inlineSize` is \"base\".\n */\n aside?: HTMLElement;\n /**\n * The primary action for the page.\n *\n * Only accepts a single button component with a `variant` of `primary`.\n *\n */\n 'primary-action'?: HTMLElement;\n /**\n * The secondary actions for the page.\n *\n * Only accepts button group and button components with a `variant` of `secondary` or `auto`.\n */\n 'secondary-actions'?: HTMLElement;\n /**\n * The navigation back actions for the page.\n *\n * Only accepts link components.\n */\n 'breadcrumb-actions'?: HTMLElement;\n}" + } + }, + "ParagraphSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ParagraphSlots", + "description": "The paragraph component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling.", + "isOptional": true + } + ], + "value": "export interface ParagraphSlots {\n /**\n * The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling.\n */\n children?: HTMLElement;\n}" + } + }, + "PasswordFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PasswordFieldEvents", + "description": "The password field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the password field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the password field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the password field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the password field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface PasswordFieldEvents {\n /**\n * A callback fired when the password field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the password field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the password field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "PopoverEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PopoverEvents", + "description": "The popover component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener | null", + "description": "A callback fired after the popover is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aftershow", + "value": "CallbackEventListener | null", + "description": "A callback fired after the popover is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "aftertoggle", + "value": "CallbackEventListener | null", + "description": "A callback fired after the popover is toggled.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "CallbackEventListener | null", + "description": "A callback fired when the popover is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "CallbackEventListener | null", + "description": "A callback fired when the popover is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "toggle", + "value": "CallbackEventListener | null", + "description": "A callback fired when the popover is toggled.", + "isOptional": true + } + ], + "value": "export interface PopoverEvents {\n /**\n * A callback fired when the popover is shown.\n */\n show: CallbackEventListener | null;\n /**\n * A callback fired when the popover is hidden.\n */\n hide: CallbackEventListener | null;\n /**\n * A callback fired after the popover is shown.\n */\n aftershow: CallbackEventListener | null;\n /**\n * A callback fired after the popover is hidden.\n */\n afterhide: CallbackEventListener | null;\n /**\n * A callback fired when the popover is toggled.\n */\n toggle: CallbackEventListener | null;\n /**\n * A callback fired after the popover is toggled.\n */\n aftertoggle: CallbackEventListener | null;\n}" + } + }, + "PopoverSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "PopoverSlots", + "description": "The popover component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the popover component, which appears in an overlay positioned relative to its trigger element.", + "isOptional": true + } + ], + "value": "export interface PopoverSlots {\n /**\n * The content displayed within the popover component, which appears in an overlay positioned relative to its trigger element.\n */\n children?: HTMLElement;\n}" + } + }, + "QueryContainerSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "QueryContainerSlots", + "description": "The query container component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the query container component, which enables container queries for responsive styling based on the container's size rather than the viewport.", + "isOptional": true + } + ], + "value": "export interface QueryContainerSlots {\n /**\n * The content displayed within the query container component, which enables container queries for responsive styling based on the container's size rather than the viewport.\n */\n children?: HTMLElement;\n}" + } + }, + "SearchFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SearchFieldEvents", + "description": "The search field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the search field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the search field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the search field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the search field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface SearchFieldEvents {\n /**\n * A callback fired when the search field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the search field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the search field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the search field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "SectionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SectionSlots", + "description": "The section component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.", + "isOptional": true + } + ], + "value": "export interface SectionSlots {\n /**\n * The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.\n */\n children?: HTMLElement;\n}" + } + }, + "SelectEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SelectEvents", + "description": "The select component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the select value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the select.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface SelectEvents {\n /**\n * A callback fired when the select value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the select.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n}" + } + }, + "SelectSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SelectSlots", + "description": "The select component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The selectable options displayed in the dropdown list. Accepts option components for individual selectable items, and option group components to organize related options into logical groups with labels.", + "isOptional": true + } + ], + "value": "export interface SelectSlots {\n /**\n * The selectable options displayed in the dropdown list. Accepts option components for individual selectable items, and option group components to organize related options into logical groups with labels.\n */\n children?: HTMLElement;\n}" + } + }, + "StackSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "StackSlots", + "description": "The stack component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.", + "isOptional": true + } + ], + "value": "export interface StackSlots {\n /**\n * The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.\n */\n children?: HTMLElement;\n}" + } + }, + "SwitchEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "SwitchEvents", + "description": "The switch component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the switch value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the switch.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface SwitchEvents {\n /**\n * A callback fired when the switch value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the switch.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n}" + } + }, + "TableEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableEvents", + "description": "The table component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "nextpage", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user navigates to the next page.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "previouspage", + "value": "CallbackEventListener | null", + "description": "A callback fired when the user navigates to the previous page.", + "isOptional": true + } + ], + "value": "export interface TableEvents {\n /**\n * A callback fired when the user navigates to the previous page.\n */\n previouspage: CallbackEventListener | null = null;\n /**\n * A callback fired when the user navigates to the next page.\n */\n nextpage: CallbackEventListener | null = null;\n}" + } + }, + "TableSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableSlots", + "description": "The table component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The table structure defining headers and data rows.\n\nAccepts table header row (for column headers) and table body (for data rows) components. Structure your table with a table header row first, followed by table body.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "filters", + "value": "HTMLElement", + "description": "Filter controls displayed above the table.\n\nAccepts input components like search field or select for filtering table data. These controls appear in a dedicated area above the table content.", + "isOptional": true + } + ], + "value": "export interface TableSlots {\n /**\n * The table structure defining headers and data rows.\n *\n * Accepts table header row (for column headers) and table body (for data rows) components. Structure your table with a table header row first, followed by table body.\n */\n children?: HTMLElement;\n /**\n * Filter controls displayed above the table.\n *\n * Accepts input components like search field or select for filtering table data. These controls appear in a dedicated area above the table content.\n */\n filters?: HTMLElement;\n}" + } + }, + "TableBodySlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableBodySlots", + "description": "The table body component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The data rows displayed in the table body.\n\nAccepts table row components, with each row representing a single record or entry in the table.", + "isOptional": true + } + ], + "value": "export interface TableBodySlots {\n /**\n * The data rows displayed in the table body.\n *\n * Accepts table row components, with each row representing a single record or entry in the table.\n */\n children?: HTMLElement;\n}" + } + }, + "TableCellSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableCellSlots", + "description": "The table cell component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The data value displayed in this cell.\n\nAccepts text content or inline components representing the cell's data value.", + "isOptional": true + } + ], + "value": "export interface TableCellSlots {\n /**\n * The data value displayed in this cell.\n *\n * Accepts text content or inline components representing the cell's data value.\n */\n children?: HTMLElement;\n}" + } + }, + "TableHeaderSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeaderSlots", + "description": "The table header component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The column heading text.\n\nThis text labels the column in table variant and appears as a label for data in list variant.", + "isOptional": true + } + ], + "value": "export interface TableHeaderSlots {\n /**\n * The column heading text.\n *\n * This text labels the column in table variant and appears as a label for data in list variant.\n */\n children?: HTMLElement;\n}" + } + }, + "TableHeaderRowSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableHeaderRowSlots", + "description": "The table header row component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The column headers displayed in the table header row.\n\nAccepts table header components, with each header defining a column and providing its label.", + "isOptional": true + } + ], + "value": "export interface TableHeaderRowSlots {\n /**\n * The column headers displayed in the table header row.\n *\n * Accepts table header components, with each header defining a column and providing its label.\n */\n children?: HTMLElement;\n}" + } + }, + "TableRowSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TableRowSlots", + "description": "The table row component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The data cells displayed in this table row.\n\nAccepts table cell components, with each cell containing a data value for the corresponding column.", + "isOptional": true + } + ], + "value": "export interface TableRowSlots {\n /**\n * The data cells displayed in this table row.\n *\n * Accepts table cell components, with each cell containing a data value for the corresponding column.\n */\n children?: HTMLElement;\n}" + } + }, + "TextSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextSlots", + "description": "The text component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.", + "isOptional": true + } + ], + "value": "export interface TextSlots {\n /**\n * The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.\n */\n children?: HTMLElement;\n}" + } + }, + "TextAreaEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextAreaEvents", + "description": "The text area component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text area loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text area value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text area receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the text area.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface TextAreaEvents {\n /**\n * A callback fired when the text area value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text area loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text area receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "TextFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextFieldEvents", + "description": "The text field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the text field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the text field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface TextFieldEvents {\n /**\n * A callback fired when the text field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the text field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "TextFieldSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TextFieldSlots", + "description": "The text field component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the text field.\n\nAccepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface TextFieldSlots {\n /**\n * Additional interactive content displayed within the text field.\n *\n * Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "ThumbnailEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "ThumbnailEvents", + "description": "The thumbnail component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "OnErrorEventHandler", + "description": "A callback fired when the thumbnail image fails to load.\n\nLearn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "load", + "value": "CallbackEventListener | null", + "description": "A callback fired when the thumbnail image successfully loads.\n\nLearn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).", + "isOptional": true + } + ], + "value": "export interface ThumbnailEvents {\n /**\n * A callback fired when the thumbnail image successfully loads.\n *\n * Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/load_event).\n */\n load: CallbackEventListener | null = null;\n /**\n * A callback fired when the thumbnail image fails to load.\n *\n * Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/error_event).\n */\n error: OnErrorEventHandler = null;\n}" + } + }, + "TooltipSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "TooltipSlots", + "description": "The tooltip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The informational text or elements displayed within the tooltip overlay, providing helpful context or explanations when users interact with the associated element.\n\nOnly accepts text, paragraph components, and raw `textContent`.", + "isOptional": true + } + ], + "value": "export interface TooltipSlots {\n /**\n * The informational text or elements displayed within the tooltip overlay, providing helpful context or explanations when users interact with the associated element.\n *\n * Only accepts text, paragraph components, and raw `textContent`.\n */\n children?: HTMLElement;\n}" + } + }, + "URLFieldEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "URLFieldEvents", + "description": "The URL field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the URL field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the URL field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the URL field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener<'input'>", + "description": "A callback fired when the user inputs data into the URL field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface URLFieldEvents {\n /**\n * A callback fired when the URL field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change: CallbackEventListener<'input'>;\n /**\n * A callback fired when the user inputs data into the URL field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input: CallbackEventListener<'input'>;\n /**\n * A callback fired when the URL field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur: CallbackEventListener<'input'>;\n /**\n * A callback fired when the URL field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus: CallbackEventListener<'input'>;\n}" + } + }, + "UnorderedListSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "UnorderedListSlots", + "description": "The unordered list component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLElement", + "description": "The list entries displayed within the unordered list, where each item is marked with a bullet point. Only accepts list item components as children. Each list item represents a single bulleted entry in the list.", + "isOptional": true + } + ], + "value": "export interface UnorderedListSlots {\n /**\n * The list entries displayed within the unordered list, where each item is marked with a bullet point. Only accepts list item components as children. Each list item represents a single bulleted entry in the list.\n */\n children?: HTMLElement;\n}" + } + }, + "AdminActionSlots": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "AdminActionSlots", + "description": "The admin action component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action button or link displayed in the admin action modal. This represents the primary or most important action that users can take in this modal context, typically displayed with high visual prominence." + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Additional action buttons or links displayed in the admin action modal. These provide alternative or supporting actions, visually de-emphasized compared to the primary action to establish clear hierarchy." + } + ], + "value": "export interface AdminActionSlots {\n /**\n * The main action button or link displayed in the admin action modal.\n * This represents the primary or most important action that users can take in this modal context, typically displayed with high visual prominence.\n */\n 'primary-action': HTMLElement;\n /**\n * Additional action buttons or links displayed in the admin action modal.\n * These provide alternative or supporting actions, visually de-emphasized compared to the primary action to establish clear hierarchy.\n */\n 'secondary-actions': HTMLElement;\n}" + } + }, + "FormEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FormEvents", + "description": "The form component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "reset", + "value": "CallbackEventListener | null", + "description": "A callback that is run when the form is reset.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "CallbackExtendableEventListener | null", + "description": "A callback that is run when the form is submitted.", + "isOptional": true + } + ], + "value": "export interface FormEvents {\n /**\n * A callback that is run when the form is submitted.\n */\n submit: CallbackExtendableEventListener | null = null;\n /**\n * A callback that is run when the form is reset.\n */\n reset: CallbackEventListener | null = null;\n}" + } + }, + "FunctionSettingsEvents": { + "src/surfaces/admin/components.ts": { + "filePath": "src/surfaces/admin/components.ts", + "name": "FunctionSettingsEvents", + "description": "The function settings component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "CallbackErrorEventListener<\n typeof tagName,\n FunctionSettingsErrorEvent['error']['errors'][0]\n > | null", + "description": "An optional callback function that will be run by the admin when committing the changes to Shopify’s servers fails. The error event you receive includes an `error` property that is an `AggregateError` object. This object includes an array of errors that were caused by data your extension provided. Network errors and user errors that are out of your control will not be reported here.\n\nIn the `onError` callback, you should update your extension’s UI to highlight the fields that caused the errors, and display the error messages to the user.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "reset", + "value": "CallbackEventListener | null", + "description": "A callback that is run when the function settings form is reset.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components.ts", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "CallbackExtendableEventListener | null", + "description": "An optional callback function that will be run by the admin when the user commits their changes in the admin-rendered part of the function settings experience. If `event.waitUntil` is called with a promise, the admin will wait for the promise to resolve before committing any changes to Shopify’s servers. If the promise rejects, the admin will abort the changes and display an error, using the `message` property of the error you reject with.", + "isOptional": true + } + ], + "value": "export interface FunctionSettingsEvents {\n /**\n * An optional callback function that will be run by the admin when the user\n * commits their changes in the admin-rendered part of the function settings\n * experience. If `event.waitUntil` is called with a promise, the admin will wait for the\n * promise to resolve before committing any changes to Shopify’s servers. If\n * the promise rejects, the admin will abort the changes and display an error,\n * using the `message` property of the error you reject with.\n */\n submit: CallbackExtendableEventListener | null = null;\n /**\n * An optional callback function that will be run by the admin when\n * committing the changes to Shopify’s servers fails. The error event you receive includes\n * an `error` property that is an `AggregateError` object. This object includes\n * an array of errors that were caused by data your extension provided.\n * Network errors and user errors that are out of your control will not be reported here.\n *\n * In the `onError` callback, you should update your extension’s UI to\n * highlight the fields that caused the errors, and display the error messages\n * to the user.\n */\n error: CallbackErrorEventListener<\n typeof tagName,\n FunctionSettingsErrorEvent['error']['errors'][0]\n > | null = null;\n /**\n * A callback that is run when the function settings form is reset.\n */\n reset: CallbackEventListener | null = null;\n}" + } + }, + "AppNavAttributes": { + "src/surfaces/admin/components/AppNav/AppNavTypes.ts": { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "name": "AppNavAttributes", + "description": "Configure the following properties on the app nav component.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "ComponentChildren", + "description": "The navigation items to inject into the Shopify admin sidebar. Provide `` children where each link represents a navigation item. This component does not render any visible UI itself.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element.", + "isOptional": true + } + ], + "value": "export interface AppNavAttributes {\n /**\n * A unique identifier for the element.\n */\n id?: string;\n /**\n * The navigation items to inject into the Shopify admin sidebar.\n * Provide `` children where each link represents a navigation item.\n * This component does not render any visible UI itself.\n */\n children?: ComponentChildren;\n}" + } + }, + "AppNavLinkAttributes": { + "src/surfaces/admin/components/AppNav/AppNavTypes.ts": { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "name": "AppNavLinkAttributes", + "description": "Attributes for link elements used as children of app nav. Each link defines a navigation destination in your app's menu.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "string", + "description": "The visible label text for the navigation item. Keep labels short (1-2 words) and use nouns that describe the destination (such as \"Products\", \"Settings\", or \"Reports\"). Avoid verbs like \"Manage\" or \"View\" to maintain consistency with Shopify admin navigation patterns.", + "isOptional": true + }, + { + "filePath": "src/surfaces/admin/components/AppNav/AppNavTypes.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL path for the navigation item. Must be a relative path within your app, such as `/products` or `/settings`. When clicked, it navigates the app to this route without a full page reload. The path should match a route defined in your app's routing configuration." + } + ], + "value": "export interface AppNavLinkAttributes {\n /**\n * The URL path for the navigation item. Must be a relative path within your app, such as `/products` or `/settings`. When clicked, it navigates the app to this route without a full page reload. The path should match a route defined in your app's routing configuration.\n */\n href: string;\n /**\n * The visible label text for the navigation item. Keep labels short (1-2 words) and use nouns that describe the destination (such as \"Products\", \"Settings\", or \"Reports\"). Avoid verbs like \"Manage\" or \"View\" to maintain consistency with Shopify admin navigation patterns.\n */\n children?: string;\n}" + } + } +} diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/admin-extensions.ext.doc.ts b/packages/ui-extensions/docs/surfaces/admin/staticPages/admin-extensions.ext.doc.ts deleted file mode 100644 index 4fb951c435..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/admin-extensions.ext.doc.ts +++ /dev/null @@ -1,241 +0,0 @@ -import {LandingTemplateSchema} from '@shopify/generate-docs'; - -const data: LandingTemplateSchema = { - title: 'Admin UI extensions', - description: - 'Admin UI extensions make it possible to surface contextual app functionality within the Shopify Admin interface.', - image: '/assets/landing-pages/templated-apis/hero.png', - darkImage: '/assets/landing-pages/templated-apis/hero-dark.png', - tabletImage: '/assets/landing-pages/templated-apis/hero.png', - tabletDarkImage: '/assets/landing-pages/templated-apis/hero-dark.png', - mobileImage: '/assets/landing-pages/templated-apis/hero.png', - mobileDarkImage: '/assets/landing-pages/templated-apis/hero-dark.png', - id: 'admin-extensions', - sections: [ - { - type: 'Generic', - anchorLink: 'overview', - title: 'Overview', - image: 'action-extension-example.gif', - sectionContent: 'Extend the Shopify Admin with UI Extensions.', - sectionCard: [ - { - name: 'Get started building your first admin extension', - subtitle: 'Tutorial', - url: '/docs/apps/admin/admin-actions-and-blocks/build-an-admin-action', - type: 'tutorial', - }, - { - subtitle: 'Component APIs', - name: 'See all available components', - url: '/docs/api/admin-extensions/components', - type: 'blocks', - }, - { - subtitle: 'Reference', - name: 'View a list of available extension targets', - url: '/docs/api/admin-extensions/2025-10-rc/extension-targets', - type: 'app', - }, - { - subtitle: 'Network Features', - name: 'Learn about the network features available to admin extensions', - url: '/docs/api/admin-extensions/2025-10-rc/network-features', - type: 'globe', - }, - { - subtitle: 'Using Forms', - name: 'Use the Form component to integrate with the contextual save bar of the resource page', - url: '#using-forms', - type: 'tool', - }, - { - subtitle: 'Picking resources', - name: 'Prompt the user to select resources', - url: '#picking-resources', - type: 'tool', - }, - { - subtitle: 'Figma kit', - name: 'Use the Figma kit to design your extension', - url: 'https://www.figma.com/community/file/1554895871000783188/polaris-ui-kit-community', - type: 'tool', - }, - ], - }, - { - type: 'Generic', - anchorLink: 'getting-started', - sectionContent: - 'Use the [Shopify CLI](/docs/api/shopify-cli) to [generate a new extension](https://shopify.dev/apps/tools/cli/commands#generate-extension) within your app.\n\n' + - 'If you already have a Shopify app, you can skip right to the last command shown here.\n\n' + - 'Make sure you’re using Shopify CLI `v3.85.3` or higher. You can check your version by running `shopify version`.', - title: 'Getting Started', - codeblock: { - title: 'Generate an extension', - tabs: [ - { - code: './examples/getting-started.sh', - language: 'bash', - title: 'CLI', - }, - ], - }, - }, - { - type: 'Generic', - anchorLink: 'eslint-configuration', - title: 'Optional ESLint configuration', - sectionContent: ` -If your app is using ESLint, update your configuration to include the new global \`shopify\` object. - `, - codeblock: { - title: '.eslintrc.cjs', - tabs: [ - { - code: './examples/eslint-configuration.example.ts', - language: 'js', - }, - ], - }, - initialLanguage: 'js', - }, - { - type: 'Generic', - title: 'Scaffolded with Preact', - sectionContent: `UI Extensions are scaffolded with [Preact](https://preactjs.com/) by default. - \nThis means that you can use Preact patterns and principles within your extension. Since Preact is included as a standard dependency, you have access to all of its features including [hooks](https://preactjs.com/guide/v10/hooks/) like \`useState\` and \`useEffect\` for managing component state and side effects. - \nYou can also use [Preact Signals](https://preactjs.com/guide/v10/signals) for reactive state management, and take advantage of standard web APIs just like you would in a regular Preact application.`, - anchorLink: 'scaffolded-with-preact', - codeblock: { - title: 'Scaffolded with Preact', - tabs: [ - { - code: './examples/scaffolded-with-preact.jsx', - language: 'jsx', - title: 'JSX', - }, - ], - }, - }, - { - type: 'Generic', - title: 'Handling events', - sectionContent: `Handling events in UI extensions are the same as you would handle them in a web app. You can use the \`addEventListener\` method to listen for events on the components or use the \`on[event]\` property to listen for events from the components. - \n\nWhen using Preact, event handlers can be registered by passing props beginning with \`on\`, and the event handler name is case-insensitive. For example, the JSX \`\` registers \`fn\` as a "click" event listener on the button.`, - anchorLink: 'handling-events', - codeblock: { - title: 'Handling events', - tabs: [ - { - code: './examples/handling-events.jsx', - language: 'jsx', - title: 'JSX', - }, - ], - }, - }, - { - type: 'Generic', - title: 'Using Forms', - sectionContent: `When building a Block extension you may use the [Form component](https://shopify.dev/docs/api/admin-extensions/latest/components/forms/form) to integrate with the contextual save bar of the resource page. The Form component provides a way to manage form state and submit data to your app's backend or directly to Shopify using Direct API access.\n\nWhenever an input field is changed, the Form component will automatically update the dirty state of the resource page. When the form is submitted or reset the relevant callback in the form component will get triggered.\n\nUsing this, you can control what defines a component to be dirty by utilizing the Input's defaultValue property.\n\nRules:\n\n- When the defaultValue is set, the component will be considered dirty if the value of the input is different from the defaultValue.You may update the defaultValue when the form is submitted to reset the dirty state of the form.\n\n- When the defaultValue is not set, the component will be considered dirty if the value of the input is different from the initial value or from the last dynamic update to the input's value that wasn't triggered by user input. - - Note: In order to trigger the dirty state, each input must have a name attribute. - `, - anchorLink: 'using-forms', - codeblock: { - title: "Trigger the Form's dirty state", - tabs: [ - { - code: './examples/form-default-value.jsx', - language: 'tsx', - title: 'Using `defaultValue`', - }, - { - code: './examples/form-implicit-default.jsx', - language: 'tsx', - title: 'Using implicit default', - }, - ], - }, - }, - { - type: 'GenericAccordion', - title: 'Picking Resources', - sectionContent: - "Use the Resource Picker and Picker API's to allow users to select resources for your extension to use.", - anchorLink: 'picking-resources', - accordionContent: [ - { - title: 'Resource Picker', - description: - 'Use the `resourcePicker` API to display a search-based interface to help users find and select one or more products, collections, or product variants, and then return the selected resources to your extension. Both the app and the user must have the necessary permissions to access the resources selected.', - image: 'resource-picker.png', - codeblock: { - title: 'resourcePicker', - tabs: [ - { - title: 'Selecting a product', - language: 'tsx', - code: './examples/resource-picker-product.jsx', - }, - ], - }, - }, - { - title: 'Picker', - description: - 'Use the `picker` API to display a search-based interface to help users find and select one or more custom data types that you provide, such as product reviews, email templates, or subscription options.', - image: 'picker.png', - codeblock: { - title: 'picker', - tabs: [ - { - title: 'Selecting an email template', - language: 'tsx', - code: './examples/picker-email-template.jsx', - }, - ], - }, - }, - ], - }, - { - type: 'Generic', - anchorLink: 'limitations', - title: 'Limitations', - sectionContent: ` -As of \`2025-10\`, UI extensions have the following limitations: -- **File size limit**: Extensions are limited to a maximum of 64 KB when deployed. This limit helps ensure fast loading times and optimal performance. -`, - sectionNotice: [ - { - title: 'Note', - sectionContent: ` -The 64 KB limit applies to the compiled extension bundle size upon deployment. -`, - type: 'info', - }, - ], - }, - { - type: 'Generic', - title: 'Deploying', - anchorLink: 'deploying', - sectionContent: - 'Use the Shopify CLI to [deploy your app and its extensions](https://shopify.dev/docs/apps/deployment/extension).', - codeblock: { - title: 'Deploy an extension', - tabs: [ - { - code: './examples/deploy.sh', - language: 'bash', - title: 'CLI', - }, - ], - }, - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/authenticated-fetch.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/authenticated-fetch.jsx deleted file mode 100644 index ccb82bbc77..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/authenticated-fetch.jsx +++ /dev/null @@ -1,29 +0,0 @@ -import {render} from 'preact'; -import {useEffect, useState} from 'preact/hooks'; - -export default async () => { - render(, document.body); -} - -// Get product info from app backend -async function getProductInfo(id) { - const res = await fetch(`/api/products/${id}`); - return res.json(); -} - -function Extension() { - // Contextual "input" data passed to this extension: - const {data} = shopify; - const productId = data.selected?.[0]?.id; - - const [productInfo, setProductInfo] = useState(); - useEffect(() => { - getProductInfo(productId).then(setProductInfo); - }, [productId]); - - return ( - - Info: {productInfo?.title} - - ); -} diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/custom-authenticated-fetch.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/custom-authenticated-fetch.jsx deleted file mode 100644 index 49af95a108..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/custom-authenticated-fetch.jsx +++ /dev/null @@ -1,34 +0,0 @@ -import {render} from 'preact'; -import {useEffect, useState} from 'preact/hooks'; - -export default async () => { - render(, document.body); -} - -// Get product info from a different app backend -async function getProductInfo(id, auth) { - const token = await auth.idToken(); - const res = await fetch(`https://app.example.com/api/products/${id}`, { - headers: { - Authorization: `Bearer ${token}`, - }, - }); - return res.json(); -} - -function Extension() { - // Contextual "input" data passed to this extension: - const {data, auth} = shopify; - const productId = data.selected?.[0]?.id; - - const [productInfo, setProductInfo] = useState(); - useEffect(() => { - getProductInfo(productId, auth).then(setProductInfo); - }, [productId, auth]); - - return ( - - Info: {productInfo?.title} - - ); -} diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/deploy.sh b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/deploy.sh deleted file mode 100644 index 00ed824fc2..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/deploy.sh +++ /dev/null @@ -1,7 +0,0 @@ -# navigate to your app's root directory: -cd my-app - -# deploy your app and its extensions: -shopify app deploy - -# follow the steps to deploy diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/direct-api-fetch.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/direct-api-fetch.jsx deleted file mode 100644 index 0b3e8dba35..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/direct-api-fetch.jsx +++ /dev/null @@ -1,33 +0,0 @@ -import {render} from 'preact'; - -export default async () => { - const productId = shopify.data.selected?.[0]?.id; - const product = await getProduct(productId); - render(, document.body); -}; - -async function getProduct(id) { - const res = await fetch('shopify:admin/api/graphql.json', { - method: 'POST', - body: JSON.stringify({ - query: ` - query GetProduct($id: ID!) { - product(id: $id) { - title - } - } - `, - variables: {id}, - }), - }); - const {data} = await res.json(); - return data.product; -} - -function Extension({product}) { - return ( - - The selected product title is {product.title} - - ); -} diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/direct-api-query.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/direct-api-query.jsx deleted file mode 100644 index 56fb2d8ea7..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/direct-api-query.jsx +++ /dev/null @@ -1,26 +0,0 @@ -import {render} from 'preact'; - -export default async () => { - const productId = shopify.data.selected?.[0]?.id; - const { - data: {product}, - } = await shopify.query( - ` - query GetProduct($id: ID!) { - product(id: $id) { - title - } - } - `, - {variables: {id: productId}}, - ); - render(, document.body); -}; - -function Extension({product}) { - return ( - - The selected product title is {product.title} - - ); -} diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/eslint-configuration.example.ts b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/eslint-configuration.example.ts deleted file mode 100644 index 91db1dfc87..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/eslint-configuration.example.ts +++ /dev/null @@ -1,5 +0,0 @@ -module.exports = { - globals: { - shopify: 'readonly', - }, -}; diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/fetch-data.js b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/fetch-data.js deleted file mode 100644 index a8c0573950..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/fetch-data.js +++ /dev/null @@ -1,4 +0,0 @@ -fetch('shopify:admin/api/graphql.json', { - method: 'POST', - body: JSON.stringify(simpleProductQuery), -}); diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/form-default-value.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/form-default-value.jsx deleted file mode 100644 index e0b72a4667..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/form-default-value.jsx +++ /dev/null @@ -1,36 +0,0 @@ -const defaultValues = { - text: 'default value', - number: 50, -}; - -const [textValue, setTextValue] = useState(''); -const [numberValue, setNumberValue] = useState(''); - -return ( - - { - event.waitUntil(fetch('app:save/data')); - console.log('submit', {textValue, numberValue}); - }} - onReset={() => console.log('automatically reset values')} - > - - setTextValue(e.currentTarget.value)} - /> - setNumberValue(e.currentTarget.value)} - /> - - - -); diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/form-implicit-default.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/form-implicit-default.jsx deleted file mode 100644 index e1e0eaf4cb..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/form-implicit-default.jsx +++ /dev/null @@ -1,45 +0,0 @@ -import { render } from 'preact'; -import { useState } from 'preact/hooks'; - -export default async () => { - render(, document.body); -} - -async function Extension() { - const data = await fetch('/data.json'); - const {text, number} = await data.json(); - return ; -} - -function App({text, number}) { - // The initial values set in the form fields will be the default values - const [textValue, setTextValue] = useState(text); - const [numberValue, setNumberValue] = useState(number); - - return ( - - { - event.waitUntil(fetch('app:data/save')); - console.log('submit', {textValue, numberValue}); - } - onReset={() => console.log('automatically reset values')} - > - - setTextValue(e.currentTarget.value)} - /> - setNumberValue(e.currentTarget.value)} - /> - - - - ); -} diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/getting-started.sh b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/getting-started.sh deleted file mode 100644 index 0b116feebb..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/getting-started.sh +++ /dev/null @@ -1,10 +0,0 @@ -# create an app if you don't already have one: -shopify app init --name my-app - -# navigate to your app's root directory: -cd my-app - -# generate a new extension: -shopify app generate extension -# follow the steps to create a new -# extension in ./extensions. diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/handling-events.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/handling-events.jsx deleted file mode 100644 index 660f60ebb3..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/handling-events.jsx +++ /dev/null @@ -1,20 +0,0 @@ -export default function HandlingEvents() { - const handleClick = () => { - console.log('s-button clicked'); - }; - - return Click me; -} - -// or - -export default function HandlingEvents() { - const handleClick = () => { - console.log('s-button clicked'); - }; - - const button = document.createElement('s-button'); - button.addEventListener('click', handleClick); - document.body.appendChild(button); -} - diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-action.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-action.jsx deleted file mode 100644 index 25811a412c..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-action.jsx +++ /dev/null @@ -1 +0,0 @@ -; diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-product-page.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-product-page.jsx deleted file mode 100644 index 2fbbf2f2f2..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-product-page.jsx +++ /dev/null @@ -1 +0,0 @@ -Link to Product Page; diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-route.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-route.jsx deleted file mode 100644 index 93bb2c40a0..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-route.jsx +++ /dev/null @@ -1 +0,0 @@ -; diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-settings.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-settings.jsx deleted file mode 100644 index 1f803fd5dc..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/link-to-settings.jsx +++ /dev/null @@ -1 +0,0 @@ -; diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/picker-email-template.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/picker-email-template.jsx deleted file mode 100644 index 1f59f2e7b8..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/picker-email-template.jsx +++ /dev/null @@ -1,50 +0,0 @@ -import { render } from 'preact'; - -export default async () => { - render(, document.body); -} - -function Extension() { - const handleSelectEmailTemplate = async () => { - const pickerInstance = await shopify.picker({ - heading: 'Select a template', - multiple: false, - headers: [ - { content: 'Templates' }, - { content: 'Created by' }, - { content: 'Times used', type: 'number' }, - ], - items: [ - { - id: '1', - heading: 'Full width, 1 column', - data: ['Karine Ruby', '0'], - badges: [{ content: 'Draft', tone: 'info' }, { content: 'Marketing' }], - }, - { - id: '2', - heading: 'Large graphic, 3 column', - data: ['Charlie Mitchell', '5'], - badges: [ - { content: 'Published', tone: 'success' }, - { content: 'New feature' }, - ], - selected: true, - }, - { - id: '3', - heading: 'Promo header, 2 column', - data: ['Russell Winfield', '10'], - badges: [{ content: 'Published', tone: 'success' }], - }, - ], - }); - - const selected = await pickerInstance.selected; - console.log(selected); - }; - - return ( - Select email template - ); -} diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/resource-picker-product.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/resource-picker-product.jsx deleted file mode 100644 index ff1512c3be..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/resource-picker-product.jsx +++ /dev/null @@ -1,15 +0,0 @@ -import { render } from 'preact'; - -export default async () => { - render(, document.body); -} - - -function Extension() { - const handleSelectProduct = async () => { - const selected = await shopify.resourcePicker({ type: 'product' }); - console.log(selected); - }; - - return Select product; -} diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/scaffolded-with-preact.jsx b/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/scaffolded-with-preact.jsx deleted file mode 100644 index 59af0d99af..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/examples/scaffolded-with-preact.jsx +++ /dev/null @@ -1,20 +0,0 @@ -import '@shopify/ui-extensions/preact'; -import {render} from 'preact'; -import {useState} from 'preact/hooks'; - -export default async () => { - render(, document.body); -} - -function Extension() { - const [count, setCount] = useState(0); - - return ( - <> - Count: {count} - setCount(count + 1)}> - Increment - - - ); -} diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/network-features.ext.doc.ts b/packages/ui-extensions/docs/surfaces/admin/staticPages/network-features.ext.doc.ts deleted file mode 100644 index 0b1e1160c9..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/network-features.ext.doc.ts +++ /dev/null @@ -1,184 +0,0 @@ -import {LandingTemplateSchema} from '@shopify/generate-docs'; - -const data: LandingTemplateSchema = { - title: 'Network Features', - description: - 'Admin UI extensions make it possible to surface contextual app functionality within the Shopify Admin interface.', - image: '/assets/landing-pages/templated-apis/hero.png', - darkImage: '/assets/landing-pages/templated-apis/hero-dark.png', - tabletImage: '/assets/landing-pages/templated-apis/hero.png', - tabletDarkImage: '/assets/landing-pages/templated-apis/hero-dark.png', - mobileImage: '/assets/landing-pages/templated-apis/hero.png', - mobileDarkImage: '/assets/landing-pages/templated-apis/hero-dark.png', - id: 'network-features', - sections: [ - { - type: 'Generic', - anchorLink: 'overview', - title: 'Overview', - image: 'action-extension-example.gif', - sectionContent: 'Extend the Shopify Admin with UI Extensions.', - sectionCard: [ - { - subtitle: 'App authentication', - name: "Make authenticated requests to your app's backend", - url: '#app-authentication', - type: 'tool', - }, - { - subtitle: 'Direct API access', - name: 'Access the Shopify GraphQL API directly', - url: '#direct-api-access', - type: 'tool', - }, - { - subtitle: 'Custom protocols', - name: 'Easily construct URLs to navigate to common locations', - url: '#custom-protocols', - type: 'gear', - }, - ], - }, - { - type: 'Generic', - title: 'App Authentication', - sectionContent: - "Admin UI extensions can also make authenticated calls to your app's backend. When you use `fetch()` to make a request to your app's configured auth domain or any of its subdomains, an `Authorization` header is automatically added with a Shopify [OpenID Connect ID Token](https://shopify.dev/docs/api/app-home/apis/id-token). There's no need to manually manage ID tokens.\n\nRelative URLs passed to `fetch()` are resolved against your app's `app_url`. This means if your app's backend is on the same domain as your `app_url`, you can make requests to it using `fetch('/path')`.\n\nIf you need to make requests to a different domain, you can use the [`auth.idToken()` method](/docs/api/admin-extensions/api/standard-api#standardapi-propertydetail-auth) to retrieve the ID token and manually add it to your request headers.", - anchorLink: 'app-authentication', - codeblock: { - title: "Make requests to your app's backend", - tabs: [ - { - code: './examples/authenticated-fetch.jsx', - language: 'tsx', - title: 'Get Product Data', - }, - { - code: './examples/custom-authenticated-fetch.jsx', - language: 'tsx', - title: 'Get Data from a different domain', - }, - ], - }, - }, - { - type: 'Generic', - title: 'Direct API access', - sectionContent: - "You can make Shopify Admin API requests directly from your extension using the [query API](/docs/api/admin-extensions/api/standard-api#standardapi-propertydetail-query) or the standard [web fetch API](https://developer.mozilla.org/en-US/docs/Web/API/fetch)!\n\nAny `fetch()` calls from your extension to Shopify's Admin GraphQL API are automatically authenticated by default. These calls are fast too, because Shopify handles requests directly.\n\nDirect API requests use [online access](https://shopify.dev/docs/apps/build/authentication-authorization/access-token-types/online-access-tokens) mode by default. If you want to use [offline access](https://shopify.dev/docs/apps/build/authentication-authorization/access-token-types/offline-access-tokens) mode, you can set the `direct_api_mode` property to `offline` in your [app TOML file](/docs/apps/tools/cli/configuration#admin).\n\nNote: Direct API can't be used to manage storefront access tokens.", - anchorLink: 'direct-api-access', - codeblock: { - title: 'Query Shopify data', - tabs: [ - { - code: './examples/direct-api-fetch.jsx', - language: 'tsx', - title: 'Fetch Product data', - }, - { - code: './examples/direct-api-query.jsx', - language: 'tsx', - title: 'Query Product data', - }, - ], - }, - sectionCard: [ - { - name: "Direct API can't be used to manage storefront access tokens.", - subtitle: 'Note', - url: '/docs/api/admin-extensions#direct-api-access', - type: 'information', - }, - { - name: 'Learn more about access scopes', - subtitle: 'Developer guide', - url: '/docs/api/usage/access-scopes', - type: 'information', - }, - ], - }, - { - type: 'GenericAccordion', - title: 'Custom Protocols', - sectionContent: - 'Custom protocols make it easier to navigate to common locations, and construct URLs.', - anchorLink: 'custom-protocols', - accordionContent: [ - { - title: 'Shopify Protocol', - description: - 'Use the `shopify:admin` protocol when you want to construct a URL with a root of the Shopify Admin.', - codeblock: { - title: 'shopify:admin', - tabs: [ - { - title: 'Link to Product Page', - language: 'tsx', - code: './examples/link-to-product-page.jsx', - }, - { - title: 'Fetch data', - language: 'ts', - code: './examples/fetch-data.js', - }, - ], - }, - }, - { - title: 'App Protocol', - description: - 'Use the `app:` protocol to construct a URL for your app. Shopify will handle constructing the base URL for your app. This works for both embedded and non-embedded apps.', - codeblock: { - title: 'app:', - tabs: [ - { - title: 'Link to Settings', - language: 'tsx', - code: './examples/link-to-settings.jsx', - }, - ], - }, - }, - { - title: 'Extension Protocol', - description: - 'Triggers an action extension from a block extension using the `extension:` protocol. The `extensionTarget` is the target of the action extension. The handle is the handle of the action extension that will be opened.', - codeblock: { - title: 'extension:', - tabs: [ - { - title: 'Trigger Action Extension from a Block extension', - language: 'tsx', - code: './examples/link-to-action.jsx', - }, - ], - }, - }, - { - title: 'Relative Urls', - description: - 'Relative urls are relative to your app and are useful when you want to link to a route within your app. This works for both embedded and non-embedded apps.', - codeblock: { - title: '/relative/urls', - tabs: [ - { - title: 'Link to route in your app', - language: 'tsx', - code: './examples/link-to-route.jsx', - }, - ], - }, - }, - ], - }, - { - type: 'Generic', - title: 'Security', - anchorLink: 'security', - sectionContent: - 'UI Extensions run on a different origin than the Shopify Admin. For network calls to succeed, your server must support [cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) for the origin `https://extensions.shopifycdn.com`.\n\nIf you have a custom [`Access-Control-Allow-Origin` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) set, you must include `https://extensions.shopifycdn.com` in the list of allowed origins.\n\nIf you are using the [Shopify App Remix Template](https://github.com/Shopify/shopify-app-template-remix), this is done automatically for you.', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/admin/staticPages/targets-overview.ext.doc.ts b/packages/ui-extensions/docs/surfaces/admin/staticPages/targets-overview.ext.doc.ts deleted file mode 100644 index 7240a0c4cd..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/staticPages/targets-overview.ext.doc.ts +++ /dev/null @@ -1,378 +0,0 @@ -import type {LandingTemplateSchema} from '@shopify/generate-docs'; - -const data: LandingTemplateSchema = { - title: 'Targets Overview', - description: ` -A [target](/docs/apps/app-extensions/configuration#targets) represents where your admin UI extension will appear. - -You register targets in your \`shopify.extension.toml\` and inside the Javascript file denoted by your toml's \`module\` property. - `, - // The id for the page that is used for routing. If this documentation is for a primary landing page, confirm id matches the reference name. - id: 'extension-targets', - // Basic content for the page and Hero section. - sections: [ - { - type: 'GenericAccordion', - title: 'Admin action locations', - anchorLink: 'action-locations', - sectionContent: - 'Admin action extensions appear on resource pages throughout the admin. Learn more about [admin actions](/docs/apps/admin/admin-actions-and-blocks#admin-actions).', - accordionContent: [ - { - title: 'Abandoned checkout details', - description: - 'This page shows information about a single abandoned checkout. The `admin.abandoned-checkout-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.abandoned-checkout-details.action.render.png', - }, - { - title: 'Catalog details', - description: - 'This page shows information about a single catalog. The `admin.catalog-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.catalog-details.action.render.png', - }, - { - title: 'Collection details', - description: - 'This page shows information about a single collection. The `admin.collection-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.collection-details.action.render.png', - }, - { - title: 'Collection index', - description: - 'This page shows a table of multiple collections. The `admin.collection-index.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.collection-index.action.render.png', - }, - { - title: 'Company details', - description: - 'This page shows information about a single company. The `admin.company-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.company-details.action.render.png', - }, - { - title: 'Customer details', - description: - 'This page shows information about a single customer. The `admin.customer-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.customer-details.action.render.png', - }, - { - title: 'Customer index', - description: - 'This page shows a table of multiple customers. The `admin.customer-index.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.customer-index.action.render.png', - }, - { - title: 'Customer index selection', - description: - 'This page shows a table of multiple customers. The `admin.customer-index.selection-action.render` target is available on this page when multiple customers are selected.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.customer-index.selection-action.render', - }, - { - title: 'Customer segment details', - description: - 'This page shows information about a single customer segment. The `admin.customer-segment-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.customer-segment-details.action.render.png', - }, - { - title: 'Discount details', - description: - 'This page shows information about a single discount. The `admin.discount-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.discount-details.action.render.png', - }, - { - title: 'Discount index', - description: - 'This page shows a table of multiple discounts. The `admin.discount-index.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.discount-index.action.render.png', - }, - { - title: 'Draft order details', - description: - 'This page shows information about a single draft order. The `admin.draft-order-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.draft-order-details.action.render.png', - }, - { - title: 'Draft order index', - description: - 'This page shows a table of multiple draft orders. The `admin.draft-order-index.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.draft-order-index.action.render.png', - }, - { - title: 'Draft order index selection', - description: - 'This page shows a table of multiple draft orders. The `admin.draft-order-index.selection-action.render` target is available on this page when multiple draft orders are selected.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.draft-order-index.selection-action.render.png', - }, - { - title: 'Gift card details', - description: - 'This page shows information about a single gift card. The `admin.gift-card-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.gift-card-details.action.render.png', - }, - { - title: 'Order details', - description: - 'This page shows information about a single order. The `admin.order-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.order-details.action.render.png', - }, - { - title: 'Order details fulfilled card', - description: - 'This page shows information about a single order, including a card showing the fulfillment details. The `admin.order-fulfilled-card.action.render` target is available on this page, but only if your app is selected as the fulfillment app for that order.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.order-fulfilled-card.action.render.png', - }, - { - title: 'Order index', - description: - 'This page shows a table of multiple orders. The `admin.order-index.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.order-index.action.render.png', - }, - { - title: 'Order index selection', - description: - 'This page shows a table of multiple orders. The `admin.order-index.selection-action.render` target is available on this page when multiple orders are selected.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.order-index.selection-action.render.png', - }, - { - title: 'Product details', - description: - 'This page shows information about a single product. The `admin.product-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-details.action.render.png', - }, - { - title: 'Product index', - description: - 'This page shows a table of multiple products. The `admin.product-index.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-index.action.render.png', - }, - { - title: 'Product index selection', - description: - 'This page shows a table of multiple products. The `admin.product-index.selection-action.render` target is available on this page when multiple products are selected.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-index.selection-action.render.png', - }, - { - title: 'Product variant details', - description: - 'This page shows information about a single product variant. The `admin.product-variant-details.action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-variant-details.action.render.png', - }, - { - title: 'Product detail purchase options card', - description: - 'This page shows information about a single product, including a card showing purchase options. The `admin.product-purchase-option.action.render` target is available on this page when selling plans exists.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-purchase-option.action.render.png', - }, - { - title: 'Product variant detail purchase options card', - description: - 'This page shows information about a single product variant, including a card showing purchase options. The `admin.product-variant-purchase-option.action.render` target is available on this page when selling plans exists.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-variant-purchase-option.action.render.png', - }, - ], - }, - { - type: 'GenericAccordion', - title: 'Admin block locations', - anchorLink: 'block-locations', - sectionContent: - 'Admin block extensions appear on resource detail pages throughout the admin. Learn more about [admin blocks](/docs/apps/admin/admin-actions-and-blocks#admin-blocks).', - accordionContent: [ - { - title: 'Abandoned checkout details', - description: - 'This page shows information about a single abandoned checkout. The `admin.abandoned-checkout-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.abandoned-checkout-details.block.render.png', - }, - { - title: 'Catalog details', - description: - 'This page shows information about a single catalog. The `admin.catalog-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.catalog-details.block.render.png', - }, - { - title: 'Collection details', - description: - 'This page shows information about a single collection. The `admin.collection-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.collection-details.block.render.png', - }, - { - title: 'Company details', - description: - 'This page shows information about a single company. The `admin.company-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.company-details.block.render.png', - }, - { - title: 'Company location details', - description: - 'This page shows information about a location for a company. The `admin.company-location-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.company-location-details.block.render.png', - }, - { - title: 'Customer details', - description: - 'This page shows information about a single customer. The `admin.customer-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.customer-details.block.render.png', - }, - { - title: 'Draft order details', - description: - 'This page shows information about a single draft order. The `admin.draft-order-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.draft-order-details.block.render.png', - }, - { - title: 'Gift card details', - description: - 'This page shows information about a single gift card. The `admin.gift-card-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.gift-card-details.block.render.png', - }, - { - title: 'Discount details function settings', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.discount-details.function-settings-render.png', - description: - 'This page shows information about a single discount. The `admin.discount-details.function-settings.render` target is available on this page.', - }, - { - title: 'Order details', - description: - 'This page shows information about a single order. The `admin.order-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.order-details.block.render.png', - }, - { - title: 'Product details', - description: - 'This page shows information about a single product. The `admin.product-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-details.block.render.png', - }, - { - title: 'Product variant details', - description: - 'This page shows information about a single product variant. The `admin.product-variant-details.block.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-variant-details.block.render.png', - }, - ], - }, - { - type: 'GenericAccordion', - title: 'Admin print action locations', - anchorLink: 'print-locations', - sectionContent: - 'Admin print action extensions appear on order and product pages in the admin.', - accordionContent: [ - { - title: 'Order details', - description: - 'This page shows information about a single order. The `admin.order-details.print-action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.order-details.print-action.render.png', - }, - { - title: 'Product details', - description: - 'This page shows information about a single product. The `admin.product-details.print-action.render` target is available on this page.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-details.print-action.render.png', - }, - { - title: 'Order index selection', - description: - 'This page shows a table of multiple orders. The `admin.order-index.selection-print-action.render` target is available on this page when multiple orders are selected.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.order-index.selection-print-action.render.png', - }, - { - title: 'Product index selection', - description: - 'This page shows a table of multiple products. The `admin.product-index.selection-print-action.render` target is available on this page when multiple products are selected.', - image: - '/assets/templated-apis-screenshots/admin/targets/admin.product-index.selection-print-action.render.png', - }, - ], - }, - { - type: 'Markdown', - title: 'Customer segmentation locations', - anchorLink: 'customer-segmentation-locations', - sectionContent: - 'Customer segmentation extensions appear in the [customer segment editor](https://help.shopify.com/en/manual/customers/customer-segmentation/create-customer-segments). Learn more about [customer segmentation](/docs/apps/marketing/customer-segments).', - sectionSubContent: [ - { - title: 'Customer segment editor', - sectionContent: - 'This page allows editing and templating of customer segments. The `admin.customers.segmentation-templates.render` target is available on this page.', - }, - ], - }, - { - type: 'Markdown', - title: 'Product configuration locations', - anchorLink: 'product-config-locations', - sectionContent: - 'Product configuration extensions appear on the product details and product variant details pages, and allow configuration of product bundles. Learn more about [product configuration](/docs/apps/selling-strategies/bundles/product-config).', - sectionSubContent: [ - { - title: 'Product details configuration', - sectionContent: - 'This page shows information about a single product. The `admin.product-details.configuration.render` target is available on this page.', - }, - { - title: 'Product variant details configuration', - sectionContent: - 'This page shows information about a single product variant. The `admin.product-variant-details.configuration.render` target is available on this page.', - }, - ], - }, - { - type: 'Markdown', - title: 'Validation settings locations', - anchorLink: 'validation-settings-locations', - sectionContent: - 'Validation settings extensions appear in the checkout rules section of the settings page. They allow merchants to configure validation rules for their checkout. Learn more about [validation settings](/docs/apps/checkout/validation).', - sectionSubContent: [ - { - title: 'Checkout rules', - sectionContent: - 'This page allows merchants to set up rules around their checkout experience. The `admin.settings.validation.render` target is available on this page.', - }, - ], - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/admin/templates/icon-renderer/dark-mode-listener.jsx b/packages/ui-extensions/docs/surfaces/admin/templates/icon-renderer/dark-mode-listener.jsx deleted file mode 100644 index 67afbc6999..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/templates/icon-renderer/dark-mode-listener.jsx +++ /dev/null @@ -1,38 +0,0 @@ -/* eslint-disable no-undef */ -(function () { - const initializedIframes = new WeakSet(); - - function sendThemeToIframe() { - const iframe = document.querySelector('#icon-preview-iframe'); - if (iframe && iframe.contentWindow) { - const isDark = document.documentElement.classList.contains('Mode-Dark'); - iframe.contentWindow.postMessage( - {type: 'theme', mode: isDark ? 'dark' : 'light'}, - '*', - ); - } - } - - const observer = new MutationObserver(() => { - const iframe = document.querySelector('#icon-preview-iframe'); - if (iframe && !initializedIframes.has(iframe)) { - initializedIframes.add(iframe); - iframe.addEventListener('load', sendThemeToIframe); - sendThemeToIframe(); - } - }); - observer.observe(document.body, {childList: true, subtree: true}); - - window.addEventListener('theme-mode-changed', () => { - sendThemeToIframe(); - }); - - // Re-send theme when page is restored from cache - window.addEventListener('pageshow', (event) => { - if (event.persisted) { - sendThemeToIframe(); - } - }); - - sendThemeToIframe(); -})(); diff --git a/packages/ui-extensions/docs/surfaces/admin/templates/icon-renderer/icon-preview.jsx b/packages/ui-extensions/docs/surfaces/admin/templates/icon-renderer/icon-preview.jsx deleted file mode 100644 index 2af70f81d3..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/templates/icon-renderer/icon-preview.jsx +++ /dev/null @@ -1,297 +0,0 @@ -const icons = "__ICON_LIST__"; - -const styles = ` - @keyframes reveal-fallback { - 0% { visibility: hidden; } - 99% { visibility: hidden; } - 100% { visibility: visible; } - } - - html:not([data-theme]) body { - visibility: hidden; - animation: reveal-fallback 300ms forwards; - } - - html { - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; - --border-base: #e1e3e5; - --border-focus: #303030; - --border-icon-item: rgba(0, 0, 0, 0.08); - --surface-base: #ffffff; - --surface-secondary: #f6f6f7; - --surface-hover: #f1f2f3; - --surface-disabled: #fafbfb; - --text-primary: #202223; - --text-subdued: #6d7175; - --text-disabled: #8c9196; - --shadow-icon-item: rgba(0, 0, 0, 0.05); - } - - html[data-theme="dark"] { - --border-base: #505256; - --border-focus: #ffffff; - --border-icon-item: rgba(255, 255, 255, 0.1); - --surface-base: #202124; - --surface-secondary: #303034; - --surface-hover: #404044; - --surface-disabled: #202124; - --text-primary: #e3e5e7; - --text-subdued: #999f9f; - --text-disabled: #6d7175; - --shadow-icon-item: rgba(0, 0, 0, 0.3); - } - - .icon-container { - border: 1px solid var(--border-base); - padding: 16px; - border-radius: 8px; - } - - .icon-stack { - display: flex; - flex-direction: column; - gap: 16px; - } - - .search-row { - display: flex; - align-items: center; - gap: 12px; - } - - .search-field { - flex: 1; - position: relative; - } - - .search-icon { - position: absolute; - left: 10px; - top: 50%; - transform: translateY(-50%); - width: 20px; - height: 20px; - pointer-events: none; - opacity: 0.6; - } - - .search-input { - width: 100%; - padding: 8px 12px 8px 36px; - border: 1.5px solid var(--border-base); - border-radius: 8px; - background: var(--surface-base); - color: var(--text-primary); - font-size: 14px; - outline: none; - box-sizing: border-box; - } - - .search-input:focus { - border-color: var(--border-focus); - } - - .icon-grid { - display: grid; - grid-template-columns: repeat(2, 1fr); - gap: 16px; - } - - @media (max-width: 480px) { - .icon-grid { - grid-template-columns: 1fr; - } - } - - .icon-item { - display: flex; - align-items: center; - gap: 12px; - padding: 16px; - background: var(--surface-secondary); - border: 1px solid var(--border-icon-item); - border-radius: 8px; - box-shadow: 0 2px 0px var(--shadow-icon-item); - font-family: "JetBrains Mono", Monaco, Consolas, "Lucida Console", monospace - } - - .icon-item:hover { - background: var(--surface-hover); - } - - .icon { - width: 20px; - height: 20px; - flex-shrink: 0; - } - - .icon-name { - font-size: 13px; - color: var(--text-primary); - } - - .empty-state { - text-align: center; - padding: 32px; - color: var(--text-subdued); - grid-column: 1 / -1; - } - - .pagination { - display: flex; - align-items: center; - justify-content: center; - gap: 8px; - } - - .pagination-button { - padding: 8px 16px; - border: 1px solid var(--border-base); - border-radius: 6px; - background: var(--surface-base); - color: var(--text-primary); - font-size: 14px; - cursor: pointer; - } - - .pagination-button:hover:not(:disabled) { - background: var(--surface-hover); - } - - .pagination-button:disabled { - background: var(--surface-disabled); - color: var(--text-disabled); - cursor: not-allowed; - opacity: 0.6; - } - - .pagination-text { - font-size: 14px; - color: var(--text-primary); - margin: 0 8px; - } - - html[data-theme="dark"] .icon { - filter: invert(1); - } -`; - -const [searchQuery, setSearchQuery] = useState(''); -const [currentPage, setCurrentPage] = useState(1); -const [isMobile, setIsMobile] = useState(window.innerWidth <= 480); - -const pageSize = isMobile ? 6 : 10; - -// Simple fuzzy search - checks if all query chars appear in order -const fuzzyMatch = (query, text) => { - let queryIndex = 0; - const lowerQuery = query.toLowerCase(); - const lowerText = text.toLowerCase(); - - for (let i = 0; i < lowerText.length && queryIndex < lowerQuery.length; i++) { - if (lowerText[i] === lowerQuery[queryIndex]) { - queryIndex++; - } - } - - return queryIndex === lowerQuery.length; -}; - -const filteredIcons = searchQuery - ? icons.filter(icon => fuzzyMatch(searchQuery, icon)) - : icons; - -const totalPages = Math.ceil(filteredIcons.length / pageSize); -const startIndex = (currentPage - 1) * pageSize; -const currentIcons = filteredIcons.slice( - startIndex, - startIndex + pageSize -); - -const handleSearchChange = (e) => { - setSearchQuery(e.target.value); - setCurrentPage(1); -}; - -const changePage = (newPage) => { - setCurrentPage(Math.min(Math.max(newPage, 1), totalPages)); -}; - -useEffect(() => { - const handleResize = () => { - const mobile = window.innerWidth <= 480; - if (mobile !== isMobile) { - setIsMobile(mobile); - setCurrentPage(1); - } - }; - - window.addEventListener('resize', handleResize); - return () => window.removeEventListener('resize', handleResize); -}, [isMobile]); - -return ( - <> - -

-
-
-
-
- -
- -
-
- - {currentIcons.length > 0 ? ( -
- {currentIcons.map((icon) => ( -
-
- -
-
{icon}
-
- ))} -
- ) : ( -
-
- No icons found matching "{searchQuery}" -
-
- )} - - {totalPages > 1 && ( -
- - - Page {currentPage} of {totalPages} - - -
- )} -
-
- -) diff --git a/packages/ui-extensions/docs/surfaces/admin/templates/icon-renderer/jsx-render.html b/packages/ui-extensions/docs/surfaces/admin/templates/icon-renderer/jsx-render.html deleted file mode 100644 index 8b2dc20570..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/templates/icon-renderer/jsx-render.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - {{BODY_CONTENT}} - - - diff --git a/packages/ui-extensions/docs/surfaces/admin/templates/jsx-render.html b/packages/ui-extensions/docs/surfaces/admin/templates/jsx-render.html deleted file mode 100644 index 1bd5ecad2e..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/templates/jsx-render.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - - {{BODY_CONTENT}} - - - diff --git a/packages/ui-extensions/docs/surfaces/admin/tsconfig.ab.docs.json b/packages/ui-extensions/docs/surfaces/admin/tsconfig.ab.docs.json deleted file mode 100644 index b5b6791d50..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/tsconfig.ab.docs.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "compilerOptions": { - "rootDir": "/" - }, - "include": [ - "./**/*.doc.ts", - "../../../src/surfaces/admin/components/**/*.doc.ts" - ], - "exclude": [ - "./**/*.ext.doc.ts", - "../../../src/surfaces/admin/components/**/*.ext.doc.ts" - ] -} diff --git a/packages/ui-extensions/docs/surfaces/admin/tsconfig.ext.docs.json b/packages/ui-extensions/docs/surfaces/admin/tsconfig.ext.docs.json deleted file mode 100644 index cddc9dfa9d..0000000000 --- a/packages/ui-extensions/docs/surfaces/admin/tsconfig.ext.docs.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "compilerOptions": { - "rootDir": "/" - }, - "include": ["./**/*.doc.ts", "../../../src/surfaces/admin/**/*.doc.ts"], - "exclude": ["./**/*.ab.doc.ts", "../../../src/surfaces/admin/**/*.ab.doc.ts"] -} diff --git a/packages/ui-extensions/docs/surfaces/build-doc-shared.mjs b/packages/ui-extensions/docs/surfaces/build-doc-shared.mjs index 0b1e7cfc46..497a48945e 100644 --- a/packages/ui-extensions/docs/surfaces/build-doc-shared.mjs +++ b/packages/ui-extensions/docs/surfaces/build-doc-shared.mjs @@ -7,23 +7,61 @@ import readline from 'readline/promises'; import process, {stdin as input, stdout as output} from 'process'; export const resolveShopifyDevPath = async (rootPath) => { - const defaultPath = path.resolve(rootPath, '../../../shopify-dev'); - if (existsSync(defaultPath)) return defaultPath; + const normalizeShopifyDevSourceRoot = (candidatePath) => { + if (!candidatePath) return null; + + const absolutePath = path.resolve(candidatePath); + + const sourceRootCandidates = [ + absolutePath, + path.join(absolutePath, 'trees/root/src'), + ]; + + for (const sourceRootPath of sourceRootCandidates) { + const zonePath = path.join(sourceRootPath, 'areas/platforms/shopify-dev'); + if (existsSync(zonePath)) return sourceRootPath; + } + + // Candidate might be the zone path itself (.../areas/platforms/shopify-dev) + if (absolutePath.endsWith(path.normalize('areas/platforms/shopify-dev'))) { + const sourceRootPath = path.resolve(absolutePath, '../../..'); + if (existsSync(path.join(sourceRootPath, 'areas/platforms/shopify-dev'))) { + return sourceRootPath; + } + } + + return null; + }; + + const candidatePaths = [ + process.env.SHOPIFY_DEV_PATH, + process.env.WORLD_PATH, + process.env.HOME ? path.join(process.env.HOME, 'world') : null, + path.resolve(rootPath, '../../../world'), + path.resolve(rootPath, '../../../shopify-dev'), + ].filter(Boolean); + + for (const candidatePath of candidatePaths) { + const sourceRootPath = normalizeShopifyDevSourceRoot(candidatePath); + if (sourceRootPath) return sourceRootPath; + } + + const defaultPath = path.resolve(rootPath, '../../../world'); const rl = readline.createInterface({input, output}); const answer = ( await rl.question( - `\n\x1b[33m⚠️ Shopify dev directory not found at:\x1b[0m \x1b[1m${defaultPath}\x1b[0m\n\x1b[32mPlease provide the absolute path to your "shopify-dev" repo:\x1b[0m `, + `\n\x1b[33m⚠️ Could not find a world/shopify-dev repo near:\x1b[0m \x1b[1m${defaultPath}\x1b[0m\n\x1b[32mPlease provide the absolute path to your world repo, shopify-dev repo, source root, or areas/platforms/shopify-dev folder:\x1b[0m `, ) ).trim(); rl.close(); - const shopifyDevPath = answer ? path.resolve(answer) : ''; - if (!shopifyDevPath || !existsSync(shopifyDevPath)) { + const shopifyDevPath = normalizeShopifyDevSourceRoot(answer); + if (!shopifyDevPath) { throw new Error( `\x1b[31m❌ Error: ${ - shopifyDevPath - ? `shopify-dev directory not found at ${shopifyDevPath}.` + answer + ? `No shopify-dev zone found from ${path.resolve(answer)}.` : 'Path cannot be empty.' } Check the path and try again!\x1b[0m`, ); @@ -50,37 +88,29 @@ export const generateFiles = async ({ scripts, outputDir, rootPath, - generatedDocsDataFile, - generatedStaticPagesFile, - transformJson, + generatedDocsDataV2File, }) => { - scripts.forEach((script) => childProcess.execSync(script, {stdio: 'pipe'})); - - const srcFiles = await fs.readdir(rootPath, {recursive: true}); - const builtFiles = srcFiles.filter((file) => file.endsWith('.ts')); - await Promise.all( - builtFiles.map((file) => { - const jsFilePath = path.join(rootPath, file.replace('.ts', '.js')); - return existsSync(jsFilePath) ? fs.rm(jsFilePath) : Promise.resolve(); - }), + scripts.forEach((script) => + childProcess.execSync(script, {stdio: 'inherit', cwd: rootPath}), ); - const generatedFiles = [path.join(outputDir, generatedDocsDataFile)]; - if (generatedStaticPagesFile) { - generatedFiles.push(path.join(outputDir, generatedStaticPagesFile)); + const outputPath = path.join(rootPath, outputDir); + const generatedDocsV2Path = path.join(outputPath, generatedDocsDataV2File); + + if (!existsSync(generatedDocsV2Path)) { + throw new Error( + `Generated docs file not found at ${generatedDocsV2Path}. ` + + 'The generate-docs step may have failed (check output above).', + ); } // Make sure https://shopify.dev URLs are relative so they work in Spin. // See https://github.com/Shopify/generate-docs/issues/181 await replaceFileContent({ - filePaths: generatedFiles, + filePaths: generatedDocsV2Path, searchValue: 'https://shopify.dev', replaceValue: '', }); - - if (transformJson) { - await transformJson(path.join(outputDir, generatedDocsDataFile)); - } }; export const copyGeneratedToShopifyDev = async ({ diff --git a/packages/ui-extensions/docs/surfaces/checkout/build-docs-fast.sh b/packages/ui-extensions/docs/surfaces/checkout/build-docs-fast.sh deleted file mode 100755 index c378a2b8e0..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/build-docs-fast.sh +++ /dev/null @@ -1,64 +0,0 @@ -API_VERSION=$1 -DOCS_PATH=docs/surfaces/checkout - -if [ -z $API_VERSION ] -then - echo "You must specify a calver version YYYY-MM or YYYY-MM-rc (for a release candidate)." - exit 1; -else - echo "Building docs for '$API_VERSION' checkout UI extensions API (fast mode - only changed files)." -fi - -# Get list of changed .doc.ts files -CHANGED_DOCS=$(git diff --name-only HEAD | grep "\.doc\.ts$" | grep "$DOCS_PATH/staticPages") - -if [ -z "$CHANGED_DOCS" ]; then - echo "No .doc.ts files changed in static pages. Nothing to rebuild." - exit 0 -fi - -echo "Changed files:" -echo "$CHANGED_DOCS" - -# Convert full paths to relative paths from package root -RELATIVE_DOCS=$(echo "$CHANGED_DOCS" | sed 's|packages/ui-extensions/||g') - -echo "Compiling: $RELATIVE_DOCS" - -# Only compile changed static pages -COMPILE_STATIC_PAGES="yarn tsc $RELATIVE_DOCS --types react --moduleResolution node --target esNext --module CommonJS && yarn generate-docs --isLandingPage --input ./$DOCS_PATH/staticPages --output ./$DOCS_PATH/generated" - -eval $COMPILE_STATIC_PAGES -build_exit=$? - -# Clean up generated JS files -find ./ -name '*.doc*.js' -exec rm -r {} \; - -if [ $build_exit -ne 0 ]; then - echo "** Failed to generate docs" - exit $build_exit -fi - -# Copy generated docs to shopify-dev -copy_generated_docs_to_shopify_dev() { - if [ -d $SHOPIFY_DEV_PATH ]; then - mkdir -p $SHOPIFY_DEV_PATH/db/data/docs/templated_apis/checkout_extensions/$API_VERSION - cp ./$DOCS_PATH/generated/* $SHOPIFY_DEV_PATH/db/data/docs/templated_apis/checkout_extensions/$API_VERSION - echo "✓ Copied docs to shopify-dev: $SHOPIFY_DEV_PATH/db/data/docs/templated_apis/checkout_extensions/$API_VERSION" - else - echo "Not copying docs to shopify-dev because it was not found at $SHOPIFY_DEV_PATH." - fi -} - -# Try relative path first (for CI/Github Actions) -SHOPIFY_DEV_PATH="../../../shopify-dev" - -if [ -d $SHOPIFY_DEV_PATH ]; then - copy_generated_docs_to_shopify_dev -else - # Try local dev environment path - SHOPIFY_DEV_PATH="$HOME/src/github.com/Shopify/shopify-dev" - copy_generated_docs_to_shopify_dev -fi - -echo "✓ Fast docs build complete" diff --git a/packages/ui-extensions/docs/surfaces/checkout/build-docs-targets-json.mjs b/packages/ui-extensions/docs/surfaces/checkout/build-docs-targets-json.mjs new file mode 100644 index 0000000000..d21355c597 --- /dev/null +++ b/packages/ui-extensions/docs/surfaces/checkout/build-docs-targets-json.mjs @@ -0,0 +1,598 @@ +/* eslint-disable no-console */ +/* eslint-env node */ +import fs from 'fs'; +import path from 'path'; +import {fileURLToPath} from 'url'; +import { + createTypeResolver, + splitByTopLevelComma, +} from '../../shared/build-docs-type-resolver.mjs'; + +const __filename = fileURLToPath(import.meta.url); +const __dirname = path.dirname(__filename); + +// Output targets.json next to generated_docs_data_v2.json (wherever it lives). +function findGeneratedDocsPath() { + const generatedDir = path.join(__dirname, 'generated'); + + function findFile(dir) { + const files = fs.readdirSync(dir); + for (const file of files) { + const fullPath = path.join(dir, file); + const stat = fs.statSync(fullPath); + if (stat.isDirectory()) { + const result = findFile(fullPath); + if (result) return result; + } else if (file === 'generated_docs_data_v2.json') { + return path.dirname(fullPath); + } + } + return null; + } + + const docsPath = findFile(generatedDir); + return docsPath || generatedDir; +} + +// Configuration for checkout surface +const config = { + basePath: path.join(__dirname, '../../../src/surfaces/checkout'), + outputPath: path.join(findGeneratedDocsPath(), 'targets.json'), + componentTypesPath: null, + hasComponentTypes: false, +}; + +// All components will be populated from SUPPORTED_COMPONENTS +const allComponents = []; + +// Cache for parsed API files to avoid re-reading +const apiDefinitionsCache = {}; + +// Create type resolver for checkout surface +const sharedTsPath = path.join(config.basePath, 'shared.ts'); +const typeResolver = createTypeResolver(sharedTsPath); + +// Expose resolver methods for use in this script +const resolveType = typeResolver.resolveType; +const resolveTypeUnfiltered = typeResolver.resolveTypeUnfiltered; +const getTypeDefinitions = typeResolver.getTypeDefinitions; + +function parseComponentTypesFromFiles() { + // Checkout doesn't have separate component type files + return {}; +} + +function parseTargetsFile() { + const targetsFilePath = path.join(config.basePath, 'extension-targets.ts'); + + const content = fs.readFileSync(targetsFilePath, 'utf-8'); + + // Parse component type definitions + const componentTypesMap = parseComponentTypesFromFiles(); + + const targets = {}; + + // Look for all interfaces that might contain RenderExtension or RunnableExtension targets + const interfaceNames = [ + 'RenderExtensionTargets', + 'RunnableExtensionTargets', + 'OrderStatusExtensionTargets', + 'CustomerAccountExtensionTargets', + 'ExtensionTargets', + ]; + + for (const interfaceName of interfaceNames) { + // Try to find this interface + const regex = new RegExp( + `export interface ${interfaceName}[^{]*\\{([\\s\\S]+?)\\n\\}`, + ); + const match = content.match(regex); + + if (match) { + // Parse RenderExtension targets (have components) + if (match[1].includes('RenderExtension<')) { + parseTargetsFromInterfaceBody(match[1], targets, componentTypesMap); + } + // Parse RunnableExtension targets (no components, like address-autocomplete) + if (match[1].includes('RunnableExtension<')) { + parseRunnableTargetsFromInterfaceBody(match[1], targets); + } + } + } + + if (Object.keys(targets).length === 0) { + throw new Error('Could not find extension targets interface'); + } + + return targets; +} + +function parseTargetsFromInterfaceBody( + interfaceBody, + targets, + componentTypesMap, +) { + // Parse each target definition (handle multi-line) + const targetRegex = /'([^']+)':\s*RenderExtension<([\s\S]*?)>;/g; + + let match; + while ((match = targetRegex.exec(interfaceBody)) !== null) { + const targetName = match[1]; + const matchStartPos = match.index; + + // Check if this target has @private in its JSDoc comment + // Look backwards from the match to find a preceding JSDoc comment + const beforeMatch = interfaceBody.substring(0, matchStartPos); + const lastJsDocEnd = beforeMatch.lastIndexOf('*/'); + + if (lastJsDocEnd !== -1) { + // Check if there's no other target between the JSDoc and this target + const between = beforeMatch.substring(lastJsDocEnd + 2).trim(); + // If the text between JSDoc end and target is empty (or just whitespace), the JSDoc belongs to this target + if (between === '') { + const jsDocStart = beforeMatch.lastIndexOf('/**'); + if (jsDocStart !== -1) { + const jsDocContent = beforeMatch.substring( + jsDocStart, + lastJsDocEnd + 2, + ); + // Skip this target if it's marked @private + if (jsDocContent.includes('@private')) { + continue; + } + } + } + } + + let renderExtensionContent = match[2].trim(); + + // Remove comments before parsing + renderExtensionContent = renderExtensionContent + .replace(/\/\/[^\n]*/g, '') // Remove single-line comments + .replace(/\/\*[\s\S]*?\*\//g, ''); // Remove multi-line comments + + // Split by comma to separate API and Components + const parts = splitByTopLevelComma(renderExtensionContent); + + if (parts.length >= 2) { + const apiString = parts[0].trim(); + const componentString = parts[1].trim(); + + // Parse APIs from the intersection type + const apis = parseApis(apiString); + + // Parse components + const components = parseComponents(componentString, componentTypesMap); + + targets[targetName] = { + components: components.sort(), + apis: apis.sort(), + }; + } + } +} + +/** + * Parse RunnableExtension targets from an interface body + * These targets don't have components (they return data, not UI) + */ +function parseRunnableTargetsFromInterfaceBody(interfaceBody, targets) { + // Parse each RunnableExtension target definition (handle multi-line) + const targetRegex = /'([^']+)':\s*RunnableExtension<([\s\S]*?)>;/g; + + let match; + while ((match = targetRegex.exec(interfaceBody)) !== null) { + const targetName = match[1]; + const matchStartPos = match.index; + + // Check if this target has @private in its JSDoc comment + const beforeMatch = interfaceBody.substring(0, matchStartPos); + const lastJsDocEnd = beforeMatch.lastIndexOf('*/'); + + if (lastJsDocEnd !== -1) { + const between = beforeMatch.substring(lastJsDocEnd + 2).trim(); + if (between === '') { + const jsDocStart = beforeMatch.lastIndexOf('/**'); + if (jsDocStart !== -1) { + const jsDocContent = beforeMatch.substring( + jsDocStart, + lastJsDocEnd + 2, + ); + if (jsDocContent.includes('@private')) { + continue; + } + } + } + } + + let runnableExtensionContent = match[2].trim(); + + // Remove comments before parsing + runnableExtensionContent = runnableExtensionContent + .replace(/\/\/[^\n]*/g, '') + .replace(/\/\*[\s\S]*?\*\//g, ''); + + // Split by comma to separate API and Output type + const parts = splitByTopLevelComma(runnableExtensionContent); + + if (parts.length >= 1) { + const apiString = parts[0].trim(); + + // Parse APIs from the intersection type + const apis = parseApis(apiString); + + // RunnableExtension targets don't have components - they return data + targets[targetName] = { + components: [], + apis: apis.sort(), + }; + } + } +} + +function getNestedApis(apiName) { + // Check if we've already parsed this API + if (Object.prototype.hasOwnProperty.call(apiDefinitionsCache, apiName)) { + return apiDefinitionsCache[apiName]; + } + + // Try to find the API file in the surface's api directory + const apiDir = path.join(config.basePath, 'api'); + + if (!fs.existsSync(apiDir)) { + apiDefinitionsCache[apiName] = []; + return []; + } + + // Convert API name to potential file paths + // e.g., StandardApi -> standard-api, CartApi -> cart-api + const kebabName = apiName + .replace(/Api$/, '') + .replace(/([a-z])([A-Z])/g, '$1-$2') + .toLowerCase(); + + // Try multiple possible locations + const possiblePaths = [ + path.join(apiDir, `${kebabName}.ts`), + path.join(apiDir, `${kebabName}`, `${kebabName}.ts`), + path.join(apiDir, kebabName.replace(/-/g, ''), `${kebabName}.ts`), + path.join(apiDir, `${kebabName}-api`, `${kebabName}-api.ts`), + path.join(apiDir, `${kebabName}-api.ts`), + path.join(apiDir, `standard-api`, `standard-api.ts`), + ]; + + let content = null; + for (const apiFilePath of possiblePaths) { + try { + if (fs.existsSync(apiFilePath)) { + content = fs.readFileSync(apiFilePath, 'utf-8'); + break; + } + } catch (error) { + // Continue to next path + } + } + + if (!content) { + apiDefinitionsCache[apiName] = []; + return []; + } + + try { + // Find the export type definition for this API + const typeDefStartRegex = new RegExp(`export type ${apiName}[^=]*=`, 's'); + const startMatch = content.match(typeDefStartRegex); + + if (!startMatch) { + apiDefinitionsCache[apiName] = []; + return []; + } + + // Find the end position (semicolon at the correct nesting level) + const startPos = startMatch.index + startMatch[0].length; + let endPos = startPos; + let braceDepth = 0; + let angleDepth = 0; + + for (let i = startPos; i < content.length; i++) { + const char = content[i]; + + if (char === '{') braceDepth++; + else if (char === '}') braceDepth--; + else if (char === '<') angleDepth++; + else if (char === '>') angleDepth--; + else if (char === ';' && braceDepth === 0 && angleDepth === 0) { + endPos = i; + break; + } + } + + const typeDef = content.substring(startPos, endPos); + + // Extract all API names from the type definition + const nestedApis = []; + const apiMatches = typeDef.matchAll(/(\w+Api)\b/g); + + for (const apiMatch of apiMatches) { + const nestedApiName = apiMatch[1]; + // Don't include the API itself + if (nestedApiName !== apiName && !nestedApis.includes(nestedApiName)) { + nestedApis.push(nestedApiName); + } + } + + apiDefinitionsCache[apiName] = nestedApis; + return nestedApis; + } catch (error) { + // Error parsing, cache and return empty array + apiDefinitionsCache[apiName] = []; + return []; + } +} + +// APIs that are composites — list their documented constituent APIs instead of themselves +const COMPOSITE_API_DECOMPOSITION = { + StandardApi: [ + 'AddressesApi', + 'AnalyticsApi', + 'AttributesApi', + 'BuyerIdentityApi', + 'BuyerJourneyApi', + 'CartInstructionsApi', + 'CartLinesApi', + 'CheckoutTokenApi', + 'CostApi', + 'CustomerPrivacyApi', + 'DeliveryApi', + 'DiscountsApi', + 'ExtensionApi', + 'GiftCardsApi', + 'LocalizationApi', + 'LocalizedFieldsApi', + 'MetafieldsApi', + 'NoteApi', + 'PaymentsApi', + 'SessionTokenApi', + 'SettingsApi', + 'ShopApi', + 'StorageApi', + 'StorefrontApi', + ], + CheckoutApi: [ + 'AddressesApi', + 'AttributesApi', + 'CartLinesApi', + 'DiscountsApi', + 'GiftCardsApi', + 'MetafieldsApi', + 'NoteApi', + ], + AddressAutocompleteStandardApi: [ + 'AddressesApi', + 'AnalyticsApi', + 'AttributesApi', + 'CheckoutTokenApi', + 'ExtensionApi', + 'LocalizationApi', + 'MetafieldsApi', + 'SessionTokenApi', + 'SettingsApi', + 'ShopApi', + 'StorageApi', + 'StorefrontApi', + ], +}; + +function parseApis(apiString) { + const apisSet = new Set(); + + // Remove any comments + const trimmedApiString = apiString + .replace(/\/\/[^\n]*/g, '') + .replace(/\/\*[\s\S]*?\*\//g, ''); + + // Split by & and extract API names + const parts = trimmedApiString + .split('&') + .map((part) => part.trim()) + .filter((part) => part); + + for (const part of parts) { + // Match API names (e.g., StandardApi<'...'> or just ApiName) + let apiName = null; + + // Extract just the type name before any generic parameters + const apiMatch = part.match(/^(\w+Api)/); + if (apiMatch) { + apiName = apiMatch[1]; + } else { + // Try to match any capitalized type name ending in Api + const generalMatch = part.match(/(\w+Api)\b/); + if (generalMatch) { + apiName = generalMatch[1]; + } + } + + if (apiName) { + if (COMPOSITE_API_DECOMPOSITION[apiName]) { + // Replace composite with its documented constituent APIs + for (const constituent of COMPOSITE_API_DECOMPOSITION[apiName]) { + apisSet.add(constituent); + } + } else { + // Add the API itself + apisSet.add(apiName); + + // Get nested APIs from this API (recursively) + const nestedApis = getNestedApis(apiName); + for (const nestedApi of nestedApis) { + apisSet.add(nestedApi); + // Recursively get nested APIs of nested APIs + const deepNestedApis = getNestedApis(nestedApi); + deepNestedApis.forEach((api) => apisSet.add(api)); + } + } + } + } + + return Array.from(apisSet); +} + +/** + * Parse a TypeScript component type expression + * Uses the generic resolveType() to handle any type expression dynamically + */ +function parseComponents(componentString) { + // Normalize whitespace + const trimmedComponentString = componentString.replace(/\s+/g, ' ').trim(); + + // Handle generic wrapper types like AnyCheckoutComponentExcept<'X' | 'Y'> + // These are defined as: type AnyCheckoutComponentExcept = Exclude + // We need to expand them to their actual Exclude form + const genericExceptMatch = trimmedComponentString.match( + /^(\w+Except)<([^>]+)>$/, + ); + if (genericExceptMatch) { + const genericTypeName = genericExceptMatch[1]; + const typeArg = genericExceptMatch[2]; + + // Look up the generic type definition to find the base type + const typeDefs = getTypeDefinitions(); + const genericDef = typeDefs[genericTypeName]; + + if (genericDef) { + // Parse the generic definition to extract the base type from Exclude + const baseTypeMatch = genericDef.match(/Exclude<(\w+),\s*Except>/); + if (baseTypeMatch) { + const baseTypeName = baseTypeMatch[1]; + // Resolve as Exclude + const baseComponents = resolveType(baseTypeName); + const excludedComponents = resolveType(typeArg); + return baseComponents.filter( + (component) => !excludedComponents.includes(component), + ); + } + } + } + + // Handle AllowedComponents - it's just an identity wrapper + // BUT: AllowedComponents explicitly allows components, so don't filter private + // This is how targets like purchase.checkout.chat.render explicitly allow 'Chat' + const allowedMatch = trimmedComponentString.match( + /AllowedComponents<([^>]+)>/, + ); + if (allowedMatch) { + const innerType = allowedMatch[1].trim(); + // Use unfiltered resolution since AllowedComponents explicitly allows these + return resolveTypeUnfiltered(innerType); + } + + // Use the generic resolver for everything else + // This handles: type references, Exclude<>, unions, string literals, etc. + const result = resolveType(componentString); + if (result.length > 0) { + return result; + } + + // Default to all components if we have them + if (allComponents.length > 0) { + return allComponents; + } + + return ['[Unknown]']; +} + +function createCombinedMapping(targetsJson) { + const result = {...targetsJson}; + + // Create reverse mappings for APIs + const apiToTargets = {}; + const componentToTargets = {}; + + // Iterate through all targets + for (const [targetName, targetData] of Object.entries(targetsJson)) { + // Map APIs to targets + for (const api of targetData.apis) { + if (!apiToTargets[api]) { + apiToTargets[api] = []; + } + apiToTargets[api].push(targetName); + } + + // Map Components to targets + for (const component of targetData.components) { + if (!componentToTargets[component]) { + componentToTargets[component] = []; + } + componentToTargets[component].push(targetName); + } + } + + // Add API reverse mappings to result + for (const [api, targets] of Object.entries(apiToTargets)) { + result[api] = { + targets: targets.sort(), + }; + } + + // Add Component reverse mappings to result + for (const [component, targets] of Object.entries(componentToTargets)) { + result[component] = { + targets: targets.sort(), + }; + } + + return result; +} + +// Main execution +try { + console.log('\n🔍 Generating targets JSON for checkout surface'); + console.log(`📁 Base path: ${config.basePath}`); + + // Generate the JSON + const targetsJson = parseTargetsFile(); + + // Create the combined JSON with reverse mappings + const combinedJson = createCombinedMapping(targetsJson); + + // These components have doc pages but are not exported from the TypeScript source, + // so the script cannot discover them automatically. Add them manually with all targets. + const allTargetNames = Object.keys(targetsJson).sort(); + const UNDISCOVERABLE_COMPONENTS = ['StyleHelper']; + for (const component of UNDISCOVERABLE_COMPONENTS) { + if (!combinedJson[component]) { + combinedJson[component] = {targets: allTargetNames}; + } + } + + // Write to output file + const outputDir = path.dirname(config.outputPath); + if (!fs.existsSync(outputDir)) { + fs.mkdirSync(outputDir, {recursive: true}); + } + fs.writeFileSync(config.outputPath, JSON.stringify(combinedJson, null, 2)); + + console.log('✅ Generated combined targets JSON at:', config.outputPath); + + // Count the different types of entries + const targetEntries = Object.keys(targetsJson).length; + const apiEntries = Object.keys(combinedJson).filter( + (key) => + combinedJson[key].targets && !targetsJson[key] && key.endsWith('Api'), + ).length; + const componentEntries = Object.keys(combinedJson).filter( + (key) => + combinedJson[key].targets && !targetsJson[key] && !key.endsWith('Api'), + ).length; + + console.log('\n📋 Summary:'); + console.log(` Extension targets: ${targetEntries}`); + console.log(` API reverse mappings: ${apiEntries}`); + console.log(` Component reverse mappings: ${componentEntries}`); + console.log(` Total entries in JSON: ${Object.keys(combinedJson).length}`); +} catch (error) { + console.error('❌ Error generating targets JSON:', error.message); + console.error(error.stack); + process.exit(1); +} diff --git a/packages/ui-extensions/docs/surfaces/checkout/build-docs-watch.sh b/packages/ui-extensions/docs/surfaces/checkout/build-docs-watch.sh deleted file mode 100755 index 31a041e011..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/build-docs-watch.sh +++ /dev/null @@ -1,83 +0,0 @@ -API_VERSION=$1 -DOCS_PATH=docs/surfaces/checkout - -if [ -z $API_VERSION ] -then - echo "You must specify a calver version YYYY-MM or YYYY-MM-rc (for a release candidate)." - exit 1; -else - echo "Watching docs for '$API_VERSION' checkout UI extensions API..." -fi - -# Function to build docs -build_docs() { - echo "Building docs..." - - # Get list of changed .doc.ts files - CHANGED_DOCS=$(git diff --name-only HEAD | grep "\.doc\.ts$" | grep "$DOCS_PATH/staticPages") - - if [ -z "$CHANGED_DOCS" ]; then - echo "No .doc.ts files changed, building all static pages..." - COMPILE_STATIC_PAGES="yarn tsc $DOCS_PATH/staticPages/*.doc.ts --types react --moduleResolution node --target esNext --module CommonJS && yarn generate-docs --isLandingPage --input ./$DOCS_PATH/staticPages --output ./$DOCS_PATH/generated" - else - echo "Changed files:" - echo "$CHANGED_DOCS" - - # Convert full paths to relative paths from package root - RELATIVE_DOCS=$(echo "$CHANGED_DOCS" | sed 's|packages/ui-extensions/||g') - - COMPILE_STATIC_PAGES="yarn tsc $RELATIVE_DOCS --types react --moduleResolution node --target esNext --module CommonJS && yarn generate-docs --isLandingPage --input ./$DOCS_PATH/staticPages --output ./$DOCS_PATH/generated" - fi - - eval $COMPILE_STATIC_PAGES - build_exit=$? - - # Clean up generated JS files - find ./ -name '*.doc*.js' -exec rm -r {} \; - - if [ $build_exit -ne 0 ]; then - echo "** Failed to generate docs" - return $build_exit - fi - - # Copy generated docs to shopify-dev - copy_generated_docs_to_shopify_dev() { - if [ -d $SHOPIFY_DEV_PATH ]; then - mkdir -p $SHOPIFY_DEV_PATH/db/data/docs/templated_apis/checkout_extensions/$API_VERSION - cp ./$DOCS_PATH/generated/* $SHOPIFY_DEV_PATH/db/data/docs/templated_apis/checkout_extensions/$API_VERSION - echo "✓ Copied docs to shopify-dev" - fi - } - - # Try relative path first (for CI/Github Actions) - SHOPIFY_DEV_PATH="../../../shopify-dev" - - if [ -d $SHOPIFY_DEV_PATH ]; then - copy_generated_docs_to_shopify_dev - else - # Try local dev environment path - SHOPIFY_DEV_PATH="$HOME/src/github.com/Shopify/shopify-dev" - copy_generated_docs_to_shopify_dev - fi - - echo "✓ Build complete at $(date +%H:%M:%S)" -} - -# Check for fswatch before building -if ! command -v fswatch &> /dev/null; then - echo "Error: fswatch is required for watch mode" - echo "Install it with: brew install fswatch" - exit 1 -fi - -# Initial build -build_docs - -echo "" -echo "Watching for changes in $DOCS_PATH/staticPages/*.doc.ts..." -echo "Press Ctrl+C to stop" -echo "" - -fswatch -o $DOCS_PATH/staticPages/*.doc.ts | while read f; do - build_docs -done diff --git a/packages/ui-extensions/docs/surfaces/checkout/build-docs.sh b/packages/ui-extensions/docs/surfaces/checkout/build-docs.sh index cec2db4796..faa397cede 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/build-docs.sh +++ b/packages/ui-extensions/docs/surfaces/checkout/build-docs.sh @@ -2,8 +2,6 @@ API_VERSION=$1 DOCS_PATH=docs/surfaces/checkout SRC_PATH=src/surfaces/checkout COMPONENTS_DIR=src/surfaces/checkout/components -COMPONENTS_DEFINITIONS=src/surfaces/checkout/components/components.d.ts -COMPONENTS_TEMP_TS=src/surfaces/checkout/components/components.ts fail_and_exit() { echo "** Failed to generate docs" @@ -35,8 +33,11 @@ else echo "Building docs for '$API_VERSION' checkout UI extensions API." fi -COMPILE_DOCS="yarn tsc --project $DOCS_PATH/tsconfig.docs.json --types react --moduleResolution node --target esNext --module CommonJS && yarn generate-docs --overridePath ./$DOCS_PATH/typeOverride.json --input ./$DOCS_PATH/reference ./$SRC_PATH --typesInput ./$SRC_PATH --output ./$DOCS_PATH/generated" -COMPILE_STATIC_PAGES="yarn tsc $DOCS_PATH/staticPages/*.doc.ts --types react --moduleResolution node --target esNext --module CommonJS && yarn generate-docs --isLandingPage --input ./$DOCS_PATH/staticPages --output ./$DOCS_PATH/generated" +# Wipe the generated directory so stale files from previous runs don't linger. +echo "Cleaning ./$DOCS_PATH/generated..." +rm -rf ./$DOCS_PATH/generated + +COMPILE_DOCS="yarn generate-docs --overridePath ./$DOCS_PATH/typeOverride.json --input ./$SRC_PATH --output ./$DOCS_PATH/generated" # Copy all .d.ts files in components directory to .ts files so they can be picked up by the generate-docs tool echo "Copying .d.ts files to temporary .ts files..." @@ -56,25 +57,19 @@ done if echo "$PWD" | grep -q '\checkout-web'; then # We are generating docs from the private package, which does not have other surfaces aside from checkout - eval $COMPILE_DOCS && eval $COMPILE_STATIC_PAGES && eval $COMPILE_CATEGORIES + eval $COMPILE_DOCS build_exit=$? else # Other surfaces may have duplicate types that cause issues with documentation generation, # so we erase their contents and replace them afterwards echo "export {}" > src/surfaces/customer-account.ts echo "export {}" > src/surfaces/admin.ts - eval $COMPILE_DOCS && eval $COMPILE_STATIC_PAGES && eval $COMPILE_CATEGORIES + eval $COMPILE_DOCS build_exit=$? git checkout HEAD -- src/surfaces/customer-account.ts git checkout HEAD -- src/surfaces/admin.ts fi -# TODO: get generate-docs to stop requiring JS files: -# https://github.com/Shopify/generate-docs#important-note -find ./ -name '*.doc*.js' -exec rm -r {} \; -find ./src/docs/shared -name '*.js' -exec rm -r {} \; -find ./src/docs/shared/components -name '*.js' -exec rm -r {} \; - # Remove all temporary .ts files that were created from .d.ts files echo "Removing temporary .ts files..." for temp_file in "${TEMP_FILES[@]}"; do @@ -89,46 +84,58 @@ fi # Make sure https://shopify.dev URLs are relative. # See https://github.com/Shopify/generate-docs/issues/181 -run_sed 's/https:\/\/shopify.dev//gi' ./$DOCS_PATH/generated/generated_docs_data.json +run_sed 's/https:\/\/shopify.dev//gi' ./$DOCS_PATH/generated/generated_docs_data_v2.json sed_exit=$? if [ $sed_exit -ne 0 ]; then fail_and_exit $sed_exit fi +# Generate targets.json (extension targets + APIs + components mapping) +node ./$DOCS_PATH/build-docs-targets-json.mjs +targets_exit=$? +if [ $targets_exit -ne 0 ]; then + fail_and_exit $targets_exit +fi + +echo "" +echo "Generated docs at:" +echo " Checkout UI extensions: $PWD/$DOCS_PATH/generated" +echo " targets.json: $PWD/$DOCS_PATH/generated/targets.json" +echo "" copy_generated_docs_to_shopify_dev() { # Copy the generated docs to shopify-dev if [ -d $SHOPIFY_DEV_PATH ]; then - mkdir -p $SHOPIFY_DEV_PATH/db/data/docs/templated_apis/checkout_extensions/$API_VERSION - cp ./$DOCS_PATH/generated/* $SHOPIFY_DEV_PATH/db/data/docs/templated_apis/checkout_extensions/$API_VERSION + SHOPIFY_DEV_DEST=$SHOPIFY_DEV_PATH/areas/platforms/shopify-dev/db/data/docs/templated_apis/checkout_extensions/$API_VERSION + mkdir -p $SHOPIFY_DEV_DEST + cp ./$DOCS_PATH/generated/* $SHOPIFY_DEV_DEST # Replace 'latest' with the exact API version in relative doc links - for file in generated_docs_data.json generated_static_pages.json; do - run_sed \ - "s/\/docs\/api\/checkout-ui-extensions\/latest/\/docs\/api\/checkout-ui-extensions\/$API_VERSION/gi" \ - "$SHOPIFY_DEV_PATH/db/data/docs/templated_apis/checkout_extensions/$API_VERSION/$file" - sed_exit=$? - if [ $sed_exit -ne 0 ]; then - fail_and_exit $sed_exit - fi - done + run_sed \ + "s/\/docs\/api\/checkout-ui-extensions\/latest/\/docs\/api\/checkout-ui-extensions\/$API_VERSION/gi" \ + "$SHOPIFY_DEV_DEST/generated_docs_data_v2.json" + sed_exit=$? + if [ $sed_exit -ne 0 ]; then + fail_and_exit $sed_exit + fi - rsync -a --delete ./$DOCS_PATH/screenshots/ $SHOPIFY_DEV_PATH/react-app/public/images/templated-apis-screenshots/checkout-ui-extensions/$API_VERSION echo "Docs: https://shopify-dev.shop.dev/docs/api/checkout-ui-extensions" else echo "Not copying docs to shopify-dev because it was not found at $SHOPIFY_DEV_PATH." fi } -# Assume we have a relative path to shopify-dev (for non-local environments like CI, and Github Actions) -SHOPIFY_DEV_PATH="../../../shopify-dev" +# Try candidate paths for shopify-dev / world repo in order of preference +for SHOPIFY_DEV_PATH in \ + "$HOME/world/trees/root/src" \ + "../../../shopify-dev" \ + "$HOME/src/github.com/Shopify/shopify-dev"; do + if [ -d "$SHOPIFY_DEV_PATH" ]; then + copy_generated_docs_to_shopify_dev + break + fi +done -if [ -d $SHOPIFY_DEV_PATH ]; then - copy_generated_docs_to_shopify_dev -else - # We could be in the shop/world repo and it's in a different location on your local machine - # This is a best guess as to where it might be located in local dev environments - SHOPIFY_DEV_PATH="$HOME/src/github.com/Shopify/shopify-dev" - copy_generated_docs_to_shopify_dev +if [ ! -d "$SHOPIFY_DEV_PATH" ]; then + echo "Not copying docs to shopify-dev because no repo was found." fi - diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.json b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.json new file mode 100644 index 0000000000..47eab90f0e --- /dev/null +++ b/packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.json @@ -0,0 +1,168250 @@ +{ + "ValidationError": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "ValidationError", + "description": "A validation error object that is returned when an operation fails.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "A code identifier for the error." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "issues", + "value": "{ message: string; path: string[]; }[]", + "description": "Field-level validation issues", + "isOptional": true + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message describing the error." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "" + } + ], + "value": "interface ValidationError {\n type: 'error';\n /**\n * A message describing the error.\n */\n message: string;\n /**\n * A code identifier for the error.\n */\n code: string;\n /**\n * Field-level validation issues\n */\n issues?: {\n message: string;\n path: string[];\n }[];\n}" + } + }, + "SellingPlan": { + "src/surfaces/checkout/api/shared.ts": { + "filePath": "src/surfaces/checkout/api/shared.ts", + "name": "SellingPlan", + "description": "A [selling plan](/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the selling plan in the format `gid://shopify/SellingPlan/`. Use this to reference the specific selling plan associated with a line item.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/SellingPlan/1'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "recurringDeliveries", + "value": "boolean", + "description": "Whether purchasing through this selling plan results in multiple deliveries. `true` for subscription plans with recurring fulfillment, `false` for one-time pre-orders or try-before-you-buy plans." + } + ], + "value": "export interface SellingPlan {\n /**\n * A globally-unique identifier for the selling plan in the format\n * `gid://shopify/SellingPlan/`. Use this to reference the specific\n * selling plan associated with a line item.\n *\n * @example 'gid://shopify/SellingPlan/1'\n */\n id: string;\n\n /**\n * Whether purchasing through this selling plan results in multiple\n * deliveries. `true` for subscription plans with recurring fulfillment,\n * `false` for one-time pre-orders or try-before-you-buy plans.\n */\n recurringDeliveries: boolean;\n}" + } + }, + "Attribute": { + "src/surfaces/checkout/api/shared.ts": { + "filePath": "src/surfaces/checkout/api/shared.ts", + "name": "Attribute", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The identifier for the attribute. Each key must be unique within the set of attributes on the cart or checkout. If you call `applyAttributeChange()` with a key that already exists, then the existing value is replaced.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gift_wrapping'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value associated with the attribute key. This is a freeform string that can store any information the buyer or app provides.\n\nAttribute values are always strings. To store structured data, serialize it to JSON and parse it when reading.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Please use red wrapping paper'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface Attribute {\n /**\n * The identifier for the attribute. Each key must be unique within the\n * set of attributes on the cart or checkout. If you call\n * `applyAttributeChange()` with a key that already exists, then the\n * existing value is replaced.\n *\n * @example 'gift_wrapping'\n */\n key: string;\n\n /**\n * The value associated with the attribute key. This is a freeform string\n * that can store any information the buyer or app provides.\n *\n * Attribute values are always strings. To store structured data, serialize\n * it to JSON and parse it when reading.\n *\n * @example 'Please use red wrapping paper'\n */\n value: string;\n}" + } + }, + "MailingAddress": { + "src/surfaces/checkout/api/shared.ts": { + "filePath": "src/surfaces/checkout/api/shared.ts", + "name": "MailingAddress", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "address1", + "value": "string", + "description": "The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'151 O'Connor Street'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "address2", + "value": "string", + "description": "The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Ground floor'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "city", + "value": "string", + "description": "The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Ottawa'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "company", + "value": "string", + "description": "The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Shopify'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "countryCode", + "value": "CountryCode", + "description": "The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'CA' for Canada.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "firstName", + "value": "string", + "description": "The buyer's first name. Use this alongside `lastName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a first name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'John'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "lastName", + "value": "string", + "description": "The buyer's last name. Use this alongside `firstName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a last name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Doe'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The buyer's full name, typically a combination of first and last name. The value is `undefined` if the buyer didn't provide a name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'John Doe'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "phone", + "value": "string", + "description": "The phone number associated with the address, typically in international format. The value is `undefined` if the buyer didn't provide a phone number or the store doesn't collect phone numbers.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'+1 613 111 2222'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "provinceCode", + "value": "string", + "description": "The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'ON' for Ontario.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "zip", + "value": "string", + "description": "The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'K2P 2L8'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface MailingAddress {\n /**\n * The buyer's full name, typically a combination of first and last name.\n * The value is `undefined` if the buyer didn't provide a name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John Doe'\n */\n name?: string;\n\n /**\n * The buyer's first name. Use this alongside `lastName` when you need to\n * display or process name parts separately. The value is `undefined` if\n * the buyer didn't provide a first name or the store doesn't collect\n * split names.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'John'\n */\n firstName?: string;\n\n /**\n * The buyer's last name. Use this alongside `firstName` when you need to\n * display or process name parts separately. The value is `undefined` if\n * the buyer didn't provide a last name or the store doesn't collect\n * split names.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Doe'\n */\n lastName?: string;\n\n /**\n * The buyer's company name. The value is `undefined` if the buyer didn't\n * enter a company or the store doesn't collect company names.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Shopify'\n */\n company?: string;\n\n /**\n * The first line of the street address, including the street number and\n * name. The value is `undefined` if the buyer hasn't entered an address yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '151 O'Connor Street'\n */\n address1?: string;\n\n /**\n * The second line of the buyer's address, such as apartment number, suite,\n * or unit. The value is `undefined` if the buyer didn't provide a second\n * address line.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ground floor'\n */\n address2?: string;\n\n /**\n * The city, town, or village of the address. The value is `undefined` if\n * the buyer hasn't entered a city yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'Ottawa'\n */\n city?: string;\n\n /**\n * The postal code or ZIP code of the address, used for mail sorting and\n * delivery routing. The value is `undefined` if the buyer hasn't entered\n * one yet or the country doesn't use postal codes.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'K2P 2L8'\n */\n zip?: string;\n\n /**\n * The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\n * format. The value is `undefined` if the buyer hasn't selected a country\n * yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada.\n */\n countryCode?: CountryCode;\n\n /**\n * The province, state, prefecture, or region code of the address. The\n * format varies by country. The value is `undefined` if the buyer hasn't\n * selected one yet or the country doesn't have provinces.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario.\n */\n provinceCode?: string;\n\n /**\n * The phone number associated with the address, typically in international\n * format. The value is `undefined` if the buyer didn't provide a phone\n * number or the store doesn't collect phone numbers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example '+1 613 111 2222'\n */\n phone?: string;\n}" + } + }, + "CountryCode": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CountryCode", + "value": "'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ZZ'", + "description": "" + } + }, + "ShippingAddress": { + "src/surfaces/checkout/api/shared.ts": { + "filePath": "src/surfaces/checkout/api/shared.ts", + "name": "ShippingAddress", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "address1", + "value": "string", + "description": "The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'151 O'Connor Street'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "address2", + "value": "string", + "description": "The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Ground floor'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "city", + "value": "string", + "description": "The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Ottawa'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "company", + "value": "string", + "description": "The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Shopify'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "countryCode", + "value": "CountryCode", + "description": "The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'CA' for Canada.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "firstName", + "value": "string", + "description": "The buyer's first name. Use this alongside `lastName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a first name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'John'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "lastName", + "value": "string", + "description": "The buyer's last name. Use this alongside `firstName` when you need to display or process name parts separately. The value is `undefined` if the buyer didn't provide a last name or the store doesn't collect split names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Doe'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The buyer's full name, typically a combination of first and last name. The value is `undefined` if the buyer didn't provide a name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'John Doe'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "oneTimeUse", + "value": "boolean", + "description": "Controls whether the address is saved to the buyer's account. When `true`, the address won't be saved and is only used for this checkout. When `false` or `undefined`, the address might be saved to the buyer's account for future use.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "phone", + "value": "string", + "description": "The phone number associated with the address, typically in international format. The value is `undefined` if the buyer didn't provide a phone number or the store doesn't collect phone numbers.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'+1 613 111 2222'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "provinceCode", + "value": "string", + "description": "The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'ON' for Ontario.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/shared.ts", + "syntaxKind": "PropertySignature", + "name": "zip", + "value": "string", + "description": "The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'K2P 2L8'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface ShippingAddress extends MailingAddress {\n /**\n * Controls whether the address is saved to the buyer's account. When\n * `true`, the address won't be saved and is only used for this checkout.\n * When `false` or `undefined`, the address might be saved to the buyer's\n * account for future use.\n */\n oneTimeUse?: boolean;\n}" + } + }, + "AnyComponent": { + "src/surfaces/checkout/shared.ts": { + "filePath": "src/surfaces/checkout/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyComponent", + "value": "'Abbreviation' | 'Announcement' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Chat' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField'", + "description": "", + "isPublicDocs": true + } + }, + "Announcement": { + "src/surfaces/checkout/api/announcement/announcement.ts": { + "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", + "name": "Announcement", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/announcement/announcement.ts", + "syntaxKind": "PropertySignature", + "name": "announcement", + "value": "{ close(): void; addEventListener(type: \"close\", cb: () => void): void; removeEventListener(type: \"close\", cb: () => void): void; }", + "description": "" + } + ], + "value": "export interface Announcement {\n announcement: {\n close(): void;\n addEventListener(type: 'close', cb: () => void): void;\n removeEventListener(type: 'close', cb: () => void): void;\n };\n}" + } + }, + "Metafield": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Metafield", + "description": "Metadata associated with the checkout. See the [metafields documentation](/docs/apps/build/custom-data/metafields) for more information on how metafields work.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The name of the metafield.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'delivery_instructions'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "A container for a set of metafields. You need to define a custom namespace for your metafields to distinguish them from the metafields used by other apps.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'my_app'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string | number", + "description": "The information to be stored as metadata." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "valueType", + "value": "'integer' | 'string' | 'json_string'", + "description": "The metafield's information type.\n\n- `'integer'`: A whole number value.\n- `'string'`: A plain text value.\n- `'json_string'`: A JSON-encoded string value." + } + ], + "value": "export interface Metafield {\n /**\n * The name of the metafield.\n *\n * @example 'delivery_instructions'\n */\n key: string;\n\n /**\n * A container for a set of metafields. You need to define a custom\n * namespace for your metafields to distinguish them from the metafields\n * used by other apps.\n *\n * @example 'my_app'\n */\n namespace: string;\n\n /**\n * The information to be stored as metadata.\n */\n value: string | number;\n\n /**\n * The metafield's information type.\n *\n * - `'integer'`: A whole number value.\n * - `'string'`: A plain text value.\n * - `'json_string'`: A JSON-encoded string value.\n */\n valueType: 'integer' | 'string' | 'json_string';\n}" + } + }, + "AppMetafield": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "AppMetafield", + "description": "Represents a custom [metafield](/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The identifier for the metafield within its namespace, such as `'ingredients'` or `'shipping_weight'`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace that the metafield belongs to. Namespaces group related metafields and prevent naming collisions between different apps.\n\nApp owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The metafield's [type name](/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`. This is the full type identifier, whereas `valueType` is a simplified category." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value of a metafield, stored as a string regardless of the underlying type. For JSON metafields, parse the string to access structured data." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "valueType", + "value": "'boolean' | 'float' | 'integer' | 'json_string' | 'string'", + "description": "The metafield's information type.\n\n- `'boolean'`: A true or false value.\n- `'float'`: A decimal number value.\n- `'integer'`: A whole number value.\n- `'json_string'`: A JSON-encoded string value.\n- `'string'`: A plain text value." + } + ], + "value": "export interface AppMetafield {\n /**\n * The identifier for the metafield within its namespace, such as `'ingredients'` or `'shipping_weight'`.\n */\n key: string;\n\n /**\n * The namespace that the metafield belongs to. Namespaces group related metafields and prevent naming collisions between different apps.\n *\n * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace: string;\n\n /**\n * The value of a metafield, stored as a string regardless of the underlying type. For JSON metafields, parse the string to access structured data.\n */\n value: string;\n\n /**\n * The metafield's information type.\n *\n * - `'boolean'`: A true or false value.\n * - `'float'`: A decimal number value.\n * - `'integer'`: A whole number value.\n * - `'json_string'`: A JSON-encoded string value.\n * - `'string'`: A plain text value.\n */\n valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';\n\n /**\n * The metafield's [type name](/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`. This is the full type identifier, whereas `valueType` is a simplified category.\n */\n type: string;\n}" + } + }, + "CartMetafield": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartMetafield", + "description": "Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator.\n\nCart [metafields](/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The key name of a metafield, such as `'delivery_instructions'` or `'gift_message'`. Together with `namespace`, this uniquely identifies the metafield on the cart." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace for a metafield, such as `'custom'` or `'my_app'`. Together with `key`, this uniquely identifies the metafield on the cart." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The metafield's [type name](/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The string value stored in the cart metafield. Unlike `AppMetafield`, cart metafield values are always strings." + } + ], + "value": "export interface CartMetafield {\n /**\n * The key name of a metafield, such as `'delivery_instructions'` or `'gift_message'`. Together with `namespace`, this uniquely identifies the metafield on the cart.\n */\n key: string;\n\n /**\n * The namespace for a metafield, such as `'custom'` or `'my_app'`. Together with `key`, this uniquely identifies the metafield on the cart.\n */\n namespace: string;\n\n /**\n * The string value stored in the cart metafield. Unlike `AppMetafield`, cart metafield values are always strings.\n */\n value: string;\n\n /**\n * The metafield's [type name](/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`.\n */\n type: string;\n}" + } + }, + "AppMetafieldEntryTarget": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "AppMetafieldEntryTarget", + "description": "The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The globally-unique identifier of the Shopify resource, in [GID](/docs/api/usage/gids) format. Use this value to match the metafield to a specific resource in your extension or when querying the [Storefront API](/docs/api/storefront).", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/Product/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "| 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart'", + "description": "The kind of Shopify resource this metafield belongs to:\n\n- `'customer'`: The customer who placed the order.\n- `'product'`: A product in the merchant's catalog.\n- `'shop'`: The merchant's shop.\n- `'shopUser'`: A staff member or collaborator account on the shop.\n- `'variant'`: A specific variant of a product.\n- `'company'`: A [B2B](/docs/apps/build/b2b) company associated with the order.\n- `'companyLocation'`: A location belonging to a [B2B](/docs/apps/build/b2b) company.\n- `'cart'`: The cart associated with the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." + } + ], + "value": "export interface AppMetafieldEntryTarget {\n /**\n * The kind of Shopify resource this metafield belongs to:\n *\n * - `'customer'`: The customer who placed the order.\n * - `'product'`: A product in the merchant's catalog.\n * - `'shop'`: The merchant's shop.\n * - `'shopUser'`: A staff member or collaborator account on the shop.\n * - `'variant'`: A specific variant of a product.\n * - `'company'`: A [B2B](/docs/apps/build/b2b) company associated with the order.\n * - `'companyLocation'`: A location belonging to a [B2B](/docs/apps/build/b2b) company.\n * - `'cart'`: The cart associated with the checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n type:\n | 'customer'\n | 'product'\n | 'shop'\n | 'shopUser'\n | 'variant'\n | 'company'\n | 'companyLocation'\n | 'cart';\n\n /**\n * The globally-unique identifier of the Shopify resource, in [GID](/docs/api/usage/gids) format. Use this value to match the metafield to a specific resource in your extension or when querying the [Storefront API](/docs/api/storefront).\n *\n * @example 'gid://shopify/Product/123'\n */\n id: string;\n}" + } + }, + "AppMetafieldEntry": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "AppMetafieldEntry", + "description": "An entry that pairs a Shopify resource with one of its [metafields](/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "metafield", + "value": "AppMetafield", + "description": "The metafield data, including the namespace, key, value, and content type. Use the `namespace` and `key` together to uniquely identify the metafield within its resource." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "AppMetafieldEntryTarget", + "description": "The Shopify resource that this metafield is attached to, including the resource type (such as `'product'` or `'customer'`) and its globally-unique ID.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`." + } + ], + "value": "export interface AppMetafieldEntry {\n /**\n * The Shopify resource that this metafield is attached to, including the resource type (such as `'product'` or `'customer'`) and its globally-unique ID.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`.\n */\n target: AppMetafieldEntryTarget;\n\n /**\n * The metafield data, including the namespace, key, value, and content type. Use the `namespace` and `key` together to uniquely identify the metafield within its resource.\n */\n metafield: AppMetafield;\n}" + } + }, + "Version": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Version", + "value": "string", + "description": "", + "isPublicDocs": true + } + }, + "CheckoutToken": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CheckoutToken", + "value": "string", + "description": "", + "isPublicDocs": true + } + }, + "Language": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Language", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "isoCode", + "value": "string", + "description": "The [BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language tag that identifies the language. This is a standardized code that might include a base language and an optional region subtag separated by a dash. For example, `'en'` represents English and `'en-US'` represents English as used in the United States. The region subtag follows the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) standard." + } + ], + "value": "export interface Language {\n /**\n * The [BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language tag that identifies the language. This is a standardized code that might include a base language and an optional region subtag separated by a dash. For example, `'en'` represents English and `'en-US'` represents English as used in the United States. The region subtag follows the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) standard.\n */\n isoCode: string;\n}" + } + }, + "Currency": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Currency", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "isoCode", + "value": "CurrencyCode", + "description": "The three-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format, such as `'USD'`, `'EUR'`, or `'CAD'`." + } + ], + "value": "export interface Currency {\n /**\n * The three-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format, such as `'USD'`, `'EUR'`, or `'CAD'`.\n */\n isoCode: CurrencyCode;\n}" + } + }, + "CurrencyCode": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CurrencyCode", + "value": "'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'", + "description": "" + } + }, + "Market": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Market", + "description": "A [Shopify Market](/docs/apps/build/markets) that represents a group of one or more regions for international selling.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The human-readable, shop-scoped identifier for the market, such as `'us'` or `'eu'`. Merchants define these handles when configuring [Shopify Markets](/docs/apps/build/markets)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the market in the format `gid://shopify/Market/`." + } + ], + "value": "export interface Market {\n /**\n * A globally-unique identifier for the market in the format `gid://shopify/Market/`.\n */\n id: string;\n\n /**\n * The human-readable, shop-scoped identifier for the market, such as `'us'` or `'eu'`. Merchants define these handles when configuring [Shopify Markets](/docs/apps/build/markets).\n */\n handle: string;\n}" + } + }, + "LocalizedField": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "LocalizedField", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "LocalizedFieldKey", + "description": "The identifier for the localized field, indicating the type of information collected (for example, a tax credential or shipping credential for a specific country)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The localized display label for the field, suitable for rendering in the UI.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'CPF/CNPJ' for a Brazilian tax credential", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value entered by the buyer for this field." + } + ], + "value": "export interface LocalizedField {\n /**\n * The identifier for the localized field, indicating the type of information\n * collected (for example, a tax credential or shipping credential for a\n * specific country).\n */\n key: LocalizedFieldKey;\n\n /**\n * The localized display label for the field, suitable for rendering in the UI.\n *\n * @example 'CPF/CNPJ' for a Brazilian tax credential\n */\n title: string;\n\n /**\n * The current value entered by the buyer for this field.\n */\n value: string;\n}" + } + }, + "LocalizedFieldKey": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "LocalizedFieldKey", + "value": "'SHIPPING_CREDENTIAL_BR' | 'SHIPPING_CREDENTIAL_CL' | 'SHIPPING_CREDENTIAL_CN' | 'SHIPPING_CREDENTIAL_CO' | 'SHIPPING_CREDENTIAL_CR' | 'SHIPPING_CREDENTIAL_EC' | 'SHIPPING_CREDENTIAL_ES' | 'SHIPPING_CREDENTIAL_GT' | 'SHIPPING_CREDENTIAL_ID' | 'SHIPPING_CREDENTIAL_KR' | 'SHIPPING_CREDENTIAL_MY' | 'SHIPPING_CREDENTIAL_MX' | 'SHIPPING_CREDENTIAL_PE' | 'SHIPPING_CREDENTIAL_PT' | 'SHIPPING_CREDENTIAL_PY' | 'SHIPPING_CREDENTIAL_TR' | 'SHIPPING_CREDENTIAL_TW' | 'SHIPPING_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_BR' | 'TAX_CREDENTIAL_CL' | 'TAX_CREDENTIAL_CO' | 'TAX_CREDENTIAL_CR' | 'TAX_CREDENTIAL_EC' | 'TAX_CREDENTIAL_ES' | 'TAX_CREDENTIAL_GT' | 'TAX_CREDENTIAL_ID' | 'TAX_CREDENTIAL_IT' | 'TAX_CREDENTIAL_MX' | 'TAX_CREDENTIAL_MY' | 'TAX_CREDENTIAL_PE' | 'TAX_CREDENTIAL_PT' | 'TAX_CREDENTIAL_PY' | 'TAX_CREDENTIAL_TR' | 'TAX_CREDENTIAL_TYPE_CO' | 'TAX_CREDENTIAL_TYPE_MX' | 'TAX_CREDENTIAL_USE_MX' | 'TAX_EMAIL_IT'", + "description": "A union of keys for the localized fields that are required by certain countries." + } + }, + "BuyerJourney": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "BuyerJourney", + "description": "Provides details on the buyer's progression through the checkout.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "activeStep", + "value": "SubscribableSignalLike", + "description": "The step of checkout the buyer is currently on. The value is `undefined` if the current step can't be determined." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "completed", + "value": "SubscribableSignalLike", + "description": "Whether the buyer has completed submitting their order. When `true`, the buyer is on the order status page after submitting payment. When `false`, the buyer is still in the checkout flow." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "MethodSignature", + "name": "intercept", + "value": "(interceptor: Interceptor) => Promise<() => void>", + "description": "Installs a function for intercepting and preventing progress on checkout.\n\nThis returns a promise that resolves to a teardown function. Calling the teardown function removes the interceptor.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\nIf the merchant hasn't allowed your extension to block checkout progress, show a warning in the [checkout editor](/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor).", + "deprecationMessage": "Use a cart and checkout validation function instead. The buyer\njourney intercept will be removed in a future version of the API." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "steps", + "value": "SubscribableSignalLike", + "description": "All possible steps the buyer can take to complete checkout. These steps vary depending on whether the checkout is one-page or three-page, and on the shop's configuration." + } + ], + "value": "export interface BuyerJourney {\n /**\n * Installs a function for intercepting and preventing progress on checkout.\n *\n * This returns a promise that resolves to a teardown function. Calling the\n * teardown function removes the interceptor.\n *\n * To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress)\n * capability in your extension's configuration.\n *\n * If you do, then you're expected to inform the buyer why navigation was blocked,\n * either by passing validation errors to the checkout UI or rendering the errors in your extension.\n *\n * If the merchant hasn't allowed your extension to block checkout progress, show a warning in the [checkout editor](/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * @deprecated Use a cart and checkout validation function instead. The buyer\n * journey intercept will be removed in a future version of the API.\n */\n intercept(interceptor: Interceptor): Promise<() => void>;\n\n /**\n * Whether the buyer has completed submitting their order. When `true`, the buyer is on the order status page after submitting payment. When `false`, the buyer is still in the checkout flow.\n */\n completed: SubscribableSignalLike;\n /**\n * All possible steps the buyer can take to complete checkout. These steps vary depending on whether the checkout is one-page or three-page, and on the shop's configuration.\n */\n steps: SubscribableSignalLike;\n /**\n * The step of checkout the buyer is currently on. The value is `undefined` if the current step can't be determined.\n */\n activeStep: SubscribableSignalLike;\n}" + } + }, + "SubscribableSignalLike": { + "src/surfaces/checkout/shared.ts": { + "filePath": "src/surfaces/checkout/shared.ts", + "name": "SubscribableSignalLike", + "description": "Represents a reactive signal interface that provides both immediate value access and subscription-based updates. Enables real-time synchronization with changing data through the observer pattern. This interface extends `ReadonlySignalLike` with deprecated fields that are still supported for backwards compatibility.", + "members": [ + { + "filePath": "src/surfaces/checkout/shared.ts", + "syntaxKind": "PropertySignature", + "name": "current", + "value": "T", + "description": "The current value of the signal. Equivalent to `.value`, accessing this property subscribes to changes when used in a reactive context.", + "deprecationMessage": "Use `.value` instead." + }, + { + "filePath": "src/surfaces/checkout/shared.ts", + "syntaxKind": "MethodSignature", + "name": "destroy", + "value": "() => Promise", + "description": "Cleans up the subscription and releases any resources held by this signal. After calling `destroy()`, the signal stops receiving updates from the main thread.", + "deprecationMessage": "No longer needed. Use [Preact Signals](https://preactjs.com/guide/v10/signals) to manage reactive state instead." + }, + { + "filePath": "src/surfaces/checkout/shared.ts", + "syntaxKind": "MethodSignature", + "name": "subscribe", + "value": "(fn: (value: T) => void) => () => void", + "description": "Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value." + }, + { + "filePath": "src/surfaces/checkout/shared.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "T", + "description": "The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup." + } + ], + "value": "export interface SubscribableSignalLike extends ReadonlySignalLike {\n /**\n * The current value of the signal. Equivalent to `.value`, accessing this property\n * subscribes to changes when used in a reactive context.\n *\n * @deprecated Use `.value` instead.\n */\n readonly current: T;\n /**\n * Cleans up the subscription and releases any resources held by this signal. After calling\n * `destroy()`, the signal stops receiving updates from the main thread.\n *\n * @deprecated No longer needed. Use [Preact Signals](https://preactjs.com/guide/v10/signals) to manage reactive state instead.\n */\n destroy(): Promise;\n}" + } + }, + "BuyerJourneyStepReference": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "BuyerJourneyStepReference", + "description": "What step of checkout the buyer is currently on.", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "BuyerJourneyStepHandle", + "description": "The handle identifying which step the buyer is on, such as `'information'`, `'shipping'`, or `'payment'`. See `BuyerJourneyStepHandle` for all values." + } + ], + "value": "interface BuyerJourneyStepReference {\n /**\n * The handle identifying which step the buyer is on, such as `'information'`,\n * `'shipping'`, or `'payment'`. See `BuyerJourneyStepHandle` for all values.\n */\n handle: BuyerJourneyStepHandle;\n}" + } + }, + "BuyerJourneyStepHandle": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BuyerJourneyStepHandle", + "value": "'cart' | 'checkout' | 'information' | 'shipping' | 'payment' | 'review' | 'thank-you' | 'unknown'", + "description": "| handle | Description |\n|---|---|\n| `cart` | The cart page. |\n| `checkout` | A one-page checkout, including Shop Pay. |\n| `information` | The contact information step of a three-page checkout. |\n| `shipping` | The shipping step of a three-page checkout. |\n| `payment` | The payment step of a three-page checkout. |\n| `review` | The step after payment where the buyer confirms the purchase. Not all shops are configured to have a review step. |\n| `thank-you` | The page displayed after the purchase, thanking the buyer. |\n| `unknown` | An unknown step in the buyer journey. |" + } + }, + "Interceptor": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Interceptor", + "description": "A function for intercepting and preventing navigation on checkout. You can block navigation by returning an object with `{behavior: 'block', reason: 'your reason here', errors?: ValidationError[]}`. If you do, then you're expected to also update some part of your UI to reflect the reason why navigation was blocked, either by targeting checkout UI fields, passing errors to the page level, or rendering the errors in your extension.", + "isPublicDocs": true, + "params": [ + { + "name": "interceptorProps", + "description": "", + "value": "InterceptorProps", + "filePath": "src/surfaces/checkout/api/standard/standard.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "description": "", + "name": "InterceptorRequest | Promise", + "value": "InterceptorRequest | Promise" + }, + "value": "(\n interceptorProps: InterceptorProps,\n) => InterceptorRequest | Promise" + } + }, + "InterceptorProps": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "InterceptorProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canBlockProgress", + "value": "boolean", + "description": "Whether the interceptor can block the buyer's progress through checkout. When `true`, the merchant has granted your extension the `block_progress` capability. When `false`, you can still validate but can't prevent the buyer from continuing." + } + ], + "value": "export interface InterceptorProps {\n /**\n * Whether the interceptor can block the buyer's progress through checkout. When `true`, the merchant has granted your extension the `block_progress` capability. When `false`, you can still validate but can't prevent the buyer from continuing.\n */\n canBlockProgress: boolean;\n}" + } + }, + "InterceptorRequest": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "InterceptorRequest", + "value": "InterceptorRequestAllow | InterceptorRequestBlock", + "description": "", + "isPublicDocs": true + } + }, + "InterceptorRequestAllow": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "InterceptorRequestAllow", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "behavior", + "value": "'allow'", + "description": "Indicates that the interceptor allows the buyer's journey to continue." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "MethodSignature", + "name": "perform", + "value": "(result: InterceptorResult) => void | Promise", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", + "isOptional": true + } + ], + "value": "interface InterceptorRequestAllow {\n /**\n * Indicates that the interceptor allows the buyer's journey to continue.\n */\n behavior: 'allow';\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + } + }, + "InterceptorResult": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "InterceptorResult", + "value": "InterceptorResultAllow | InterceptorResultBlock", + "description": "" + } + }, + "InterceptorResultAllow": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "InterceptorResultAllow", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "behavior", + "value": "'allow'", + "description": "Indicates that the buyer was allowed to progress through checkout." + } + ], + "value": "interface InterceptorResultAllow {\n /**\n * Indicates that the buyer was allowed to progress through checkout.\n */\n behavior: 'allow';\n}" + } + }, + "InterceptorResultBlock": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "InterceptorResultBlock", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "behavior", + "value": "'block'", + "description": "Indicates that some part of the checkout UI intercepted and prevented the buyer's progress. The buyer typically needs to take some action to resolve this issue and to move on to the next step." + } + ], + "value": "interface InterceptorResultBlock {\n /**\n * Indicates that some part of the checkout UI intercepted and prevented\n * the buyer's progress. The buyer typically needs to take some action\n * to resolve this issue and to move on to the next step.\n */\n behavior: 'block';\n}" + } + }, + "InterceptorRequestBlock": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "InterceptorRequestBlock", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "behavior", + "value": "'block'", + "description": "Indicates that the interceptor blocks the buyer's journey from continuing." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "errors", + "value": "ValidationError[]", + "description": "Used to pass errors to the checkout UI, outside your extension's UI boundaries.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "MethodSignature", + "name": "perform", + "value": "(result: InterceptorResult) => void | Promise", + "description": "This callback is called when all interceptors finish. We recommend setting errors or reasons for blocking at this stage, so that all the errors in the UI show up at once.\n\nRuns after all intercept results are collected. Use it for local state updates such as setting an error flag. By the time it runs, the navigation decision is final, so blocking logic belongs in the intercept handler itself, not here.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "reason", + "value": "string", + "description": "The reason for blocking the interceptor request. This value isn't presented to the buyer, so it doesn't need to be localized. The value is used only for Shopify's own internal debugging and metrics." + } + ], + "value": "interface InterceptorRequestBlock {\n /**\n * Indicates that the interceptor blocks the buyer's journey from continuing.\n */\n behavior: 'block';\n\n /**\n * The reason for blocking the interceptor request. This value isn't presented to\n * the buyer, so it doesn't need to be localized. The value is used only for Shopify's\n * own internal debugging and metrics.\n */\n reason: string;\n\n /**\n * Used to pass errors to the checkout UI, outside your extension's UI boundaries.\n */\n errors?: ValidationError[];\n\n /**\n * This callback is called when all interceptors finish. We recommend\n * setting errors or reasons for blocking at this stage, so that all the errors in\n * the UI show up at once.\n *\n * Runs after all intercept results are collected. Use it for local state\n * updates such as setting an error flag. By the time it runs, the navigation\n * decision is final, so blocking logic belongs in the intercept handler\n * itself, not here.\n * @param result InterceptorResult with behavior as either 'allow' or 'block'\n */\n perform?(result: InterceptorResult): void | Promise;\n}" + } + }, + "BuyerJourneyStep": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "BuyerJourneyStep", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether this step is disabled. When `true`, the buyer hasn't reached this step yet and can't navigate to it. When `false`, the step is accessible.\n\nFor example, if the buyer hasn't reached the `shipping` step yet, then `shipping` is disabled." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "BuyerJourneyStepHandle", + "description": "The handle that uniquely identifies the buyer journey step, such as `'information'`, `'shipping'`, or `'payment'`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The localized label of the buyer journey step, suitable for rendering in navigation UI." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "to", + "value": "string", + "description": "The URL of the buyer journey step, using the `shopify:` protocol.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'shopify:cart'", + "title": "Example" + } + ] + }, + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'shopify:checkout/information'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface BuyerJourneyStep {\n /**\n * The handle that uniquely identifies the buyer journey step, such as `'information'`, `'shipping'`, or `'payment'`.\n */\n handle: BuyerJourneyStepHandle;\n /**\n * The localized label of the buyer journey step, suitable for rendering in navigation UI.\n */\n label: string;\n /**\n * The URL of the buyer journey step, using the `shopify:` protocol.\n *\n * @example 'shopify:cart'\n * @example 'shopify:checkout/information'\n */\n to: string;\n /**\n * Whether this step is disabled. When `true`, the buyer hasn't reached this step yet and can't navigate to it. When `false`, the step is accessible.\n *\n * For example, if the buyer hasn't reached the `shipping` step yet, then `shipping` is disabled.\n */\n disabled: boolean;\n}" + } + }, + "StandardApi": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "StandardApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "analytics", + "value": "Analytics", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "appliedGiftCards", + "value": "SubscribableSignalLike", + "description": "The gift cards that have been applied to the checkout. Each entry includes the last four characters of the gift card code, the amount used at checkout, and the card's remaining balance." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "applyTrackingConsentChange", + "value": "ApplyTrackingConsentChangeType", + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "appMetafields", + "value": "SubscribableSignalLike", + "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "SubscribableSignalLike", + "description": "The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "availablePaymentOptions", + "value": "SubscribableSignalLike", + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "billingAddress", + "value": "SubscribableSignalLike", + "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. The subscribable value is `undefined` if the billing address hasn't been provided yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "buyerIdentity", + "value": "BuyerIdentity", + "description": "Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "buyerJourney", + "value": "BuyerJourney", + "description": "Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "checkoutSettings", + "value": "SubscribableSignalLike", + "description": "Settings applied to the buyer's checkout." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "checkoutToken", + "value": "SubscribableSignalLike", + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "cost", + "value": "CartCost", + "description": "The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "customerPrivacy", + "value": "SubscribableSignalLike", + "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "deliveryGroups", + "value": "SubscribableSignalLike", + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "discountAllocations", + "value": "SubscribableSignalLike", + "description": "The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "discountCodes", + "value": "SubscribableSignalLike", + "description": "The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "Extension", + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "extensionPoint", + "value": "Target", + "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", + "deprecationMessage": "Use `extension.target` instead.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'purchase.checkout.block.render'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "instructions", + "value": "SubscribableSignalLike", + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "lines", + "value": "SubscribableSignalLike", + "description": "The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "localization", + "value": "Localization", + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "localizedFields", + "value": "SubscribableSignalLike", + "description": "Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "note", + "value": "SubscribableSignalLike", + "description": "A note left by the customer to the merchant, either in their cart or during checkout.\n\nThe value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "The method used to query the Storefront GraphQL API with a prefetched token." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "selectedPaymentOptions", + "value": "SubscribableSignalLike", + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "sessionToken", + "value": "SessionToken", + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "settings", + "value": "SubscribableSignalLike", + "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings are empty until a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "shippingAddress", + "value": "SubscribableSignalLike", + "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. When available, the subscribable value is `undefined` if delivery isn't required.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "shop", + "value": "Shop", + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "version", + "value": "Version", + "description": "The renderer version being used for the extension.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'2025-10'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface StandardApi {\n /**\n * Tracks custom events and sends visitor information to\n * [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events\n * and `visitor()` to submit buyer contact details.\n */\n analytics: Analytics;\n\n /**\n * The gift cards that have been applied to the checkout. Each entry includes\n * the last four characters of the gift card code, the amount used at\n * checkout, and the card's remaining balance.\n */\n appliedGiftCards: SubscribableSignalLike;\n\n /**\n * The cart instructions used to create the checkout and possibly limit extension capabilities.\n *\n * These instructions should be checked before performing any actions that might be affected by them.\n *\n * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method,\n * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n *\n * > Caution: Check cart instructions before calling select APIs, as\n * > some may not be available. See the\n * > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples)\n * > for more information.\n *\n */\n instructions: SubscribableSignalLike;\n\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n appMetafields: SubscribableSignalLike;\n\n /**\n * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added.\n */\n attributes: SubscribableSignalLike;\n\n /**\n * All payment options available to the buyer for this checkout, such as\n * credit cards, wallets, and local payment methods. The list depends on\n * the shop's payment configuration and the buyer's region.\n *\n * The set of payment options can change when the buyer updates their\n * address or cart, so subscribe to changes rather than reading once\n * during initialization. Each option exposes `handle` and `type` only.\n * Provider names, logos, fees, and installment terms aren't available.\n */\n availablePaymentOptions: SubscribableSignalLike;\n\n /**\n * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n buyerIdentity?: BuyerIdentity;\n\n /**\n * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues.\n */\n buyerJourney: BuyerJourney;\n\n /**\n * Settings applied to the buyer's checkout.\n */\n checkoutSettings: SubscribableSignalLike;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * The value is `undefined` when the checkout hasn't been created on the server yet.\n *\n * Use this to correlate checkout sessions across your extension, web pixels, and backend systems.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n *\n * Can be `undefined`. Handle the `undefined` state before using the value.\n */\n checkoutToken: SubscribableSignalLike;\n\n /**\n * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated.\n */\n cost: CartCost;\n\n /**\n * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n *\n * Empty until the buyer enters enough address information for Shopify to\n * calculate shipping rates.\n */\n deliveryGroups: SubscribableSignalLike;\n\n /**\n * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes.\n */\n discountCodes: SubscribableSignalLike;\n\n /**\n * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered.\n */\n discountAllocations: SubscribableSignalLike;\n\n /**\n * Metadata about the running extension, including the current target, API version,\n * capabilities, and editor context. Use this to conditionally render content\n * based on where the extension is running.\n */\n extension: Extension;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n *\n * @deprecated Use `extension.target` instead.\n */\n extensionPoint: Target;\n\n /**\n * Utilities for translating strings, formatting currencies, numbers, and dates\n * according to the buyer's locale. Use alongside\n * [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization)\n * to build fully localized extensions.\n */\n i18n: I18n;\n\n /**\n * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items.\n */\n lines: SubscribableSignalLike;\n\n /**\n * The buyer's language, country, currency, and timezone context. For\n * formatting and translation helpers, use the\n * [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * A note left by the customer to the merchant, either in their cart or during checkout.\n *\n * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages.\n */\n note: SubscribableSignalLike;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The payment options the buyer has currently selected. This updates as\n * the buyer changes their payment method. The array can contain multiple\n * entries when the buyer splits payment across methods (for example, a\n * gift card and a credit card).\n *\n * Each option exposes `handle` and `type` only. Provider names, logos,\n * fees, and installment terms aren't available.\n */\n selectedPaymentOptions: SubscribableSignalLike;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of five minutes.\n *\n * If the previous token expires, this value reflects a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n *\n * > Note: When an extension is being installed in the editor, the settings are empty until\n * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings.\n */\n settings: SubscribableSignalLike;\n\n /**\n * The proposed customer shipping address. During the information step, the address\n * updates when the field is committed (on change) rather than every keystroke.\n * The property is available only if the extension has access to protected customer\n * data. When available, the subscribable value is `undefined` if delivery isn't required.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: SubscribableSignalLike;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke. The property is available only\n * if the extension has access to protected customer data. The subscribable value is\n * `undefined` if the billing address hasn't been provided yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: SubscribableSignalLike;\n\n /**\n * The store where the checkout is taking place, including the shop name,\n * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.\n */\n shop: Shop;\n\n /**\n * Key-value storage that persists across page loads within the current checkout\n * session. Data is shared across all activated targets associated with\n * this extension.\n *\n * > Caution: Data persistence isn't guaranteed and storage is cleared when the\n * buyer starts a new checkout.\n */\n storage: Storage;\n\n /**\n * The renderer version being used for the extension.\n *\n * @example '2025-10'\n */\n version: Version;\n\n /**\n * Customer privacy consent settings and a flag denoting if consent has previously been collected.\n */\n customerPrivacy: SubscribableSignalLike;\n\n /**\n * Enables setting and updating customer privacy consent settings and tracking consent metafields.\n *\n * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyTrackingConsentChange: ApplyTrackingConsentChangeType;\n\n /**\n * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.\n */\n localizedFields?: SubscribableSignalLike;\n}" + } + }, + "Analytics": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Analytics", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details.", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "MethodSignature", + "name": "publish", + "value": "(name: string, data: Record) => Promise", + "description": "Publishes a custom event to [Web Pixels](/docs/apps/marketing). Returns `true` when the event is successfully dispatched.\n\nThe Promise resolves to `true` when the event was dispatched. The boolean indicates dispatch confirmation only. It doesn't indicate whether any specific web pixel processed the event." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "MethodSignature", + "name": "visitor", + "value": "(data: { email?: string; phone?: string; }) => Promise", + "description": "Submits buyer contact details for attribution and analytics purposes." + } + ], + "value": "export interface Analytics {\n /**\n * Publishes a custom event to [Web Pixels](/docs/apps/marketing).\n * Returns `true` when the event is successfully dispatched.\n *\n * The Promise resolves to `true` when the event was dispatched. The boolean\n * indicates dispatch confirmation only. It doesn't indicate whether any\n * specific web pixel processed the event.\n */\n publish(name: string, data: Record): Promise;\n\n /**\n * Submits buyer contact details for attribution and analytics purposes.\n */\n visitor(data: {email?: string; phone?: string}): Promise;\n}" + } + }, + "VisitorResult": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "VisitorResult", + "value": "VisitorSuccess | VisitorError", + "description": "Represents a visitor result.", + "isPublicDocs": true + } + }, + "VisitorSuccess": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "VisitorSuccess", + "description": "Represents a successful visitor result.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the visitor information was validated and submitted." + } + ], + "value": "export interface VisitorSuccess {\n /**\n * Indicates that the visitor information was validated and submitted.\n */\n type: 'success';\n}" + } + }, + "VisitorError": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "VisitorError", + "description": "Represents an unsuccessful visitor result.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the visitor information is invalid and wasn't submitted. Common causes include using the wrong data type or omitting a required property." + } + ], + "value": "export interface VisitorError {\n /**\n * Indicates that the visitor information is invalid and wasn't submitted.\n * Common causes include using the wrong data type or omitting a required property.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + } + }, + "AppliedGiftCard": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "AppliedGiftCard", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "amountUsed", + "value": "Money", + "description": "The amount of the applied gift card that's used when the checkout is completed. This might be less than `balance` if the order total is lower than the card's remaining balance." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "balance", + "value": "Money", + "description": "The current balance of the applied gift card before checkout completion. This reflects the full remaining value on the card, not just the amount being applied to this order." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "lastCharacters", + "value": "string", + "description": "The last four characters of the applied gift card's code. The full code isn't exposed for security reasons. Use this value to display which card is applied." + } + ], + "value": "export interface AppliedGiftCard {\n /**\n * The last four characters of the applied gift card's code. The full code isn't exposed for security reasons. Use this value to display which card is applied.\n */\n lastCharacters: string;\n\n /**\n * The amount of the applied gift card that's used when the checkout is completed. This might be less than `balance` if the order total is lower than the card's remaining balance.\n */\n amountUsed: Money;\n\n /**\n * The current balance of the applied gift card before checkout completion. This reflects the full remaining value on the card, not just the amount being applied to this order.\n */\n balance: Money;\n}" + } + }, + "Money": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Money", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "amount", + "value": "number", + "description": "The decimal amount of the price. For example, `29.99` represents twenty-nine dollars and ninety-nine cents." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "currencyCode", + "value": "CurrencyCode", + "description": "The three-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'CAD' for Canadian dollar", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface Money {\n /**\n * The decimal amount of the price. For example, `29.99` represents twenty-nine dollars and ninety-nine cents.\n */\n amount: number;\n /**\n * The three-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.\n *\n * @example 'CAD' for Canadian dollar\n */\n currencyCode: CurrencyCode;\n}" + } + }, + "ApplyTrackingConsentChangeType": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "ApplyTrackingConsentChangeType", + "description": "", + "isPublicDocs": true, + "params": [ + { + "name": "visitorConsent", + "description": "", + "value": "VisitorConsentChange", + "filePath": "src/surfaces/checkout/api/standard/standard.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "description": "", + "name": "Promise", + "value": "Promise" + }, + "value": "(\n visitorConsent: VisitorConsentChange,\n) => Promise" + } + }, + "VisitorConsentChange": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "VisitorConsentChange", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "analytics", + "value": "boolean", + "description": "The visitor's consent for analytics tracking. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "marketing", + "value": "boolean", + "description": "The visitor's consent for marketing and targeted advertising. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "TrackingConsentMetafieldChange[]", + "description": "Tracking consent metafield data to be saved.\n\nIf the value is `null`, the metafield is deleted.", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "preferences", + "value": "boolean", + "description": "The visitor's consent for storing preferences such as language and currency. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "saleOfData", + "value": "boolean", + "description": "The visitor's consent for the sale or sharing of their personal data with third parties. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'changeVisitorConsent'", + "description": "Identifies this as a visitor consent change. This is the only supported change type for `applyTrackingConsentChange()`." + } + ], + "value": "export interface VisitorConsentChange extends VisitorConsent {\n /**\n * Tracking consent metafield data to be saved.\n *\n * If the value is `null`, the metafield is deleted.\n *\n * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]`\n */\n metafields?: TrackingConsentMetafieldChange[];\n /**\n * Identifies this as a visitor consent change. This is the only supported change type for `applyTrackingConsentChange()`.\n */\n type: 'changeVisitorConsent';\n}" + } + }, + "TrackingConsentMetafieldChange": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "TrackingConsentMetafieldChange", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The identifier for the tracking consent metafield to update." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string | null", + "description": "The new value to store in the metafield. Set to `null` to delete the metafield.\n\nConsent metafield values are strings, not booleans. Pass `null` to delete a tracking consent metafield." + } + ], + "value": "export interface TrackingConsentMetafieldChange {\n /**\n * The identifier for the tracking consent metafield to update.\n */\n key: string;\n /**\n * The new value to store in the metafield. Set to `null` to delete the metafield.\n *\n * Consent metafield values are strings, not booleans. Pass `null` to delete\n * a tracking consent metafield.\n */\n value: string | null;\n}" + } + }, + "VisitorConsent": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "VisitorConsent", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "analytics", + "value": "boolean", + "description": "The visitor's consent for analytics tracking. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "marketing", + "value": "boolean", + "description": "The visitor's consent for marketing and targeted advertising. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "preferences", + "value": "boolean", + "description": "The visitor's consent for storing preferences such as language and currency. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "saleOfData", + "value": "boolean", + "description": "The visitor's consent for the sale or sharing of their personal data with third parties. `true` means the visitor actively granted consent, `false` means actively denied, and `undefined` means no decision has been made yet.", + "isOptional": true + } + ], + "value": "export interface VisitorConsent {\n /**\n * The visitor's consent for analytics tracking. `true` means the visitor\n * actively granted consent, `false` means actively denied, and `undefined`\n * means no decision has been made yet.\n */\n analytics?: boolean;\n /**\n * The visitor's consent for marketing and targeted advertising. `true` means\n * the visitor actively granted consent, `false` means actively denied, and\n * `undefined` means no decision has been made yet.\n */\n marketing?: boolean;\n /**\n * The visitor's consent for storing preferences such as language and currency.\n * `true` means the visitor actively granted consent, `false` means actively\n * denied, and `undefined` means no decision has been made yet.\n */\n preferences?: boolean;\n /**\n * The visitor's consent for the sale or sharing of their personal data with\n * third parties. `true` means the visitor actively granted consent, `false`\n * means actively denied, and `undefined` means no decision has been made yet.\n */\n saleOfData?: boolean;\n}" + } + }, + "TrackingConsentChangeResult": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "TrackingConsentChangeResult", + "value": "TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError", + "description": "", + "isPublicDocs": true + } + }, + "TrackingConsentChangeResultSuccess": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "TrackingConsentChangeResultSuccess", + "description": "The returned result of a successful tracking consent preference update.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the tracking consent update was applied successfully." + } + ], + "value": "export interface TrackingConsentChangeResultSuccess {\n /**\n * Indicates that the tracking consent update was applied successfully.\n */\n type: 'success';\n}" + } + }, + "TrackingConsentChangeResultError": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "TrackingConsentChangeResultError", + "description": "The returned result of an unsuccessful tracking consent preference update with a message detailing the type of error that occurred.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the tracking consent update couldn't be applied. Check the `message` property for details." + } + ], + "value": "export interface TrackingConsentChangeResultError {\n /**\n * Indicates that the tracking consent update couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + } + }, + "PaymentOption": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "PaymentOption", + "description": "A payment option presented to the buyer.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "A session-scoped identifier for this payment option. This handle isn't globally unique; it's specific to the current checkout session or the shop." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", + "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are available only to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, or Apple Pay. |\n| `customOnsite` | A custom payment option that's processed through a checkout extension with a payments app. |" + } + ], + "value": "export interface PaymentOption {\n /**\n * The type of the payment option.\n *\n * Shops can be configured to support many different payment options. Some options are available only to buyers in specific regions.\n *\n * | Type | Description |\n * |---|---|\n * | `creditCard` | A vaulted or manually entered credit card. |\n * | `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n * | `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n * | `manualPayment` | A manual payment option such as an in-person retail transaction. |\n * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n * | `other` | Another type of payment not defined here. |\n * | `paymentOnDelivery` | A payment collected on delivery. |\n * | `redeemable` | A redeemable payment option such as a gift card or store credit. |\n * | `wallet` | An integrated wallet such as PayPal, Google Pay, or Apple Pay. |\n * | `customOnsite` | A custom payment option that's processed through a checkout extension with a payments app. |\n */\n type:\n | 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite';\n\n /**\n * A session-scoped identifier for this payment option. This handle isn't globally unique; it's specific to the current checkout session or the shop.\n */\n handle: string;\n}" + } + }, + "BuyerIdentity": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "BuyerIdentity", + "description": "Information about the buyer who is completing the checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "customer", + "value": "SubscribableSignalLike", + "description": "The buyer's customer account, including their ID and whether they've accepted marketing. The value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "email", + "value": "SubscribableSignalLike", + "description": "The email address the buyer provided during checkout. The value is `undefined` if the app doesn't have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "phone", + "value": "SubscribableSignalLike", + "description": "The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "purchasingCompany", + "value": "SubscribableSignalLike", + "description": "The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + } + ], + "value": "export interface BuyerIdentity {\n /**\n * The buyer's customer account, including their ID and whether they've accepted marketing. The value is `undefined` if the buyer isn't a\n * known customer for this shop or if they haven't logged in yet.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n customer: SubscribableSignalLike;\n\n /**\n * The email address the buyer provided during checkout. The value is `undefined` if the app doesn't have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email: SubscribableSignalLike;\n\n /**\n * The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone: SubscribableSignalLike;\n\n /**\n * The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n purchasingCompany: SubscribableSignalLike;\n}" + } + }, + "Customer": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Customer", + "description": "Information about a customer who has previously purchased from this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "acceptsEmailMarketing", + "value": "boolean", + "description": "Whether the customer has opted in to email marketing.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "acceptsMarketing", + "value": "boolean", + "description": "Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.", + "deprecationMessage": "Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "acceptsSmsMarketing", + "value": "boolean", + "description": "Whether the customer has opted in to SMS marketing.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "email", + "value": "string", + "description": "The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "firstName", + "value": "string", + "description": "The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "fullName", + "value": "string", + "description": "The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/Customer/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "ImageDetails", + "description": "The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "lastName", + "value": "string", + "description": "The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "ordersCount", + "value": "number", + "description": "The number of orders the customer has previously placed with this shop.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "phone", + "value": "string", + "description": "The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "storeCreditAccounts", + "value": "StoreCreditAccount[]", + "description": "The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isPrivate": true + } + ], + "value": "export interface Customer {\n /**\n * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Customer/123'\n */\n id: string;\n /**\n * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n email?: string;\n /**\n * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n phone?: string;\n /**\n * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n fullName?: string;\n /**\n * The customer's first name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n firstName?: string;\n /**\n * The customer's last name. The value is `undefined` if the app doesn't have the required access level.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n lastName?: string;\n /**\n * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n image: ImageDetails;\n /**\n * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n *\n * @deprecated Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead.\n */\n acceptsMarketing: boolean;\n /**\n * Whether the customer has opted in to email marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsEmailMarketing: boolean;\n /**\n * Whether the customer has opted in to SMS marketing.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n acceptsSmsMarketing: boolean;\n /**\n * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @private\n */\n storeCreditAccounts: StoreCreditAccount[];\n /**\n * The number of orders the customer has previously placed with this shop.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n ordersCount: number;\n}" + } + }, + "ImageDetails": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "ImageDetails", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "altText", + "value": "string", + "description": "The alternative text for the image, used for accessibility. The value is `undefined` if the merchant hasn't provided alt text.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "url", + "value": "string", + "description": "The fully-qualified URL of the image. Use this to render the product or variant image in your extension." + } + ], + "value": "export interface ImageDetails {\n /**\n * The fully-qualified URL of the image. Use this to render the product or variant image in your extension.\n */\n url: string;\n\n /**\n * The alternative text for the image, used for accessibility. The value is `undefined` if the merchant hasn't provided alt text.\n */\n altText?: string;\n}" + } + }, + "StoreCreditAccount": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "StoreCreditAccount", + "description": "A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "balance", + "value": "Money", + "description": "The remaining balance available in this store credit account. This reflects the amount that can still be applied toward purchases." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the store credit account in the format `gid://shopify/StoreCreditAccount/`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/StoreCreditAccount/1'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface StoreCreditAccount {\n /**\n * A globally-unique identifier for the store credit account in the format `gid://shopify/StoreCreditAccount/`.\n *\n * @example 'gid://shopify/StoreCreditAccount/1'\n */\n id: string;\n /**\n * The remaining balance available in this store credit account. This reflects the amount that can still be applied toward purchases.\n */\n balance: Money;\n}" + } + }, + "PurchasingCompany": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "PurchasingCompany", + "description": "The company and location that the [B2B](/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "company", + "value": "Company", + "description": "The company the B2B customer belongs to.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "location", + "value": "CompanyLocation", + "description": "The specific company location associated with this B2B purchase.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + } + ], + "value": "export interface PurchasingCompany {\n /**\n * The company the B2B customer belongs to.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n company: Company;\n /**\n * The specific company location associated with this B2B purchase.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n location: CompanyLocation;\n}" + } + }, + "Company": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Company", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "externalId", + "value": "string", + "description": "A merchant-defined external identifier for the company. The value is `undefined` if the merchant hasn't set one.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/Company/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The company's display name.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + } + ], + "value": "export interface Company {\n /**\n * A globally-unique identifier for the company in the format `gid://shopify/Company/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/Company/123'\n */\n id: string;\n /**\n * The company's display name.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company. The value is `undefined` if the merchant hasn't set one.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" + } + }, + "CompanyLocation": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CompanyLocation", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "externalId", + "value": "string", + "description": "A merchant-defined external identifier for the company location. The value is `undefined` if the merchant hasn't set one.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/CompanyLocation/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The display name of the company location.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + } + ], + "value": "export interface CompanyLocation {\n /**\n * A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'gid://shopify/CompanyLocation/123'\n */\n id: string;\n /**\n * The display name of the company location.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n name: string;\n /**\n * A merchant-defined external identifier for the company location. The value is `undefined` if the merchant hasn't set one.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n externalId?: string;\n}" + } + }, + "CheckoutSettings": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CheckoutSettings", + "description": "Settings describing the behavior of the buyer's checkout.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "orderSubmission", + "value": "'DRAFT_ORDER' | 'ORDER'", + "description": "The type of order created when the buyer completes checkout.\n\n- `'DRAFT_ORDER'`: The checkout creates a draft order that the merchant must manually confirm before fulfillment. Common for B2B checkouts with deferred payment terms.\n- `'ORDER'`: The checkout creates a confirmed order immediately upon completion." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "paymentTermsTemplate", + "value": "PaymentTermsTemplate", + "description": "The payment terms configured by the merchant for B2B orders, such as net-30 or net-60. The value is `undefined` if no payment terms are configured.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "shippingAddress", + "value": "ShippingAddressSettings", + "description": "Settings that control how the shipping address behaves during checkout, such as whether the buyer can edit the address." + } + ], + "value": "export interface CheckoutSettings {\n /**\n * The type of order created when the buyer completes checkout.\n *\n * - `'DRAFT_ORDER'`: The checkout creates a draft order that the merchant must manually confirm before fulfillment. Common for B2B checkouts with deferred payment terms.\n * - `'ORDER'`: The checkout creates a confirmed order immediately upon completion.\n */\n orderSubmission: 'DRAFT_ORDER' | 'ORDER';\n /**\n * The payment terms configured by the merchant for B2B orders, such as net-30 or net-60. The value is `undefined` if no payment terms are configured.\n */\n paymentTermsTemplate?: PaymentTermsTemplate;\n /**\n * Settings that control how the shipping address behaves during checkout, such as whether the buyer can edit the address.\n */\n shippingAddress: ShippingAddressSettings;\n}" + } + }, + "PaymentTermsTemplate": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "PaymentTermsTemplate", + "description": "A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include \"Net 30\" (due in 30 days) or \"Due on receipt\".", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "dueDate", + "value": "string", + "description": "The due date for payment in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ss.sssZ`). The value is `undefined` if the payment terms don't have a fixed due date.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "dueInDays", + "value": "number", + "description": "The number of days the buyer has to pay after the order is placed, such as `30` for \"Net 30\" terms. The value is `undefined` if the payment terms aren't net-based.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the payment terms template in the format `gid://shopify/PaymentTermsTemplate/`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/PaymentTermsTemplate/1'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name of the payment terms translated to the buyer's current language, such as \"Net 30\" or \"Due on receipt\"." + } + ], + "value": "export interface PaymentTermsTemplate {\n /**\n * A globally-unique identifier for the payment terms template in the format `gid://shopify/PaymentTermsTemplate/`.\n *\n * @example 'gid://shopify/PaymentTermsTemplate/1'\n */\n id: string;\n /**\n * The name of the payment terms translated to the buyer's current language, such as \"Net 30\" or \"Due on receipt\".\n */\n name: string;\n /**\n * The due date for payment in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ss.sssZ`). The value is `undefined` if the payment terms don't have a fixed due date.\n */\n dueDate?: string;\n /**\n * The number of days the buyer has to pay after the order is placed, such as `30` for \"Net 30\" terms. The value is `undefined` if the payment terms aren't net-based.\n */\n dueInDays?: number;\n}" + } + }, + "ShippingAddressSettings": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "ShippingAddressSettings", + "description": "Settings describing the behavior of the shipping address.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "isEditable", + "value": "boolean", + "description": "Whether the buyer is allowed to edit the shipping address during checkout. When `false`, the shipping address is locked and can't be changed, which is common for B2B orders with a predefined ship-to address." + } + ], + "value": "export interface ShippingAddressSettings {\n /**\n * Whether the buyer is allowed to edit the shipping address during checkout. When `false`, the shipping address is locked and can't be changed, which is common for B2B orders with a predefined ship-to address.\n */\n isEditable: boolean;\n}" + } + }, + "CartCost": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartCost", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "subtotalAmount", + "value": "SubscribableSignalLike", + "description": "The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "totalAmount", + "value": "SubscribableSignalLike", + "description": "The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "totalShippingAmount", + "value": "SubscribableSignalLike", + "description": "The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n\n`undefined` until the buyer selects a shipping method (typically after the information step)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "totalTaxAmount", + "value": "SubscribableSignalLike", + "description": "The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n\n`undefined` when taxes haven't been calculated or aren't available for the buyer's region." + } + ], + "value": "export interface CartCost {\n /**\n * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased.\n */\n subtotalAmount: SubscribableSignalLike;\n\n /**\n * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step.\n *\n * `undefined` until the buyer selects a shipping method (typically after the\n * information step).\n */\n totalShippingAmount: SubscribableSignalLike;\n\n /**\n * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet.\n *\n * `undefined` when taxes haven't been calculated or aren't available for the\n * buyer's region.\n */\n totalTaxAmount: SubscribableSignalLike;\n\n /**\n * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total.\n */\n totalAmount: SubscribableSignalLike;\n}" + } + }, + "CustomerPrivacy": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CustomerPrivacy", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "allowedProcessing", + "value": "AllowedProcessing", + "description": "Flags indicating whether each type of data processing is permitted, based on the visitor's consent, the merchant's privacy configuration, and the visitor's geographic location." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "TrackingConsentMetafield[]", + "description": "The tracking consent metafields that have been stored for this visitor. These contain app-specific consent data beyond the standard categories.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "region", + "value": "CustomerPrivacyRegion", + "description": "The visitor's geographic location, used to determine whether more granular consent controls should be displayed based on regional privacy regulations.", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "saleOfDataRegion", + "value": "boolean", + "description": "Whether the visitor is located in a region that requires an explicit opt-out option for the sale or sharing of personal data, such as California (CCPA) or other jurisdictions with similar regulations." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "shouldShowBanner", + "value": "boolean", + "description": "Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n\nThis is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "visitorConsent", + "value": "VisitorConsent", + "description": "The visitor's current privacy consent settings. Each property represents a consent category and is `true` (actively granted), `false` (actively denied), or `undefined` (no decision made yet)." + } + ], + "value": "export interface CustomerPrivacy {\n /**\n * Flags indicating whether each type of data processing is permitted, based on the visitor's consent, the merchant's privacy configuration, and the visitor's geographic location.\n */\n allowedProcessing: AllowedProcessing;\n /**\n * The tracking consent metafields that have been stored for this visitor. These contain app-specific consent data beyond the standard categories.\n *\n * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]`\n */\n metafields: TrackingConsentMetafield[];\n /**\n * The visitor's current privacy consent settings. Each property represents a consent category and is `true` (actively granted), `false` (actively denied), or `undefined` (no decision made yet).\n */\n visitorConsent: VisitorConsent;\n /**\n * Whether a consent banner should be displayed by default when the page loads. Use this as the initial open/expanded state of the consent banner.\n *\n * This is determined by the visitor's current privacy consent, the shop's [region visibility configuration](https://help.shopify.com/en/manual/privacy-and-security/privacy/customer-privacy-settings/privacy-settings#add-a-cookie-banner) settings, and the region in which the visitor is located.\n */\n shouldShowBanner: boolean;\n /**\n * Whether the visitor is located in a region that requires an explicit opt-out option for the sale or sharing of personal data, such as California (CCPA) or other jurisdictions with similar regulations.\n */\n saleOfDataRegion: boolean;\n /**\n * The visitor's geographic location, used to determine whether more granular consent controls should be displayed based on regional privacy regulations.\n *\n * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n region?: CustomerPrivacyRegion;\n}" + } + }, + "AllowedProcessing": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "AllowedProcessing", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "analytics", + "value": "boolean", + "description": "Whether analytics data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Analytics data includes how the shop was used and what interactions occurred.\n\nWhether analytics data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.analytics`, before calling `shopify.analytics.publish()`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "marketing", + "value": "boolean", + "description": "Whether marketing data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Marketing data includes attribution and targeted advertising preferences.\n\nWhether marketing data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.marketing`, before performing marketing-related data collection." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "preferences", + "value": "boolean", + "description": "Whether preference data can be collected based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. Preference data includes language, currency, and sizing choices.\n\nWhether preference data can be collected right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.preferences`, before storing or reading buyer preference data." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "saleOfData", + "value": "boolean", + "description": "Whether data can be shared with third parties based on the visitor's consent, the merchant's privacy configuration, and the visitor's region. This typically applies to behavioral advertising data.\n\nWhether buyer data can be shared with or sold to third parties right now. Combines the buyer's consent, the merchant's privacy configuration, and the buyer's region into a single boolean. Check this flag, not `visitorConsent.saleOfData`, before sharing or selling buyer data with third parties." + } + ], + "value": "export interface AllowedProcessing {\n /**\n * Whether analytics data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Analytics\n * data includes how the shop was used and what interactions occurred.\n *\n * Whether analytics data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.analytics`, before\n * calling `shopify.analytics.publish()`.\n */\n analytics: boolean;\n /**\n * Whether marketing data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Marketing\n * data includes attribution and targeted advertising preferences.\n *\n * Whether marketing data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.marketing`, before\n * performing marketing-related data collection.\n */\n marketing: boolean;\n /**\n * Whether preference data can be collected based on the visitor's consent,\n * the merchant's privacy configuration, and the visitor's region. Preference\n * data includes language, currency, and sizing choices.\n *\n * Whether preference data can be collected right now. Combines the buyer's\n * consent, the merchant's privacy configuration, and the buyer's region into\n * a single boolean. Check this flag, not `visitorConsent.preferences`,\n * before storing or reading buyer preference data.\n */\n preferences: boolean;\n /**\n * Whether data can be shared with third parties based on the visitor's\n * consent, the merchant's privacy configuration, and the visitor's region.\n * This typically applies to behavioral advertising data.\n *\n * Whether buyer data can be shared with or sold to third parties right now.\n * Combines the buyer's consent, the merchant's privacy configuration, and\n * the buyer's region into a single boolean. Check this flag, not\n * `visitorConsent.saleOfData`, before sharing or selling buyer data with\n * third parties.\n */\n saleOfData: boolean;\n}" + } + }, + "TrackingConsentMetafield": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "TrackingConsentMetafield", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The identifier for the tracking consent metafield, such as `'analyticsType'` or `'marketingType'`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value stored in the tracking consent metafield, such as `'granular'` or a stringified JSON object." + } + ], + "value": "export interface TrackingConsentMetafield {\n /**\n * The identifier for the tracking consent metafield, such as `'analyticsType'` or `'marketingType'`.\n */\n key: string;\n /**\n * The value stored in the tracking consent metafield, such as `'granular'` or a stringified JSON object.\n */\n value: string;\n}" + } + }, + "CustomerPrivacyRegion": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CustomerPrivacyRegion", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "countryCode", + "value": "CountryCode", + "description": "The buyer's country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if geolocation failed.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'CA' for Canada, 'US' for United States, 'GB' for Great Britain", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "provinceCode", + "value": "string", + "description": "The buyer's province, state, or region code in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. The value is `undefined` if geolocation failed or only the country was detected.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'ON' for Ontario, 'ENG' for England, 'CA' for California", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface CustomerPrivacyRegion {\n /**\n * The buyer's country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if geolocation failed.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain\n */\n countryCode?: CountryCode;\n /**\n * The buyer's province, state, or region code in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. The value is `undefined` if geolocation failed or only the country was detected.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California\n */\n provinceCode?: string;\n}" + } + }, + "DeliveryGroup": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "DeliveryGroup", + "description": "A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "deliveryOptions", + "value": "DeliveryOption[]", + "description": "The delivery options available for this group, including shipping, pickup point, and pickup location options. The buyer selects one of these to determine how their items are delivered." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "groupType", + "value": "DeliveryGroupType", + "description": "Whether this group contains items for a one-time purchase or a subscription. Subscription delivery groups might have different shipping options. See `DeliveryGroupType` for possible values." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the delivery group. The value is `undefined` if the underlying delivery line doesn't have an ID assigned.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "isDeliveryRequired", + "value": "boolean", + "description": "Whether physical delivery is required for the items in this group. Digital-only groups don't require delivery." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "selectedDeliveryOption", + "value": "DeliveryOptionReference", + "description": "The delivery option the buyer has selected for this group. The value is `undefined` if the buyer hasn't selected a delivery option yet. Contains a `handle` you can match against `deliveryOptions` entries.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "targetedCartLines", + "value": "CartLineReference[]", + "description": "The cart lines that belong to this delivery group. Each reference contains the cart line's `id`, which you can match against `lines` to get the full cart line details." + } + ], + "value": "export interface DeliveryGroup {\n /**\n * A unique identifier for the delivery group. The value is `undefined` if the underlying delivery line doesn't have an ID assigned.\n */\n id?: string;\n /**\n * The cart lines that belong to this delivery group. Each reference contains the cart line's `id`, which you can match against `lines` to get the full cart line details.\n */\n targetedCartLines: CartLineReference[];\n\n /**\n * The delivery options available for this group, including shipping, pickup point, and pickup location options. The buyer selects one of these to determine how their items are delivered.\n */\n deliveryOptions: DeliveryOption[];\n\n /**\n * The delivery option the buyer has selected for this group. The value is `undefined` if the buyer hasn't selected a delivery option yet. Contains a `handle` you can match against `deliveryOptions` entries.\n */\n selectedDeliveryOption?: DeliveryOptionReference;\n\n /**\n * Whether this group contains items for a one-time purchase or a subscription.\n * Subscription delivery groups might have different shipping options. See `DeliveryGroupType` for possible values.\n */\n groupType: DeliveryGroupType;\n\n /**\n * Whether physical delivery is required for the items in this group.\n * Digital-only groups don't require delivery.\n */\n isDeliveryRequired: boolean;\n}" + } + }, + "DeliveryOption": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DeliveryOption", + "value": "ShippingOption | PickupPointOption | PickupLocationOption", + "description": "A delivery option available to the buyer. Use the `type` property to determine which kind of option it is:\n\n- `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant.\n- `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up.\n- `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse.", + "isPublicDocs": true + } + }, + "ShippingOption": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "ShippingOption", + "description": "Represents a delivery option that's a shipping option.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "carrier", + "value": "ShippingOptionCarrier", + "description": "Information about the carrier providing this shipping option, including the carrier's display name." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The carrier service code or rate identifier for this delivery option." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "cost", + "value": "Money", + "description": "The cost of this delivery option before any shipping discounts are applied. Compare with `costAfterDiscounts` to show savings." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "costAfterDiscounts", + "value": "Money", + "description": "The cost of this delivery option after shipping discounts have been applied. This is the price the buyer actually pays for shipping." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "deliveryEstimate", + "value": "DeliveryEstimate", + "description": "The estimated delivery time for this shipping option. Use the `timeInTransit` range to display an estimated arrival window to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "Additional details about the delivery option provided by the carrier or merchant, such as estimated delivery windows or service level notes.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The unique identifier of the delivery option. Use this to match against `DeliveryOptionReference.handle` or `DeliverySelectionGroup` entries." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The merchant-facing or carrier-provided display name for the delivery option, such as \"Standard Shipping\" or \"Express\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'shipping' | 'local'", + "description": "Identifies the delivery method. `'shipping'` means items are shipped by a carrier. `'local'` means the merchant handles delivery themselves, for example same-day local delivery." + } + ], + "value": "export interface ShippingOption extends DeliveryOptionBase {\n /**\n * Identifies the delivery method. `'shipping'` means items are shipped by a carrier. `'local'` means the merchant handles delivery themselves, for example same-day local delivery.\n */\n type: 'shipping' | 'local';\n\n /**\n * Information about the carrier providing this shipping option, including the carrier's display name.\n */\n carrier: ShippingOptionCarrier;\n\n /**\n * The cost of this delivery option before any shipping discounts are applied. Compare with `costAfterDiscounts` to show savings.\n */\n cost: Money;\n\n /**\n * The cost of this delivery option after shipping discounts have been applied. This is the price the buyer actually pays for shipping.\n */\n costAfterDiscounts: Money;\n\n /**\n * The estimated delivery time for this shipping option. Use the `timeInTransit` range to display an estimated arrival window to the buyer.\n */\n deliveryEstimate: DeliveryEstimate;\n}" + } + }, + "ShippingOptionCarrier": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "ShippingOptionCarrier", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The display name of the shipping carrier, such as \"Canada Post\" or \"UPS\". The value is `undefined` if the carrier name isn't available.", + "isOptional": true + } + ], + "value": "export interface ShippingOptionCarrier {\n /**\n * The display name of the shipping carrier, such as \"Canada Post\" or \"UPS\". The value is `undefined` if the carrier name isn't available.\n */\n name?: string;\n}" + } + }, + "DeliveryEstimate": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "DeliveryEstimate", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "timeInTransit", + "value": "NumberRange", + "description": "The estimated time in transit for the delivery, expressed as a range in seconds. Undefined when the carrier doesn't provide an estimate. When present, either the lower or upper bound of the range might still be omitted.", + "isOptional": true + } + ], + "value": "export interface DeliveryEstimate {\n /**\n * The estimated time in transit for the delivery, expressed as a range\n * in seconds. Undefined when the carrier doesn't provide an estimate.\n * When present, either the lower or upper bound of the range might still\n * be omitted.\n */\n timeInTransit?: NumberRange;\n}" + } + }, + "NumberRange": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "NumberRange", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "lower", + "value": "number", + "description": "The lower bound of the range. Undefined if only an upper bound is provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "upper", + "value": "number", + "description": "The upper bound of the range. Undefined if only a lower bound is provided.", + "isOptional": true + } + ], + "value": "export interface NumberRange {\n /**\n * The lower bound of the range. Undefined if only an upper bound is\n * provided.\n */\n lower?: number;\n\n /**\n * The upper bound of the range. Undefined if only a lower bound is\n * provided.\n */\n upper?: number;\n}" + } + }, + "PickupPointOption": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "PickupPointOption", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "carrier", + "value": "PickupPointCarrier", + "description": "Information about the carrier that ships items to this pickup point, including the carrier's name and code." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The carrier service code or rate identifier for this delivery option." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "cost", + "value": "Money", + "description": "The cost of this delivery option before any shipping discounts are applied. Compare with `costAfterDiscounts` to show savings." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "costAfterDiscounts", + "value": "Money", + "description": "The cost of this delivery option after shipping discounts have been applied. This is the price the buyer actually pays for shipping." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "Additional details about the delivery option provided by the carrier or merchant, such as estimated delivery windows or service level notes.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The unique identifier of the delivery option. Use this to match against `DeliveryOptionReference.handle` or `DeliverySelectionGroup` entries." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "location", + "value": "PickupPointLocation", + "description": "The physical location where the buyer picks up their order, including the address and display name of the collection point." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The merchant-facing or carrier-provided display name for the delivery option, such as \"Standard Shipping\" or \"Express\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'pickupPoint'", + "description": "Identifies this as a pickup point option, where items are shipped to a third-party collection point for the buyer to pick up." + } + ], + "value": "export interface PickupPointOption extends DeliveryOptionBase {\n /**\n * Identifies this as a pickup point option, where items are shipped to a third-party collection point for the buyer to pick up.\n */\n type: 'pickupPoint';\n\n /**\n * Information about the carrier that ships items to this pickup point, including the carrier's name and code.\n */\n carrier: PickupPointCarrier;\n\n /**\n * The cost of this delivery option before any shipping discounts are applied. Compare with `costAfterDiscounts` to show savings.\n */\n cost: Money;\n\n /**\n * The cost of this delivery option after shipping discounts have been applied. This is the price the buyer actually pays for shipping.\n */\n costAfterDiscounts: Money;\n\n /**\n * The physical location where the buyer picks up their order, including the address and display name of the collection point.\n */\n location: PickupPointLocation;\n}" + } + }, + "PickupPointCarrier": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "PickupPointCarrier", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The carrier's unique identifier code, used to distinguish between different carriers that deliver to pickup points.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The display name of the carrier that delivers to this pickup point.", + "isOptional": true + } + ], + "value": "interface PickupPointCarrier {\n /**\n * The carrier's unique identifier code, used to distinguish between\n * different carriers that deliver to pickup points.\n */\n code?: string;\n\n /**\n * The display name of the carrier that delivers to this pickup point.\n */\n name?: string;\n}" + } + }, + "PickupPointLocation": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "PickupPointLocation", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "address", + "value": "MailingAddress", + "description": "The physical address of the pickup point." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The unique identifier of the pickup point." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The display name of the pickup point, such as the name of the locker or collection point.", + "isOptional": true + } + ], + "value": "interface PickupPointLocation {\n /**\n * The display name of the pickup point, such as the name of the locker\n * or collection point.\n */\n name?: string;\n\n /**\n * The unique identifier of the pickup point.\n */\n handle: string;\n\n /**\n * The physical address of the pickup point.\n */\n address: MailingAddress;\n}" + } + }, + "PickupLocationOption": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "PickupLocationOption", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The carrier service code or rate identifier for this delivery option." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "Additional details about the delivery option provided by the carrier or merchant, such as estimated delivery windows or service level notes.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The unique identifier of the delivery option. Use this to match against `DeliveryOptionReference.handle` or `DeliverySelectionGroup` entries." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "location", + "value": "PickupLocation", + "description": "The merchant's store or warehouse where the buyer picks up their order, including the address and display name." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The merchant-facing or carrier-provided display name for the delivery option, such as \"Standard Shipping\" or \"Express\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'pickup'", + "description": "Identifies this as a pickup location option, where the buyer picks up items directly from a merchant's store or warehouse." + } + ], + "value": "export interface PickupLocationOption extends DeliveryOptionBase {\n /**\n * Identifies this as a pickup location option, where the buyer picks up items directly from a merchant's store or warehouse.\n */\n type: 'pickup';\n\n /**\n * The merchant's store or warehouse where the buyer picks up their order, including the address and display name.\n */\n location: PickupLocation;\n}" + } + }, + "PickupLocation": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "PickupLocation", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "address", + "value": "MailingAddress", + "description": "The physical address of the pickup location." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The merchant-defined display name of the pickup location, such as a store name or warehouse label.", + "isOptional": true + } + ], + "value": "interface PickupLocation {\n /**\n * The merchant-defined display name of the pickup location, such as a\n * store name or warehouse label.\n */\n name?: string;\n\n /**\n * The physical address of the pickup location.\n */\n address: MailingAddress;\n}" + } + }, + "DeliveryGroupType": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DeliveryGroupType", + "value": "'oneTimePurchase' | 'subscription'", + "description": "The possible types of a delivery group.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.", + "isPublicDocs": true + } + }, + "DeliveryOptionReference": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "DeliveryOptionReference", + "description": "A reference to the delivery option selected by the buyer for a delivery group.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The unique identifier of the referenced delivery option. Match this against `DeliveryOption.handle` from the `deliveryOptions` array to get the full option details." + } + ], + "value": "export interface DeliveryOptionReference {\n /**\n * The unique identifier of the referenced delivery option. Match this against `DeliveryOption.handle` from the `deliveryOptions` array to get the full option details.\n */\n handle: string;\n}" + } + }, + "CartLineReference": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartLineReference", + "description": "A reference to a cart line within a delivery group, identified by the cart line's ID.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique identifier of the referenced cart line. Match this against `CartLine.id` from the `lines` property to get the full line item details." + } + ], + "value": "export interface CartLineReference {\n /**\n * The unique identifier of the referenced cart line. Match this against `CartLine.id` from the `lines` property to get the full line item details.\n */\n id: string;\n}" + } + }, + "CartDiscountAllocation": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CartDiscountAllocation", + "value": "CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation", + "description": "A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered:\n\n- `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered.\n- `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules.\n- `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](/docs/api/functions/latest/discount).", + "isPublicDocs": true + } + }, + "CartCodeDiscountAllocation": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartCodeDiscountAllocation", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The discount code string that the buyer entered during checkout, such as `\"SAVE10\"` or `\"FREESHIP\"`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "discountedAmount", + "value": "Money", + "description": "The monetary value that was deducted from the line item or order total by this discount allocation." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'code'", + "description": "Identifies this as a code-based discount, triggered by a discount code the buyer entered at checkout." + } + ], + "value": "export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase {\n /**\n * The discount code string that the buyer entered during checkout, such as `\"SAVE10\"` or `\"FREESHIP\"`.\n */\n code: string;\n\n /**\n * Identifies this as a code-based discount, triggered by a discount code the buyer entered at checkout.\n */\n type: 'code';\n}" + } + }, + "CartAutomaticDiscountAllocation": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartAutomaticDiscountAllocation", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "discountedAmount", + "value": "Money", + "description": "The monetary value that was deducted from the line item or order total by this discount allocation." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The merchant-defined title of the automatic discount as displayed to the buyer, such as \"Summer Sale 10% Off\"." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'automatic'", + "description": "Identifies this as an automatic discount, applied based on merchant-configured rules without a code." + } + ], + "value": "export interface CartAutomaticDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The merchant-defined title of the automatic discount as displayed to the buyer, such as \"Summer Sale 10% Off\".\n */\n title: string;\n\n /**\n * Identifies this as an automatic discount, applied based on merchant-configured rules without a code.\n */\n type: 'automatic';\n}" + } + }, + "CartCustomDiscountAllocation": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartCustomDiscountAllocation", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "discountedAmount", + "value": "Money", + "description": "The monetary value that was deducted from the line item or order total by this discount allocation." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The title of the custom discount, typically applied by a [Shopify Function](/docs/api/functions/latest/discount)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'custom'", + "description": "Identifies this as a custom discount applied by a [Shopify Function](/docs/api/functions/latest/discount)." + } + ], + "value": "export interface CartCustomDiscountAllocation\n extends CartDiscountAllocationBase {\n /**\n * The title of the custom discount, typically applied by a [Shopify Function](/docs/api/functions/latest/discount).\n */\n title: string;\n\n /**\n * Identifies this as a custom discount applied by a [Shopify Function](/docs/api/functions/latest/discount).\n */\n type: 'custom';\n}" + } + }, + "CartDiscountCode": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartDiscountCode", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The discount code string entered by the buyer during checkout or applied programmatically, such as `\"SAVE10\"` or `\"FREESHIP\"`. Use this to display which discount codes were applied." + } + ], + "value": "export interface CartDiscountCode {\n /**\n * The discount code string entered by the buyer during checkout or applied programmatically, such as `\"SAVE10\"` or `\"FREESHIP\"`. Use this to display which discount codes were applied.\n */\n code: string;\n}" + } + }, + "Extension": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Extension", + "description": "Metadata about the running extension, including its API version, target, capabilities, and editor context. Use this to read configuration details or conditionally render content based on where the extension is running.", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "apiVersion", + "value": "ApiVersion", + "description": "The API version that was set in the extension config file.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'2024-10', '2025-01', '2025-04', '2025-07', '2025-10'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "capabilities", + "value": "SubscribableSignalLike", + "description": "The allowed capabilities of the extension, defined in your [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "editor", + "value": "Editor", + "description": "Information about the editor where the extension is being rendered.\n\nIf the value is undefined, then the extension isn't running in an editor.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "rendered", + "value": "SubscribableSignalLike", + "description": "A Boolean to show whether your extension is currently rendered to the screen.\n\nShopify might render your extension before it's visible in the UI, typically to pre-render extensions that appear on a later step of the checkout.\n\nYour extension might also continue to run after the customer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the customer navigates back." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "scriptUrl", + "value": "string", + "description": "The URL to the script that started the extension target." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "Target", + "description": "The identifier that specifies where in Shopify's UI your code is being injected. This is one of the targets you've included in your extension's configuration file.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'purchase.checkout.block.render'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "version", + "value": "string", + "description": "The published version of the running extension target.\n\nFor unpublished extensions, the value is `undefined`.\n\nDon't use this property as a stable identifier in development environments. It becomes available only after the extension is published.", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "3.0.10", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface Extension {\n /**\n * The API version that was set in the extension config file.\n *\n * @example '2024-10', '2025-01', '2025-04', '2025-07', '2025-10'\n */\n apiVersion: ApiVersion;\n\n /**\n * The allowed capabilities of the extension, defined in your\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n */\n capabilities: SubscribableSignalLike;\n\n /**\n * Information about the editor where the extension is being rendered.\n *\n * If the value is undefined, then the extension isn't running in an editor.\n */\n editor?: Editor;\n\n /**\n * A Boolean to show whether your extension is currently rendered to the screen.\n *\n * Shopify might render your extension before it's visible in the UI,\n * typically to pre-render extensions that appear on a later step of the\n * checkout.\n *\n * Your extension might also continue to run after the customer has navigated away\n * from where it was rendered. The extension continues running so that\n * your extension is immediately available to render if the customer navigates back.\n */\n rendered: SubscribableSignalLike;\n\n /**\n * The URL to the script that started the extension target.\n */\n scriptUrl: string;\n\n /**\n * The identifier that specifies where in Shopify's UI your code is being\n * injected. This is one of the targets you've included in your\n * extension's configuration file.\n *\n * @example 'purchase.checkout.block.render'\n * @see /docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview\n * @see /docs/apps/app-extensions/configuration#targets\n */\n target: Target;\n\n /**\n * The published version of the running extension target.\n *\n * For unpublished extensions, the value is `undefined`.\n *\n * Don't use this property as a stable identifier in development environments.\n * It becomes available only after the extension is published.\n *\n * @example 3.0.10\n */\n version?: string;\n}" + } + }, + "ApiVersion": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ApiVersion", + "value": "'2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04' | '2026-07'", + "description": "The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice." + } + }, + "Capability": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Capability", + "value": "'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources'", + "description": "The capabilities an extension has access to.\n\n* `api_access`: The extension can access the Storefront API.\n\n* `network_access`: The extension can make external network calls.\n\n* `block_progress`: The extension can block a buyer's progress and the merchant has allowed this blocking behavior.\n\n* `collect_buyer_consent.sms_marketing`: The extension can collect buyer consent for SMS marketing.\n\n* `collect_buyer_consent.customer_privacy`: The extension can register buyer consent decisions that will be honored on Shopify-managed services.\n\n* `iframe.sources`: The extension can embed an external URL in an iframe." + } + }, + "Editor": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Editor", + "description": "Information about the editor environment when an extension is rendered inside the checkout editor. The value is `undefined` when the extension is not rendering in an editor.", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'checkout'", + "description": "Indicates whether the extension is rendering in the [checkout editor](/docs/apps/checkout). Always `'checkout'`." + } + ], + "value": "export interface Editor {\n /**\n * Indicates whether the extension is rendering in the [checkout editor](/docs/apps/checkout). Always `'checkout'`.\n */\n type: 'checkout';\n}" + } + }, + "I18n": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "I18n", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use the I18n API alongside the Localization API to build fully localized extensions.", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "formatCurrency", + "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", + "description": "Returns a localized currency value.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. It uses the buyer's locale by default." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "formatDate", + "value": "(date: Date, options?: { inExtensionLocale?: boolean; } & DateTimeFormatOptions) => string", + "description": "Returns a localized date value.\n\nThis function behaves like the standard [`Intl.DateTimeFormat()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) and uses the buyer's locale by default. Formatting [options](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options) can be passed in as options." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "formatNumber", + "value": "(number: number | bigint, options?: { inExtensionLocale?: boolean; } & NumberFormatOptions) => string", + "description": "Returns a localized number.\n\nThis function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. It uses the buyer's locale by default." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "I18nTranslate", + "description": "Returns translated content in the buyer's locale, as supported by the extension.\n\n- `options.count` is a special numeric value used in pluralization.\n- The other option keys and values are treated as replacements for interpolation.\n- If the replacements are all primitives, then `translate()` returns a single string.\n- If replacements contain UI components, then `translate()` returns an array of elements." + } + ], + "value": "export interface I18n {\n /**\n * Returns a localized number.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `decimal` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - If true, uses the extension's locale.\n */\n formatNumber: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized currency value.\n *\n * This function behaves like the standard `Intl.NumberFormat()`\n * with a style of `currency` applied. It uses the buyer's locale by default.\n *\n * @param options.inExtensionLocale - If true, uses the extension's locale.\n */\n formatCurrency: (\n number: number | bigint,\n options?: {inExtensionLocale?: boolean} & Intl.NumberFormatOptions,\n ) => string;\n\n /**\n * Returns a localized date value.\n *\n * This function behaves like the standard [`Intl.DateTimeFormat()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) and uses\n * the buyer's locale by default. Formatting [options](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options) can be passed in as\n * options.\n *\n * @param options.inExtensionLocale - If true, uses the extension's locale.\n */\n formatDate: (\n date: Date,\n options?: {inExtensionLocale?: boolean} & Intl.DateTimeFormatOptions,\n ) => string;\n\n /**\n * Returns translated content in the buyer's locale,\n * as supported by the extension.\n *\n * - `options.count` is a special numeric value used in pluralization.\n * - The other option keys and values are treated as replacements for interpolation.\n * - If the replacements are all primitives, then `translate()` returns a single string.\n * - If replacements contain UI components, then `translate()` returns an array of elements.\n */\n translate: I18nTranslate;\n}" + } + }, + "I18nTranslate": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "I18nTranslate", + "description": "Translates a key from your extension's locale files into a localized string. Supports interpolation with placeholder replacements and pluralization via the special `count` option.", + "members": [], + "value": "export interface I18nTranslate {\n (\n key: string,\n options?: Record,\n ): ReplacementType extends string | number\n ? string\n : (string | ReplacementType)[];\n}" + } + }, + "CartInstructions": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartInstructions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "AttributesCartInstructions", + "description": "Whether the extension can update custom attributes using `applyAttributeChange()`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "delivery", + "value": "DeliveryCartInstructions", + "description": "Whether the extension can modify the shipping address using `applyShippingAddressChange()`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "discounts", + "value": "DiscountsCartInstructions", + "description": "Whether the extension can add or remove discount codes using `applyDiscountCodeChange()`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "lines", + "value": "CartLinesCartInstructions", + "description": "Whether the extension can add, remove, or update cart lines using `applyCartLinesChange()`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "MetafieldsCartInstructions", + "description": "Whether the extension can add, update, or delete cart metafields using `applyMetafieldChange()`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "notes", + "value": "NotesCartInstructions", + "description": "Whether the extension can update the order note using `applyNoteChange()`." + } + ], + "value": "export interface CartInstructions {\n /**\n * Whether the extension can update custom attributes using `applyAttributeChange()`.\n */\n attributes: AttributesCartInstructions;\n\n /**\n * Whether the extension can modify the shipping address using `applyShippingAddressChange()`.\n */\n delivery: DeliveryCartInstructions;\n\n /**\n * Whether the extension can add or remove discount codes using `applyDiscountCodeChange()`.\n */\n discounts: DiscountsCartInstructions;\n\n /**\n * Whether the extension can add, remove, or update cart lines using `applyCartLinesChange()`.\n */\n lines: CartLinesCartInstructions;\n\n /**\n * Whether the extension can add, update, or delete cart metafields using `applyMetafieldChange()`.\n */\n metafields: MetafieldsCartInstructions;\n\n /**\n * Whether the extension can update the order note using `applyNoteChange()`.\n */\n notes: NotesCartInstructions;\n}" + } + }, + "AttributesCartInstructions": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "AttributesCartInstructions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canUpdateAttributes", + "value": "boolean", + "description": "Whether attributes can be updated using `applyAttributeChange()`. When `false`, the checkout configuration doesn't allow attribute changes. Even when `true`, calls to `applyAttributeChange()` can still fail during accelerated checkout (Apple Pay, Google Pay)." + } + ], + "value": "export interface AttributesCartInstructions {\n /**\n * Whether attributes can be updated using `applyAttributeChange()`. When\n * `false`, the checkout configuration doesn't allow attribute changes.\n * Even when `true`, calls to `applyAttributeChange()` can still fail\n * during accelerated checkout (Apple Pay, Google Pay).\n */\n canUpdateAttributes: boolean;\n}" + } + }, + "DeliveryCartInstructions": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "DeliveryCartInstructions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canSelectCustomAddress", + "value": "boolean", + "description": "Whether the shipping address can be modified using `applyShippingAddressChange()`. When `false`, the buyer is using an accelerated checkout flow (Apple Pay, Google Pay) where the address can't be changed." + } + ], + "value": "export interface DeliveryCartInstructions {\n /**\n * Whether the shipping address can be modified using\n * `applyShippingAddressChange()`. When `false`, the buyer is using an\n * accelerated checkout flow (Apple Pay, Google Pay) where the address\n * can't be changed.\n */\n canSelectCustomAddress: boolean;\n}" + } + }, + "DiscountsCartInstructions": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "DiscountsCartInstructions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canUpdateDiscountCodes", + "value": "boolean", + "description": "Whether discount codes can be updated using `applyDiscountCodeChange()`. When `false`, the checkout configuration doesn't allow discount code changes. Even when `true`, calls to `applyDiscountCodeChange()` can still fail during accelerated checkout (Apple Pay, Google Pay)." + } + ], + "value": "export interface DiscountsCartInstructions {\n /**\n * Whether discount codes can be updated using `applyDiscountCodeChange()`.\n * When `false`, the checkout configuration doesn't allow discount code\n * changes. Even when `true`, calls to `applyDiscountCodeChange()` can\n * still fail during accelerated checkout (Apple Pay, Google Pay).\n */\n canUpdateDiscountCodes: boolean;\n}" + } + }, + "CartLinesCartInstructions": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartLinesCartInstructions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canAddCartLine", + "value": "boolean", + "description": "Whether new cart lines can be added using `applyCartLinesChange()`. When `false`, the checkout configuration doesn't allow adding lines (for example, draft orders). Even when `true`, calls can still fail during accelerated checkout (Apple Pay, Google Pay)." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canRemoveCartLine", + "value": "boolean", + "description": "Whether cart lines can be removed using `applyCartLinesChange()`. When `false`, the checkout configuration doesn't allow removing lines. Even when `true`, calls can still fail during accelerated checkout." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canUpdateCartLine", + "value": "boolean", + "description": "Whether cart lines can be updated using `applyCartLinesChange()`. When `false`, the checkout configuration doesn't allow updating lines. Even when `true`, calls can still fail during accelerated checkout." + } + ], + "value": "export interface CartLinesCartInstructions {\n /**\n * Whether new cart lines can be added using `applyCartLinesChange()`. When\n * `false`, the checkout configuration doesn't allow adding lines (for\n * example, draft orders). Even when `true`, calls can still fail during\n * accelerated checkout (Apple Pay, Google Pay).\n */\n canAddCartLine: boolean;\n\n /**\n * Whether cart lines can be removed using `applyCartLinesChange()`. When\n * `false`, the checkout configuration doesn't allow removing lines.\n * Even when `true`, calls can still fail during accelerated checkout.\n */\n canRemoveCartLine: boolean;\n\n /**\n * Whether cart lines can be updated using `applyCartLinesChange()`. When\n * `false`, the checkout configuration doesn't allow updating lines.\n * Even when `true`, calls can still fail during accelerated checkout.\n */\n canUpdateCartLine: boolean;\n}" + } + }, + "MetafieldsCartInstructions": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "MetafieldsCartInstructions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canDeleteCartMetafield", + "value": "boolean", + "description": "Whether the extension can delete cart metafields using `applyMetafieldChange()`." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canSetCartMetafields", + "value": "boolean", + "description": "Whether the extension can add or update cart metafields using `applyMetafieldChange()`." + } + ], + "value": "export interface MetafieldsCartInstructions {\n /**\n * Whether the extension can add or update cart metafields using\n * `applyMetafieldChange()`.\n */\n canSetCartMetafields: boolean;\n\n /**\n * Whether the extension can delete cart metafields using\n * `applyMetafieldChange()`.\n */\n canDeleteCartMetafield: boolean;\n}" + } + }, + "NotesCartInstructions": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "NotesCartInstructions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "canUpdateNote", + "value": "boolean", + "description": "Whether the order note can be updated using `applyNoteChange()`. When `false`, the checkout configuration doesn't allow note changes. Even when `true`, calls to `applyNoteChange()` can still fail during accelerated checkout (Apple Pay, Google Pay)." + } + ], + "value": "export interface NotesCartInstructions {\n /**\n * Whether the order note can be updated using `applyNoteChange()`. When\n * `false`, the checkout configuration doesn't allow note changes. Even\n * when `true`, calls to `applyNoteChange()` can still fail during\n * accelerated checkout (Apple Pay, Google Pay).\n */\n canUpdateNote: boolean;\n}" + } + }, + "CartLine": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartLine", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "Attribute[]", + "description": "Custom key-value attributes attached to this cart line, such as gift messages or engraving text. Use `applyCartLinesChange()` to update these values." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "cost", + "value": "CartLineCost", + "description": "The cost breakdown for this line item, including the total price after any line-level discounts have been applied." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "discountAllocations", + "value": "CartDiscountAllocation[]", + "description": "Discounts applied to this cart line, including code-based, automatic, and custom discounts. Each allocation shows the discounted amount and how the discount was triggered." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the cart line in the format `gid://shopify/CartLine/`. This ID isn't stable and can change after any cart operation, so avoid persisting it. Always look up the current ID before calling `applyCartLinesChange()`, because you'll need it to create a `CartLineChange` object.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/CartLine/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "lineComponents", + "value": "CartBundleLineComponent[]", + "description": "The individual components of a [bundle](/docs/apps/build/product-merchandising/bundles) line item. Each component represents a separate product within the bundle. Returns an empty array if the line item isn't a bundle." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "merchandise", + "value": "Merchandise", + "description": "The product variant or other merchandise associated with this line item. Use this to access product details such as the title, image, SKU, and selected options." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "parentRelationship", + "value": "CartLineParentRelationship | null", + "description": "The parent line item that this line belongs to, or `null` if this is a top-level line item. Used to identify lines added as children of a bundle or other grouped product." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "quantity", + "value": "number", + "description": "The number of units of this merchandise that the buyer purchased." + } + ], + "value": "export interface CartLine {\n /**\n * A unique identifier for the cart line in the format `gid://shopify/CartLine/`. This ID isn't stable and can change after any cart operation, so avoid persisting it. Always look up the current ID before calling `applyCartLinesChange()`, because you'll need it to create a `CartLineChange` object.\n *\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The product variant or other merchandise associated with this line item. Use this to access product details such as the title, image, SKU, and selected options.\n */\n merchandise: Merchandise;\n\n /**\n * The number of units of this merchandise that the buyer purchased.\n */\n quantity: number;\n\n /**\n * The cost breakdown for this line item, including the total price after any line-level discounts have been applied.\n */\n cost: CartLineCost;\n\n /**\n * Custom key-value attributes attached to this cart line, such as gift messages or engraving text. Use `applyCartLinesChange()` to update these values.\n */\n attributes: Attribute[];\n\n /**\n * Discounts applied to this cart line, including code-based, automatic, and custom discounts. Each allocation shows the discounted amount and how the discount was triggered.\n */\n discountAllocations: CartDiscountAllocation[];\n\n /**\n * The individual components of a [bundle](/docs/apps/build/product-merchandising/bundles) line item. Each component represents a separate product within the bundle. Returns an empty array if the line item isn't a bundle.\n */\n lineComponents: CartLineComponentType[];\n\n /**\n * The parent line item that this line belongs to, or `null` if this is a\n * top-level line item. Used to identify lines added as children of a bundle\n * or other grouped product.\n */\n parentRelationship: CartLineParentRelationship | null;\n}" + } + }, + "CartLineCost": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartLineCost", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "totalAmount", + "value": "Money", + "description": "The total price the buyer pays for this line item after all line-level discounts have been applied, but before order-level discounts, taxes, and shipping." + } + ], + "value": "export interface CartLineCost {\n /**\n * The total price the buyer pays for this line item after all line-level discounts have been applied, but before order-level discounts, taxes, and shipping.\n */\n totalAmount: Money;\n}" + } + }, + "CartBundleLineComponent": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartBundleLineComponent", + "description": "An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "Attribute[]", + "description": "Custom key-value pairs attached to this bundle component, such as personalization options specific to this item within the bundle.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "[{key: 'engraving', value: 'hello world'}]", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "cost", + "value": "CartLineCost", + "description": "The cost breakdown for this bundle component, including the total amount after any per-item discounts." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for this component within the bundle, in the format `gid://shopify/CartLineComponent/`. This ID isn't stable and might change after any operation that updates the line items.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/CartLineComponent/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "merchandise", + "value": "Merchandise", + "description": "The product variant included in this bundle component. Use this to display product details for individual items within a bundle." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "quantity", + "value": "number", + "description": "The number of units of this component included in the bundle." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'bundle'", + "description": "Identifies this as a bundle line component. This is currently the only component type." + } + ], + "value": "export interface CartBundleLineComponent {\n /**\n * Identifies this as a bundle line component. This is currently the only component type.\n */\n type: 'bundle';\n\n /**\n * A unique identifier for this component within the bundle, in the format `gid://shopify/CartLineComponent/`. This ID isn't stable and might change after any operation that updates the line items.\n *\n * @example 'gid://shopify/CartLineComponent/123'\n */\n id: string;\n\n /**\n * The product variant included in this bundle component. Use this to display product details for individual items within a bundle.\n */\n merchandise: Merchandise;\n\n /**\n * The number of units of this component included in the bundle.\n */\n quantity: number;\n\n /**\n * The cost breakdown for this bundle component, including the total amount after any per-item discounts.\n */\n cost: CartLineCost;\n\n /**\n * Custom key-value pairs attached to this bundle component, such as personalization options specific to this item within the bundle.\n *\n * @example [{key: 'engraving', value: 'hello world'}]\n */\n attributes: Attribute[];\n}" + } + }, + "Merchandise": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Merchandise", + "value": "ProductVariant", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the product variant in the format `gid://shopify/ProductVariant/`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/ProductVariant/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "ImageDetails", + "description": "The image associated with the product variant. Falls back to the product image if the variant doesn't have its own. The value is `undefined` if neither the variant nor the product has an image.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "product", + "value": "Product", + "description": "The parent product that this variant belongs to. Use this to access the product's ID, vendor, and type." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "requiresShipping", + "value": "boolean", + "description": "Whether this product variant requires physical shipping. When `true`, the buyer must provide a shipping address. Returns `false` for digital products, gift cards, and services." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "selectedOptions", + "value": "SelectedOption[]", + "description": "The product options applied to this variant, such as size, color, or material. Each entry contains the option name and the selected value." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "sellingPlan", + "value": "SellingPlan", + "description": "The [selling plan](/docs/apps/build/purchase-options/subscriptions) associated with this variant, such as a subscription or pre-order plan. The value is `undefined` if the item isn't being purchased through a selling plan.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "sku", + "value": "string", + "description": "The stock keeping unit (SKU) assigned to this variant by the merchant, used for inventory tracking. The value is `undefined` if no SKU has been set.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "subtitle", + "value": "string", + "description": "A secondary description for the variant that provides additional context, such as a color or size combination. The value is `undefined` if no subtitle is available.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The display title of the product variant, such as \"Small\" or \"Red / Large\". This is the variant-specific label, not the parent product title." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'variant'", + "description": "Identifies the merchandise as a product variant. This is currently the only merchandise type in checkout." + } + ] + } + }, + "Product": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Product", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the product in the format `gid://shopify/Product/`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/Product/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "productType", + "value": "string", + "description": "A merchant-defined categorization for the product, such as \"Accessories\" or \"Clothing\". Commonly used for filtering and organizing products in a storefront." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "vendor", + "value": "string", + "description": "The name of the product's vendor or manufacturer, as set by the merchant in Shopify admin." + } + ], + "value": "export interface Product {\n /**\n * A globally-unique identifier for the product in the format `gid://shopify/Product/`.\n *\n * @example 'gid://shopify/Product/123'\n */\n id: string;\n\n /**\n * The name of the product's vendor or manufacturer, as set by the merchant in Shopify admin.\n */\n vendor: string;\n\n /**\n * A merchant-defined categorization for the product, such as \"Accessories\" or \"Clothing\". Commonly used for filtering and organizing products in a storefront.\n */\n productType: string;\n}" + } + }, + "SelectedOption": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "SelectedOption", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name of the product option, such as \"Color\" or \"Size\".", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Size'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The selected value for the product option, such as \"Red\" or \"Large\".", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Large'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface SelectedOption {\n /**\n * The name of the product option, such as \"Color\" or \"Size\".\n *\n * @example 'Size'\n */\n name: string;\n\n /**\n * The selected value for the product option, such as \"Red\" or \"Large\".\n *\n * @example 'Large'\n */\n value: string;\n}" + } + }, + "CartLineParentRelationship": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartLineParentRelationship", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "parent", + "value": "{ id: string; }", + "description": "The parent cart line that a cart line is associated with." + } + ], + "value": "export interface CartLineParentRelationship {\n /**\n * The parent cart line that a cart line is associated with.\n */\n parent: {\n /**\n * These line item IDs aren't stable at the moment, and they might change after\n * any operations on the line items. Always look up an updated\n * ID before any call to `applyCartLinesChange` because you'll need the ID to\n * create a `CartLineChange` object.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n };\n}" + } + }, + "Localization": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Localization", + "description": "The buyer's language, country, currency, and timezone context. Use this to adapt your extension to the buyer's region and display localized content.", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "country", + "value": "SubscribableSignalLike", + "description": "The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n\nDerived from the buyer's shipping address. Returns `undefined` until the buyer enters a shipping address." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "currency", + "value": "SubscribableSignalLike", + "description": "The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "extensionLanguage", + "value": "SubscribableSignalLike", + "description": "The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "language", + "value": "SubscribableSignalLike", + "description": "The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "market", + "value": "SubscribableSignalLike", + "description": "The [market](/docs/apps/build/markets) context of the checkout, carried over from the cart context. Markets group countries and regions with shared pricing, languages, and domains. The market context updates when the buyer changes the country of their shipping address. The value is `undefined` if the market is unknown.", + "deprecationMessage": "Merchants now manage which extensions load for each\nmarket, so extensions no longer need to check this value." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "timezone", + "value": "SubscribableSignalLike", + "description": "The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time." + } + ], + "value": "export interface Localization {\n /**\n * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency.\n */\n currency: SubscribableSignalLike;\n\n /**\n * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time.\n */\n timezone: SubscribableSignalLike;\n\n /**\n * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports.\n */\n language: SubscribableSignalLike;\n\n /**\n * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension.\n */\n extensionLanguage: SubscribableSignalLike;\n\n /**\n * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown.\n *\n * Derived from the buyer's shipping address. Returns `undefined` until the\n * buyer enters a shipping address.\n */\n country: SubscribableSignalLike;\n\n /**\n * The [market](/docs/apps/build/markets) context of the checkout,\n * carried over from the cart context. Markets group countries and\n * regions with shared pricing, languages, and domains. The market\n * context updates when the buyer changes the country of their\n * shipping address. The value is `undefined` if the market is unknown.\n *\n * @deprecated Merchants now manage which extensions load for each\n * market, so extensions no longer need to check this value.\n */\n market: SubscribableSignalLike;\n}" + } + }, + "Country": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "Country", + "description": "A buyer's country, identified by its ISO country code.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "isoCode", + "value": "CountryCode", + "description": "The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'CA' for Canada, 'US' for United States.", + "title": "Example" + } + ] + }, + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'CA' for Canada, 'US' for United States.", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface Country {\n /**\n * The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.\n *\n * @example 'CA' for Canada, 'US' for United States.\n */\n isoCode: CountryCode;\n}" + } + }, + "Timezone": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Timezone", + "value": "'Africa/Abidjan' | 'Africa/Algiers' | 'Africa/Bissau' | 'Africa/Cairo' | 'Africa/Casablanca' | 'Africa/Ceuta' | 'Africa/El_Aaiun' | 'Africa/Johannesburg' | 'Africa/Juba' | 'Africa/Khartoum' | 'Africa/Lagos' | 'Africa/Maputo' | 'Africa/Monrovia' | 'Africa/Nairobi' | 'Africa/Ndjamena' | 'Africa/Sao_Tome' | 'Africa/Tripoli' | 'Africa/Tunis' | 'Africa/Windhoek' | 'America/Adak' | 'America/Anchorage' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Argentina/Catamarca' | 'America/Argentina/Cordoba' | 'America/Argentina/Jujuy' | 'America/Argentina/La_Rioja' | 'America/Argentina/Mendoza' | 'America/Argentina/Rio_Gallegos' | 'America/Argentina/Salta' | 'America/Argentina/San_Juan' | 'America/Argentina/San_Luis' | 'America/Argentina/Tucuman' | 'America/Argentina/Ushuaia' | 'America/Asuncion' | 'America/Bahia' | 'America/Bahia_Banderas' | 'America/Barbados' | 'America/Belem' | 'America/Belize' | 'America/Boa_Vista' | 'America/Bogota' | 'America/Boise' | 'America/Cambridge_Bay' | 'America/Campo_Grande' | 'America/Cancun' | 'America/Caracas' | 'America/Cayenne' | 'America/Chicago' | 'America/Chihuahua' | 'America/Costa_Rica' | 'America/Cuiaba' | 'America/Danmarkshavn' | 'America/Dawson' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Detroit' | 'America/Edmonton' | 'America/Eirunepe' | 'America/El_Salvador' | 'America/Fort_Nelson' | 'America/Fortaleza' | 'America/Glace_Bay' | 'America/Goose_Bay' | 'America/Grand_Turk' | 'America/Guatemala' | 'America/Guayaquil' | 'America/Guyana' | 'America/Halifax' | 'America/Havana' | 'America/Hermosillo' | 'America/Indiana/Indianapolis' | 'America/Indiana/Knox' | 'America/Indiana/Marengo' | 'America/Indiana/Petersburg' | 'America/Indiana/Tell_City' | 'America/Indiana/Vevay' | 'America/Indiana/Vincennes' | 'America/Indiana/Winamac' | 'America/Inuvik' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Juneau' | 'America/Kentucky/Louisville' | 'America/Kentucky/Monticello' | 'America/La_Paz' | 'America/Lima' | 'America/Los_Angeles' | 'America/Maceio' | 'America/Managua' | 'America/Manaus' | 'America/Martinique' | 'America/Matamoros' | 'America/Mazatlan' | 'America/Menominee' | 'America/Merida' | 'America/Metlakatla' | 'America/Mexico_City' | 'America/Miquelon' | 'America/Moncton' | 'America/Monterrey' | 'America/Montevideo' | 'America/New_York' | 'America/Nipigon' | 'America/Nome' | 'America/Noronha' | 'America/North_Dakota/Beulah' | 'America/North_Dakota/Center' | 'America/North_Dakota/New_Salem' | 'America/Nuuk' | 'America/Ojinaga' | 'America/Panama' | 'America/Pangnirtung' | 'America/Paramaribo' | 'America/Phoenix' | 'America/Port-au-Prince' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Punta_Arenas' | 'America/Rainy_River' | 'America/Rankin_Inlet' | 'America/Recife' | 'America/Regina' | 'America/Resolute' | 'America/Rio_Branco' | 'America/Santarem' | 'America/Santiago' | 'America/Santo_Domingo' | 'America/Sao_Paulo' | 'America/Scoresbysund' | 'America/Sitka' | 'America/St_Johns' | 'America/Swift_Current' | 'America/Tegucigalpa' | 'America/Thule' | 'America/Thunder_Bay' | 'America/Tijuana' | 'America/Toronto' | 'America/Vancouver' | 'America/Whitehorse' | 'America/Winnipeg' | 'America/Yakutat' | 'America/Yellowknife' | 'Antarctica/Casey' | 'Antarctica/Davis' | 'Antarctica/Macquarie' | 'Antarctica/Mawson' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Antarctica/Troll' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Amman' | 'Asia/Anadyr' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Atyrau' | 'Asia/Baghdad' | 'Asia/Baku' | 'Asia/Bangkok' | 'Asia/Barnaul' | 'Asia/Beirut' | 'Asia/Bishkek' | 'Asia/Brunei' | 'Asia/Chita' | 'Asia/Choibalsan' | 'Asia/Colombo' | 'Asia/Damascus' | 'Asia/Dhaka' | 'Asia/Dili' | 'Asia/Dubai' | 'Asia/Dushanbe' | 'Asia/Famagusta' | 'Asia/Gaza' | 'Asia/Hebron' | 'Asia/Ho_Chi_Minh' | 'Asia/Hong_Kong' | 'Asia/Hovd' | 'Asia/Irkutsk' | 'Asia/Jakarta' | 'Asia/Jayapura' | 'Asia/Jerusalem' | 'Asia/Kabul' | 'Asia/Kamchatka' | 'Asia/Karachi' | 'Asia/Kathmandu' | 'Asia/Khandyga' | 'Asia/Kolkata' | 'Asia/Krasnoyarsk' | 'Asia/Kuala_Lumpur' | 'Asia/Kuching' | 'Asia/Macau' | 'Asia/Magadan' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Nicosia' | 'Asia/Novokuznetsk' | 'Asia/Novosibirsk' | 'Asia/Omsk' | 'Asia/Oral' | 'Asia/Pontianak' | 'Asia/Pyongyang' | 'Asia/Qatar' | 'Asia/Qostanay' | 'Asia/Qyzylorda' | 'Asia/Riyadh' | 'Asia/Sakhalin' | 'Asia/Samarkand' | 'Asia/Seoul' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Srednekolymsk' | 'Asia/Taipei' | 'Asia/Tashkent' | 'Asia/Tbilisi' | 'Asia/Tehran' | 'Asia/Thimphu' | 'Asia/Tokyo' | 'Asia/Tomsk' | 'Asia/Ulaanbaatar' | 'Asia/Urumqi' | 'Asia/Ust-Nera' | 'Asia/Vladivostok' | 'Asia/Yakutsk' | 'Asia/Yangon' | 'Asia/Yekaterinburg' | 'Asia/Yerevan' | 'Atlantic/Azores' | 'Atlantic/Bermuda' | 'Atlantic/Canary' | 'Atlantic/Cape_Verde' | 'Atlantic/Faroe' | 'Atlantic/Madeira' | 'Atlantic/Reykjavik' | 'Atlantic/South_Georgia' | 'Atlantic/Stanley' | 'Australia/Adelaide' | 'Australia/Brisbane' | 'Australia/Broken_Hill' | 'Australia/Darwin' | 'Australia/Eucla' | 'Australia/Hobart' | 'Australia/Lindeman' | 'Australia/Lord_Howe' | 'Australia/Melbourne' | 'Australia/Perth' | 'Australia/Sydney' | 'CET' | 'CST6CDT' | 'EET' | 'EST' | 'EST5EDT' | 'Etc/GMT' | 'Etc/GMT-1' | 'Etc/GMT-10' | 'Etc/GMT-11' | 'Etc/GMT-12' | 'Etc/GMT-13' | 'Etc/GMT-14' | 'Etc/GMT-2' | 'Etc/GMT-3' | 'Etc/GMT-4' | 'Etc/GMT-5' | 'Etc/GMT-6' | 'Etc/GMT-7' | 'Etc/GMT-8' | 'Etc/GMT-9' | 'Etc/GMT+1' | 'Etc/GMT+10' | 'Etc/GMT+11' | 'Etc/GMT+12' | 'Etc/GMT+2' | 'Etc/GMT+3' | 'Etc/GMT+4' | 'Etc/GMT+5' | 'Etc/GMT+6' | 'Etc/GMT+7' | 'Etc/GMT+8' | 'Etc/GMT+9' | 'Etc/UTC' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Astrakhan' | 'Europe/Athens' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Bucharest' | 'Europe/Budapest' | 'Europe/Chisinau' | 'Europe/Copenhagen' | 'Europe/Dublin' | 'Europe/Gibraltar' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kiev' | 'Europe/Kirov' | 'Europe/Lisbon' | 'Europe/London' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Minsk' | 'Europe/Monaco' | 'Europe/Moscow' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Riga' | 'Europe/Rome' | 'Europe/Samara' | 'Europe/Saratov' | 'Europe/Simferopol' | 'Europe/Sofia' | 'Europe/Stockholm' | 'Europe/Tallinn' | 'Europe/Tirane' | 'Europe/Ulyanovsk' | 'Europe/Uzhgorod' | 'Europe/Vienna' | 'Europe/Vilnius' | 'Europe/Volgograd' | 'Europe/Warsaw' | 'Europe/Zaporozhye' | 'Europe/Zurich' | 'HST' | 'Indian/Chagos' | 'Indian/Christmas' | 'Indian/Cocos' | 'Indian/Kerguelen' | 'Indian/Mahe' | 'Indian/Maldives' | 'Indian/Mauritius' | 'Indian/Reunion' | 'MET' | 'MST' | 'MST7MDT' | 'Pacific/Apia' | 'Pacific/Auckland' | 'Pacific/Bougainville' | 'Pacific/Chatham' | 'Pacific/Chuuk' | 'Pacific/Easter' | 'Pacific/Efate' | 'Pacific/Fakaofo' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Galapagos' | 'Pacific/Gambier' | 'Pacific/Guadalcanal' | 'Pacific/Guam' | 'Pacific/Honolulu' | 'Pacific/Kanton' | 'Pacific/Kiritimati' | 'Pacific/Kosrae' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Marquesas' | 'Pacific/Nauru' | 'Pacific/Niue' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pago_Pago' | 'Pacific/Palau' | 'Pacific/Pitcairn' | 'Pacific/Pohnpei' | 'Pacific/Port_Moresby' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Tarawa' | 'Pacific/Tongatapu' | 'Pacific/Wake' | 'Pacific/Wallis' | 'PST8PDT' | 'WET'", + "description": "" + } + }, + "StorefrontApiVersion": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "StorefrontApiVersion", + "value": "'2022-04' | '2022-07' | '2022-10' | '2023-01' | '2023-04' | '2023-07' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01' | '2026-04' | '2026-07'", + "description": "The supported Storefront API versions. Pass one of these values to `query()` to target a specific API version when querying the Storefront GraphQL API." + } + }, + "GraphQLError": { + "src/shared.ts": { + "filePath": "src/shared.ts", + "name": "GraphQLError", + "description": "An error returned by the Storefront GraphQL API. Contains a human-readable `message` and an `extensions` object with the request ID and error code for debugging.", + "members": [ + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "extensions", + "value": "{ requestId: string; code: string; }", + "description": "Additional error metadata including the request ID and error code." + }, + { + "filePath": "src/shared.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A human-readable description of the error." + } + ], + "value": "export interface GraphQLError {\n /**\n * A human-readable description of the error.\n */\n message: string;\n /**\n * Additional error metadata including the request ID and error code.\n */\n extensions: {\n /**\n * The unique identifier for the API request, useful for debugging with Shopify support.\n */\n requestId: string;\n /**\n * A machine-readable error code identifying the type of error.\n */\n code: string;\n };\n}" + } + }, + "SelectedPaymentOption": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SelectedPaymentOption", + "value": "PaymentOption", + "description": "A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "A session-scoped identifier for this payment option. This handle isn't globally unique; it's specific to the current checkout session or the shop." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "| 'creditCard'\n | 'deferred'\n | 'local'\n | 'manualPayment'\n | 'offsite'\n | 'other'\n | 'paymentOnDelivery'\n | 'redeemable'\n | 'wallet'\n | 'customOnsite'", + "description": "The type of the payment option.\n\nShops can be configured to support many different payment options. Some options are available only to buyers in specific regions.\n\n| Type | Description |\n|---|---|\n| `creditCard` | A vaulted or manually entered credit card. |\n| `deferred` | A [deferred payment](https://help.shopify.com/en/manual/orders/deferred-payments), such as invoicing the buyer and collecting payment at a later time. |\n| `local` | A [local payment option](https://help.shopify.com/en/manual/payments/shopify-payments/local-payment-methods) specific to the current region or market |\n| `manualPayment` | A manual payment option such as an in-person retail transaction. |\n| `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. |\n| `other` | Another type of payment not defined here. |\n| `paymentOnDelivery` | A payment collected on delivery. |\n| `redeemable` | A redeemable payment option such as a gift card or store credit. |\n| `wallet` | An integrated wallet such as PayPal, Google Pay, or Apple Pay. |\n| `customOnsite` | A custom payment option that's processed through a checkout extension with a payments app. |" + } + ] + } + }, + "SessionToken": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "SessionToken", + "description": "Authenticates requests between your extension and your app backend. Use session tokens to verify the identity of the buyer and the shop context when making server-side API calls. The token is a signed JWT that contains claims such as the customer ID, shop domain, and expiration.\n\nThe `sub` claim in the decoded token is present only when the buyer is logged in and the app has permission to read customer accounts. Absent for anonymous buyers.", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "MethodSignature", + "name": "get", + "value": "() => Promise", + "description": "Requests a session token that hasn't expired. You should call this method every time you need to make a request to your backend in order to get a valid token. This method returns cached tokens when possible, so you don't need to worry about storing these tokens yourself." + } + ], + "value": "export interface SessionToken {\n /**\n * Requests a session token that hasn't expired. You should call this method every\n * time you need to make a request to your backend in order to get a valid token.\n * This method returns cached tokens when possible, so you don't need to worry\n * about storing these tokens yourself.\n */\n get(): Promise;\n}" + } + }, + "ExtensionSettings": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionSettings", + "value": "Record<\n string,\n string | number | boolean | undefined\n>", + "description": "The merchant-defined setting values for the extension.", + "isPublicDocs": true, + "members": [] + } + }, + "Shop": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Shop", + "description": "Metadata about the merchant's store, including its name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID.", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/Shop/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "myshopifyDomain", + "value": "string", + "description": "The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The display name of the shop as configured by the merchant in Shopify admin." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "storefrontUrl", + "value": "string", + "description": "The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.", + "isOptional": true + } + ], + "value": "export interface Shop {\n /**\n * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`.\n *\n * @example 'gid://shopify/Shop/123'\n */\n id: string;\n /**\n * The display name of the shop as configured by the merchant in Shopify admin.\n */\n name: string;\n /**\n * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store.\n */\n storefrontUrl?: string;\n /**\n * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain.\n */\n myshopifyDomain: string;\n}" + } + }, + "Storage": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "Storage", + "description": "Key-value storage for a specific extension. Use storage to save preferences or cached data that should survive page reloads without requiring a backend call. Stored data is only available to this specific extension. The storage backend is implemented with `localStorage` and data persistence isn't guaranteed.", + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "MethodSignature", + "name": "delete", + "value": "(key: string) => Promise", + "description": "Deletes a previously stored value by key." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "MethodSignature", + "name": "read", + "value": "(key: string) => Promise", + "description": "Read and return a stored value by key.\n\nThe stored data is deserialized from JSON and returned as its original type.\n\nReturns the stored value for the given key, or `null` when no value exists. Doesn't throw on a missing key." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "MethodSignature", + "name": "write", + "value": "(key: string, data: any) => Promise", + "description": "Write stored data for this key.\n\nThe data must be serializable to JSON." + } + ], + "value": "export interface Storage {\n /**\n * Read and return a stored value by key.\n *\n * The stored data is deserialized from JSON and returned as\n * its original type.\n *\n * Returns the stored value for the given key, or `null` when no value\n * exists. Doesn't throw on a missing key.\n */\n read(key: string): Promise;\n\n /**\n * Write stored data for this key.\n *\n * The data must be serializable to JSON.\n */\n write(key: string, data: any): Promise;\n\n /**\n * Deletes a previously stored value by key.\n */\n delete(key: string): Promise;\n}" + } + }, + "BaseMerchandise": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "BaseMerchandise", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally unique identifier for the merchandise.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/ProductVariant/123'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface BaseMerchandise {\n /**\n * A globally unique identifier for the merchandise.\n *\n * @example 'gid://shopify/ProductVariant/123'\n */\n id: string;\n}" + } + }, + "ProductVariant": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "ProductVariant", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A globally-unique identifier for the product variant in the format `gid://shopify/ProductVariant/`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/ProductVariant/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "image", + "value": "ImageDetails", + "description": "The image associated with the product variant. Falls back to the product image if the variant doesn't have its own. The value is `undefined` if neither the variant nor the product has an image.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "product", + "value": "Product", + "description": "The parent product that this variant belongs to. Use this to access the product's ID, vendor, and type." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "requiresShipping", + "value": "boolean", + "description": "Whether this product variant requires physical shipping. When `true`, the buyer must provide a shipping address. Returns `false` for digital products, gift cards, and services." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "selectedOptions", + "value": "SelectedOption[]", + "description": "The product options applied to this variant, such as size, color, or material. Each entry contains the option name and the selected value." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "sellingPlan", + "value": "SellingPlan", + "description": "The [selling plan](/docs/apps/build/purchase-options/subscriptions) associated with this variant, such as a subscription or pre-order plan. The value is `undefined` if the item isn't being purchased through a selling plan.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "sku", + "value": "string", + "description": "The stock keeping unit (SKU) assigned to this variant by the merchant, used for inventory tracking. The value is `undefined` if no SKU has been set.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "subtitle", + "value": "string", + "description": "A secondary description for the variant that provides additional context, such as a color or size combination. The value is `undefined` if no subtitle is available.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The display title of the product variant, such as \"Small\" or \"Red / Large\". This is the variant-specific label, not the parent product title." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'variant'", + "description": "Identifies the merchandise as a product variant. This is currently the only merchandise type in checkout." + } + ], + "value": "export interface ProductVariant extends BaseMerchandise {\n /**\n * Identifies the merchandise as a product variant. This is currently the only merchandise type in checkout.\n */\n type: 'variant';\n\n /**\n * A globally-unique identifier for the product variant in the format `gid://shopify/ProductVariant/`.\n *\n * @example 'gid://shopify/ProductVariant/123'\n */\n id: string;\n\n /**\n * The display title of the product variant, such as \"Small\" or \"Red / Large\". This is the variant-specific label, not the parent product title.\n */\n title: string;\n\n /**\n * A secondary description for the variant that provides additional context, such as a color or size combination. The value is `undefined` if no subtitle is available.\n */\n subtitle?: string;\n\n /**\n * The image associated with the product variant. Falls back to the product image if the variant doesn't have its own. The value is `undefined` if neither the variant nor the product has an image.\n */\n image?: ImageDetails;\n\n /**\n * The product options applied to this variant, such as size, color, or material. Each entry contains the option name and the selected value.\n */\n selectedOptions: SelectedOption[];\n\n /**\n * The parent product that this variant belongs to. Use this to access the product's ID, vendor, and type.\n */\n product: Product;\n\n /**\n * Whether this product variant requires physical shipping. When `true`, the buyer must provide a shipping address. Returns `false` for digital products, gift cards, and services.\n */\n requiresShipping: boolean;\n\n /**\n * The [selling plan](/docs/apps/build/purchase-options/subscriptions) associated with this variant, such as a subscription or pre-order plan. The value is `undefined` if the item isn't being purchased through a selling plan.\n */\n sellingPlan?: SellingPlan;\n\n /**\n * The stock keeping unit (SKU) assigned to this variant by the merchant, used for inventory tracking. The value is `undefined` if no SKU has been set.\n */\n sku?: string;\n}" + } + }, + "CartDiscountAllocationBase": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "CartDiscountAllocationBase", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "discountedAmount", + "value": "Money", + "description": "The monetary value that was deducted from the line item or order total by this discount allocation." + } + ], + "value": "export interface CartDiscountAllocationBase {\n /**\n * The monetary value that was deducted from the line item or order total by this discount allocation.\n */\n discountedAmount: Money;\n}" + } + }, + "DeliveryOptionBase": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "DeliveryOptionBase", + "description": "Represents a base interface for a single delivery option.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The carrier service code or rate identifier for this delivery option." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "description", + "value": "string", + "description": "Additional details about the delivery option provided by the carrier or merchant, such as estimated delivery windows or service level notes.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "The unique identifier of the delivery option. Use this to match against `DeliveryOptionReference.handle` or `DeliverySelectionGroup` entries." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "metafields", + "value": "Metafield[]", + "description": "Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The merchant-facing or carrier-provided display name for the delivery option, such as \"Standard Shipping\" or \"Express\".", + "isOptional": true + } + ], + "value": "export interface DeliveryOptionBase {\n /**\n * The unique identifier of the delivery option. Use this to match against `DeliveryOptionReference.handle` or `DeliverySelectionGroup` entries.\n */\n handle: string;\n\n /**\n * The merchant-facing or carrier-provided display name for the delivery\n * option, such as \"Standard Shipping\" or \"Express\".\n */\n title?: string;\n\n /**\n * Additional details about the delivery option provided by the carrier\n * or merchant, such as estimated delivery windows or service level notes.\n */\n description?: string;\n\n /**\n * The carrier service code or rate identifier for this delivery option.\n */\n code: string;\n\n /**\n * Custom [metafields](/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](/docs/apps/build/functions). Use these to display additional information about the option.\n */\n metafields: Metafield[];\n}" + } + }, + "DeliveryGroupDetails": { + "src/surfaces/checkout/api/standard/standard.ts": { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "name": "DeliveryGroupDetails", + "description": "Represents a DeliveryGroup with expanded reference fields and full details.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "deliveryOptions", + "value": "DeliveryOption[]", + "description": "The delivery options available for this group, including shipping, pickup point, and pickup location options. The buyer selects one of these to determine how their items are delivered." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "groupType", + "value": "DeliveryGroupType", + "description": "Whether this group contains items for a one-time purchase or a subscription. Subscription delivery groups might have different shipping options. See `DeliveryGroupType` for possible values." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the delivery group. The value is `undefined` if the underlying delivery line doesn't have an ID assigned.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "isDeliveryRequired", + "value": "boolean", + "description": "Whether physical delivery is required for the items in this group. Digital-only groups don't require delivery." + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "selectedDeliveryOption", + "value": "DeliveryOption", + "description": "The full delivery option the buyer has selected for this group, with all cost and carrier details included. The value is `undefined` if the buyer hasn't selected an option yet. Unlike `DeliveryGroup.selectedDeliveryOption`, which is a reference, this contains the complete `DeliveryOption` object.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/standard/standard.ts", + "syntaxKind": "PropertySignature", + "name": "targetedCartLines", + "value": "CartLine[]", + "description": "The full cart line objects associated with this delivery group, with all merchandise and cost details included. Unlike `DeliveryGroup.targetedCartLines`, which contains references, this contains the complete `CartLine` objects." + } + ], + "value": "export interface DeliveryGroupDetails extends DeliveryGroup {\n /**\n * The full delivery option the buyer has selected for this group, with all cost and carrier details included. The value is `undefined` if the buyer hasn't selected an option yet. Unlike `DeliveryGroup.selectedDeliveryOption`, which is a reference, this contains the complete `DeliveryOption` object.\n */\n selectedDeliveryOption?: DeliveryOption;\n\n /**\n * The full cart line objects associated with this delivery group, with all merchandise and cost details included. Unlike `DeliveryGroup.targetedCartLines`, which contains references, this contains the complete `CartLine` objects.\n */\n targetedCartLines: CartLine[];\n}" + } + }, + "RedeemableChangeResult": { + "src/surfaces/checkout/api/redeemable/redeemable.ts": { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RedeemableChangeResult", + "value": "RedeemableChangeResultSuccess | RedeemableChangeResultError", + "description": "", + "isPublicDocs": true + } + }, + "RedeemableChangeResultSuccess": { + "src/surfaces/checkout/api/redeemable/redeemable.ts": { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "name": "RedeemableChangeResultSuccess", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the redeemable change was applied successfully." + } + ], + "value": "export interface RedeemableChangeResultSuccess {\n /**\n * Indicates that the redeemable change was applied successfully.\n */\n type: 'success';\n}" + } + }, + "RedeemableChangeResultError": { + "src/surfaces/checkout/api/redeemable/redeemable.ts": { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "name": "RedeemableChangeResultError", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the redeemable change was not applied successfully." + } + ], + "value": "export interface RedeemableChangeResultError {\n /**\n * Indicates that the redeemable change was not applied successfully.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" + } + }, + "RedeemableAttribute": { + "src/surfaces/checkout/api/redeemable/redeemable.ts": { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "name": "RedeemableAttribute", + "description": "A key-value pair that represents an attribute of a redeemable payment method.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "" + } + ], + "value": "export interface RedeemableAttribute {\n key: string;\n value: string;\n}" + } + }, + "RedeemableChange": { + "src/surfaces/checkout/api/redeemable/redeemable.ts": { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RedeemableChange", + "value": "RedeemableAddChange", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "RedeemableAttribute[]", + "description": "The redeemable attributes." + }, + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "identifier", + "value": "string", + "description": "The identifier used to represent the redeemable (e.g. the gift card code)." + }, + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'redeemableAddChange'", + "description": "The type of the `RedeemableChange` API." + } + ] + } + }, + "RedeemableAddChange": { + "src/surfaces/checkout/api/redeemable/redeemable.ts": { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "name": "RedeemableAddChange", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "RedeemableAttribute[]", + "description": "The redeemable attributes." + }, + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "identifier", + "value": "string", + "description": "The identifier used to represent the redeemable (e.g. the gift card code)." + }, + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'redeemableAddChange'", + "description": "The type of the `RedeemableChange` API." + } + ], + "value": "export interface RedeemableAddChange {\n /**\n * The type of the `RedeemableChange` API.\n */\n type: 'redeemableAddChange';\n\n /**\n * The redeemable attributes.\n */\n attributes: RedeemableAttribute[];\n\n /**\n * The identifier used to represent the redeemable (e.g. the gift card code).\n */\n identifier: string;\n}" + } + }, + "RedeemableApi": { + "src/surfaces/checkout/api/redeemable/redeemable.ts": { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "name": "RedeemableApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/redeemable/redeemable.ts", + "syntaxKind": "MethodSignature", + "name": "applyRedeemableChange", + "value": "(change: RedeemableAddChange) => Promise", + "description": "Applies a redeemable change to add a redeemable payment method." + } + ], + "value": "export interface RedeemableApi {\n /**\n * Applies a redeemable change to add a redeemable payment method.\n */\n applyRedeemableChange(\n change: RedeemableChange,\n ): Promise;\n}" + } + }, + "NoteRemoveChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "NoteRemoveChange", + "description": "Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'removeNote'", + "description": "Identifies this as a note removal. Set this when creating a change to clear the buyer's note." + } + ], + "value": "export interface NoteRemoveChange {\n /**\n * Identifies this as a note removal. Set this when creating a change to clear the buyer's note.\n */\n type: 'removeNote';\n}" + } + }, + "NoteUpdateChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "NoteUpdateChange", + "description": "Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "note", + "value": "string", + "description": "The text to set as the buyer's note. This replaces any existing note entirely rather than appending to it." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updateNote'", + "description": "Identifies this as a note update. Set this when creating a change to set or replace the buyer's note." + } + ], + "value": "export interface NoteUpdateChange {\n /**\n * Identifies this as a note update. Set this when creating a change to set or replace the buyer's note.\n */\n type: 'updateNote';\n /**\n * The text to set as the buyer's note. This replaces any existing note entirely rather than appending to it.\n */\n note: string;\n}" + } + }, + "NoteChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "NoteChange", + "value": "NoteRemoveChange | NoteUpdateChange", + "description": "The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it.", + "isPublicDocs": true + } + }, + "NoteChangeResultSuccess": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "NoteChangeResultSuccess", + "description": "The result of a successful note change. The `type` property is `'success'`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the note change was applied successfully." + } + ], + "value": "export interface NoteChangeResultSuccess {\n /**\n * Indicates that the note change was applied successfully.\n */\n type: 'success';\n}" + } + }, + "NoteChangeResultError": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "NoteChangeResultError", + "description": "The result of a failed note change. Check the `message` property for details about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the note change couldn't be applied. Check the `message` property for details." + } + ], + "value": "export interface NoteChangeResultError {\n /**\n * Indicates that the note change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" + } + }, + "NoteChangeResult": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "NoteChangeResult", + "value": "NoteChangeResultSuccess | NoteChangeResultError", + "description": "The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed.", + "isPublicDocs": true + } + }, + "AttributeUpdateChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "AttributeUpdateChange", + "description": "Updates an attribute on the cart and checkout. If an attribute with the provided key doesn't already exist, then it gets created.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The key of the attribute to add or update. If an attribute with this key already exists, then its value is replaced." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updateAttribute'", + "description": "Identifies this as an attribute update or creation. Set this when creating a change to add or replace an attribute value." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The new value for the attribute." + } + ], + "value": "export interface AttributeUpdateChange {\n /**\n * Identifies this as an attribute update or creation. Set this when creating a change to add or replace an attribute value.\n */\n type: 'updateAttribute';\n\n /**\n * The key of the attribute to add or update. If an attribute with this key\n * already exists, then its value is replaced.\n */\n key: string;\n\n /**\n * The new value for the attribute.\n */\n value: string;\n}" + } + }, + "AttributeRemoveChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "AttributeRemoveChange", + "description": "Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The key of the attribute to remove." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'removeAttribute'", + "description": "Identifies this as an attribute removal. Set this when creating a change to delete an attribute by key." + } + ], + "value": "export interface AttributeRemoveChange {\n /**\n * Identifies this as an attribute removal. Set this when creating a change to delete an attribute by key.\n */\n type: 'removeAttribute';\n\n /**\n * The key of the attribute to remove.\n */\n key: string;\n}" + } + }, + "AttributeChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AttributeChange", + "value": "AttributeUpdateChange | AttributeRemoveChange", + "description": "The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it.", + "isPublicDocs": true + } + }, + "AttributeChangeResultSuccess": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "AttributeChangeResultSuccess", + "description": "The result of a successful attribute change. The `type` property is `'success'`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the attribute change was applied successfully." + } + ], + "value": "export interface AttributeChangeResultSuccess {\n /**\n * Indicates that the attribute change was applied successfully.\n */\n type: 'success';\n}" + } + }, + "AttributeChangeResultError": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "AttributeChangeResultError", + "description": "The result of a failed attribute change. Check the `message` property for details about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the attribute change couldn't be applied. Check the `message` property for details." + } + ], + "value": "export interface AttributeChangeResultError {\n /**\n * Indicates that the attribute change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + } + }, + "AttributeChangeResult": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AttributeChangeResult", + "value": "AttributeChangeResultSuccess | AttributeChangeResultError", + "description": "The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed.", + "isPublicDocs": true + } + }, + "CartLineChangeResultSuccess": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "CartLineChangeResultSuccess", + "description": "The result of a successful cart line change. The `type` property is `'success'`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the cart line change was applied successfully." + } + ], + "value": "export interface CartLineChangeResultSuccess {\n /**\n * Indicates that the cart line change was applied successfully.\n */\n type: 'success';\n}" + } + }, + "CartLineChangeResultError": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "CartLineChangeResultError", + "description": "The result of a failed cart line change. Check the `message` property for details about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error." + } + ], + "value": "export interface CartLineChangeResultError {\n /**\n * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" + } + }, + "CartLineChangeResult": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CartLineChangeResult", + "value": "CartLineChangeResultSuccess | CartLineChangeResultError", + "description": "The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed.", + "isPublicDocs": true + } + }, + "CartLineChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CartLineChange", + "value": "CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange", + "description": "The input for `applyCartLinesChange()`. Use the `type` property to specify the operation.\n\n- `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart.\n- `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item.\n- `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes.", + "isPublicDocs": true + } + }, + "CartLineAddChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "CartLineAddChange", + "description": "Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "Attribute[]", + "description": "Custom key-value attributes to attach to the new line item.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "merchandiseId", + "value": "string", + "description": "The globally-unique identifier of the product variant to add.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/ProductVariant/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "parent", + "value": "{lineId: string} | {merchandiseId: string}", + "description": "The parent cart line to associate the new item with, identified by either `lineId` or `merchandiseId`. Use this when adding child items to a bundle.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "quantity", + "value": "number", + "description": "The number of items to add. Must be a positive integer." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "sellingPlanId", + "value": "string", + "description": "The identifier of the [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'addCartLine'", + "description": "Identifies this as a line item addition. Set this when creating a change to add a new product to the cart." + } + ], + "value": "export interface CartLineAddChange {\n /**\n * Identifies this as a line item addition. Set this when creating a change to add a new product to the cart.\n */\n type: 'addCartLine';\n\n /**\n * The globally-unique identifier of the product variant to add.\n * @example 'gid://shopify/ProductVariant/123'\n */\n merchandiseId: string;\n\n /**\n * The number of items to add. Must be a positive integer.\n */\n quantity: number;\n\n /**\n * Custom key-value attributes to attach to the new line item.\n */\n attributes?: Attribute[];\n\n /**\n * The identifier of the [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan.\n */\n sellingPlanId?: SellingPlan['id'];\n\n /**\n * The parent cart line to associate the new item with, identified by either `lineId` or `merchandiseId`. Use this when adding child items to a bundle.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" + } + }, + "CartLineRemoveChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "CartLineRemoveChange", + "description": "Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique identifier of the cart line to remove. Look up the current ID from `lines` before calling, because cart line IDs aren't stable.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/CartLine/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "quantity", + "value": "number", + "description": "The number of items to remove from this line." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'removeCartLine'", + "description": "Identifies this as a line item removal. Set this when creating a change to remove a product from the cart." + } + ], + "value": "export interface CartLineRemoveChange {\n /**\n * Identifies this as a line item removal. Set this when creating a change to remove a product from the cart.\n */\n type: 'removeCartLine';\n\n /**\n * The unique identifier of the cart line to remove. Look up the current ID from `lines` before calling, because cart line IDs aren't stable.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The number of items to remove from this line.\n */\n quantity: number;\n}" + } + }, + "CartLineUpdateChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "CartLineUpdateChange", + "description": "Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "Attribute[]", + "description": "The new custom key-value attributes for this line item. Replaces all existing attributes when provided.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "The unique identifier of the cart line to update. Look up the current ID from `lines` before calling, because cart line IDs aren't stable.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/CartLine/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "merchandiseId", + "value": "string", + "description": "The new product variant to swap in for this line item. Only provide this if you want to change the variant.", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'gid://shopify/ProductVariant/123'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "parent", + "value": "{lineId: string} | {merchandiseId: string}", + "description": "The parent cart line to associate this item with. Use this when updating the parent relationship for bundled items.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "quantity", + "value": "number", + "description": "The new quantity for this line item. Only provide this if you want to change the quantity.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "sellingPlanId", + "value": "SellingPlan['id'] | null", + "description": "The [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updateCartLine'", + "description": "Identifies this as a line item update. Set this when creating a change to modify a line item's quantity, variant, or attributes." + } + ], + "value": "export interface CartLineUpdateChange {\n /**\n * Identifies this as a line item update. Set this when creating a change to modify a line item's quantity, variant, or attributes.\n */\n type: 'updateCartLine';\n\n /**\n * The unique identifier of the cart line to update. Look up the current ID from `lines` before calling, because cart line IDs aren't stable.\n * @example 'gid://shopify/CartLine/123'\n */\n id: string;\n\n /**\n * The new product variant to swap in for this line item. Only provide this if you want to change the variant.\n * @example 'gid://shopify/ProductVariant/123'\n */\n\n merchandiseId?: string;\n /**\n * The new quantity for this line item. Only provide this if you want to change the quantity.\n */\n quantity?: number;\n\n /**\n * The new custom key-value attributes for this line item. Replaces all existing attributes when provided.\n */\n attributes?: Attribute[];\n\n /**\n * The [selling plan](/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan.\n */\n sellingPlanId?: SellingPlan['id'] | null;\n\n /**\n * The parent cart line to associate this item with. Use this when updating the parent relationship for bundled items.\n */\n parent?: {lineId: string} | {merchandiseId: string};\n}" + } + }, + "DiscountCodeChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DiscountCodeChange", + "value": "DiscountCodeAddChange | DiscountCodeRemoveChange", + "description": "The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it.", + "isPublicDocs": true + } + }, + "DiscountCodeAddChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "DiscountCodeAddChange", + "description": "Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The discount code to apply. Codes are case-insensitive." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'addDiscountCode'", + "description": "Identifies this as a discount code addition. Set this when creating a change to apply a discount code to the checkout." + } + ], + "value": "export interface DiscountCodeAddChange {\n /**\n * Identifies this as a discount code addition. Set this when creating a change to apply a discount code to the checkout.\n */\n type: 'addDiscountCode';\n\n /**\n * The discount code to apply. Codes are case-insensitive.\n */\n code: string;\n}" + } + }, + "DiscountCodeRemoveChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "DiscountCodeRemoveChange", + "description": "Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The discount code to remove. Codes are case-insensitive." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'removeDiscountCode'", + "description": "Identifies this as a discount code removal. Set this when creating a change to remove a discount code from the checkout." + } + ], + "value": "export interface DiscountCodeRemoveChange {\n /**\n * Identifies this as a discount code removal. Set this when creating a change to remove a discount code from the checkout.\n */\n type: 'removeDiscountCode';\n\n /**\n * The discount code to remove. Codes are case-insensitive.\n */\n code: string;\n}" + } + }, + "DiscountCodeChangeResult": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DiscountCodeChangeResult", + "value": "DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError", + "description": "The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed.", + "isPublicDocs": true + } + }, + "DiscountCodeChangeResultSuccess": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "DiscountCodeChangeResultSuccess", + "description": "The result of a successful discount code change. The `type` property is `'success'`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the discount code change was applied successfully." + } + ], + "value": "export interface DiscountCodeChangeResultSuccess {\n /**\n * Indicates that the discount code change was applied successfully.\n */\n type: 'success';\n}" + } + }, + "DiscountCodeChangeResultError": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "DiscountCodeChangeResultError", + "description": "The result of a failed discount code change. Check the `message` property for details about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the discount code change couldn't be applied. Check the `message` property for details." + } + ], + "value": "export interface DiscountCodeChangeResultError {\n /**\n * Indicates that the discount code change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + } + }, + "GiftCardChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "GiftCardChange", + "value": "GiftCardAddChange | GiftCardRemoveChange", + "description": "The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it.", + "isPublicDocs": true + } + }, + "GiftCardAddChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "GiftCardAddChange", + "description": "Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The full gift card code to apply to the checkout." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'addGiftCard'", + "description": "Identifies this as a gift card addition. Set this when creating a change to apply a gift card to the checkout." + } + ], + "value": "export interface GiftCardAddChange {\n /**\n * Identifies this as a gift card addition. Set this when creating a change to apply a gift card to the checkout.\n */\n type: 'addGiftCard';\n\n /**\n * The full gift card code to apply to the checkout.\n */\n code: string;\n}" + } + }, + "GiftCardRemoveChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "GiftCardRemoveChange", + "description": "Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "code", + "value": "string", + "description": "The gift card code to remove. You can pass either the full code or just the last four characters." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'removeGiftCard'", + "description": "Identifies this as a gift card removal. Set this when creating a change to remove a gift card from the checkout." + } + ], + "value": "export interface GiftCardRemoveChange {\n /**\n * Identifies this as a gift card removal. Set this when creating a change to remove a gift card from the checkout.\n */\n type: 'removeGiftCard';\n\n /**\n * The gift card code to remove. You can pass either the full code or\n * just the last four characters.\n */\n code: string;\n}" + } + }, + "GiftCardChangeResult": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "GiftCardChangeResult", + "value": "GiftCardChangeResultSuccess | GiftCardChangeResultError", + "description": "The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed.", + "isPublicDocs": true + } + }, + "GiftCardChangeResultSuccess": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "GiftCardChangeResultSuccess", + "description": "The result of a successful gift card change. The `type` property is `'success'`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the gift card change was applied successfully." + } + ], + "value": "export interface GiftCardChangeResultSuccess {\n /**\n * Indicates that the gift card change was applied successfully.\n */\n type: 'success';\n}" + } + }, + "GiftCardChangeResultError": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "GiftCardChangeResultError", + "description": "The result of a failed gift card change. Check the `message` property for details about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the gift card change couldn't be applied. Check the `message` property for details." + } + ], + "value": "export interface GiftCardChangeResultError {\n /**\n * Indicates that the gift card change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" + } + }, + "MetafieldRemoveCartChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "MetafieldRemoveCartChange", + "description": "Removes a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "The name of the metafield to remove." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "The namespace of the metafield to remove.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'removeCartMetafield'", + "description": "Identifies this as a cart metafield removal. Set this when creating a change to delete an existing metafield by key and namespace." + } + ], + "value": "export interface MetafieldRemoveCartChange {\n /**\n * Identifies this as a cart metafield removal. Set this when creating a change to delete an existing metafield by key and namespace.\n */\n type: 'removeCartMetafield';\n\n /**\n * The name of the metafield to remove.\n */\n key: string;\n\n /**\n * The namespace of the metafield to remove.\n */\n namespace?: string;\n}" + } + }, + "MetafieldUpdateCartChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "MetafieldUpdateCartChange", + "description": "Creates or updates a cart [metafield](/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "metafield", + "value": "{ key: string; namespace?: string; value: string; type: string; }", + "description": "The metafield data to set on the cart. If a metafield with this key and namespace already exists, then its value is replaced." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updateCartMetafield'", + "description": "Identifies this as a cart metafield creation or update. Set this when creating a change to set a metafield value." + } + ], + "value": "export interface MetafieldUpdateCartChange {\n /**\n * Identifies this as a cart metafield creation or update. Set this when creating a change to set a metafield value.\n */\n type: 'updateCartMetafield';\n\n /**\n * The metafield data to set on the cart. If a metafield with this key and namespace already exists, then its value is replaced.\n */\n metafield: {\n /** The name of the metafield to update. */\n key: string;\n\n /** The namespace of the metafield to update. */\n namespace?: string;\n\n /** The new information to store in the metafield. */\n value: string;\n\n /**\n * The metafield’s information type.\n * See the [metafield types documentation](/docs/apps/build/custom-data/metafields/list-of-data-types) for a list of supported types.\n */\n type: string;\n };\n}" + } + }, + "MetafieldChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldChange", + "value": "MetafieldRemoveCartChange | MetafieldUpdateCartChange", + "description": "The input for `applyMetafieldChange()`. Use the `type` property to specify the operation.\n\n- `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](/docs/apps/build/custom-data/metafields).\n- `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield.", + "isPublicDocs": true + } + }, + "MetafieldChangeResultSuccess": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "MetafieldChangeResultSuccess", + "description": "The result of a successful metafield change. The `type` property is `'success'`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the metafield change was applied successfully." + } + ], + "value": "export interface MetafieldChangeResultSuccess {\n /**\n * Indicates that the metafield change was applied successfully.\n */\n type: 'success';\n}" + } + }, + "MetafieldChangeResultError": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "MetafieldChangeResultError", + "description": "The result of a failed metafield change. Check the `message` property for details about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer.\n\nRender your own localized error text rather than displaying this message to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the metafield change couldn't be applied. Check the `message` property for details." + } + ], + "value": "export interface MetafieldChangeResultError {\n /**\n * Indicates that the metafield change couldn't be applied. Check the `message` property for details.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n *\n * Render your own localized error text rather than displaying this message\n * to the buyer.\n */\n message: string;\n}" + } + }, + "MetafieldChangeResult": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MetafieldChangeResult", + "value": "MetafieldChangeResultSuccess | MetafieldChangeResultError", + "description": "The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed.", + "isPublicDocs": true + } + }, + "ShippingAddressUpdateChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "ShippingAddressUpdateChange", + "description": "Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "address", + "value": "Partial", + "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update. Any fields you don't list keep their current values." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updateShippingAddress'", + "description": "Identifies this as a shipping address update. This is the only supported change type for `applyShippingAddressChange()`." + } + ], + "value": "export interface ShippingAddressUpdateChange {\n /**\n * Identifies this as a shipping address update. This is the only supported change type for `applyShippingAddressChange()`.\n */\n type: 'updateShippingAddress';\n\n /**\n * Fields to update in the shipping address. You only need to provide\n * values for the fields you want to update. Any fields you don't list\n * keep their current values.\n */\n address: Partial;\n}" + } + }, + "ShippingAddressChange": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ShippingAddressChange", + "value": "ShippingAddressUpdateChange", + "description": "The input for `applyShippingAddressChange()`. Currently only supports `ShippingAddressUpdateChange` (with `type: 'updateShippingAddress'`).", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "address", + "value": "Partial", + "description": "Fields to update in the shipping address. You only need to provide values for the fields you want to update. Any fields you don't list keep their current values." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updateShippingAddress'", + "description": "Identifies this as a shipping address update. This is the only supported change type for `applyShippingAddressChange()`." + } + ] + } + }, + "ShippingAddressChangeResultSuccess": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "ShippingAddressChangeResultSuccess", + "description": "The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "errors", + "value": "null", + "description": "Always `null` for a successful address change. Present so that you can check `result.errors` without narrowing the union type first." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the shipping address change was applied successfully." + } + ], + "value": "export interface ShippingAddressChangeResultSuccess {\n /**\n * Indicates that the shipping address change was applied successfully.\n */\n type: 'success';\n\n /**\n * Always `null` for a successful address change. Present so that you can\n * check `result.errors` without narrowing the union type first.\n */\n errors: null;\n}" + } + }, + "ShippingAddressChangeFieldError": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "ShippingAddressChangeFieldError", + "description": "An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "field", + "value": "keyof MailingAddress", + "description": "The `MailingAddress` field that caused the error, such as `'countryCode'` or `'zip'`. The value is `undefined` if the error isn't specific to a single field.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It isn't localized and shouldn't be displayed to the buyer." + } + ], + "value": "export interface ShippingAddressChangeFieldError {\n /**\n * The `MailingAddress` field that caused the error, such as `'countryCode'` or `'zip'`. The value is `undefined` if the error isn't specific to a single field.\n */\n field?: keyof MailingAddress;\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It isn't localized and shouldn't be displayed to the buyer.\n */\n message: string;\n}" + } + }, + "ShippingAddressChangeResultError": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "ShippingAddressChangeResultError", + "description": "The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "errors", + "value": "ShippingAddressChangeFieldError[]", + "description": "The list of field-level errors that prevented the address change. Each entry identifies which address field failed and why." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the shipping address change couldn't be applied. Check the `errors` array for field-level details." + } + ], + "value": "export interface ShippingAddressChangeResultError {\n /**\n * Indicates that the shipping address change couldn't be applied. Check the `errors` array for field-level details.\n */\n type: 'error';\n\n /**\n * The list of field-level errors that prevented the address change. Each entry identifies which address field failed and why.\n */\n errors: ShippingAddressChangeFieldError[];\n}" + } + }, + "ShippingAddressChangeResult": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ShippingAddressChangeResult", + "value": "ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError", + "description": "The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details.", + "isPublicDocs": true + } + }, + "CheckoutApi": { + "src/surfaces/checkout/api/checkout/checkout.ts": { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "name": "CheckoutApi", + "description": "Methods for modifying the checkout, including cart lines, discount codes, gift cards, metafields, notes, attributes, and the shipping address. Each method returns a promise that resolves with a result indicating success or failure.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "MethodSignature", + "name": "applyAttributeChange", + "value": "(change: AttributeChange) => Promise", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "deprecationMessage": "Use cart metafields instead." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "MethodSignature", + "name": "applyCartLinesChange", + "value": "(change: CartLineChange) => Promise", + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "MethodSignature", + "name": "applyDiscountCodeChange", + "value": "(change: DiscountCodeChange) => Promise", + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "MethodSignature", + "name": "applyGiftCardChange", + "value": "(change: GiftCardChange) => Promise", + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "MethodSignature", + "name": "applyMetafieldChange", + "value": "(change: MetafieldChange) => Promise", + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "MethodSignature", + "name": "applyNoteChange", + "value": "(change: NoteChange) => Promise", + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "MethodSignature", + "name": "applyShippingAddressChange", + "value": "(change: ShippingAddressUpdateChange) => Promise", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/checkout/checkout.ts", + "syntaxKind": "PropertySignature", + "name": "experimentalIsShopAppStyle", + "value": "boolean", + "description": "", + "isOptional": true, + "isPrivate": true + } + ], + "value": "export interface CheckoutApi {\n /**\n * Updates or removes an attribute on the cart and checkout. On success, the\n * [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * @deprecated Use cart metafields instead.\n */\n applyAttributeChange(change: AttributeChange): Promise;\n\n /**\n * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n *\n * Accepts a single change per call. To make multiple changes, call this\n * method separately for each one.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyCartLinesChange(change: CartLineChange): Promise;\n\n /**\n * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyDiscountCodeChange(\n change: DiscountCodeChange,\n ): Promise;\n\n /**\n * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n *\n * Unlike other write operations, gift card changes aren't gated by a cart\n * instruction flag.\n *\n * > Caution:\n * > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n *\n * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyGiftCardChange(change: GiftCardChange): Promise;\n\n /**\n * Creates, updates, or removes a cart metafield on the checkout. On success, the\n * [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n *\n * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyMetafieldChange(change: MetafieldChange): Promise;\n\n /**\n * Sets or removes the buyer's note on the checkout. On success, the\n * [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note)\n * property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n */\n applyNoteChange(change: NoteChange): Promise;\n\n /**\n * @private\n */\n experimentalIsShopAppStyle?: boolean;\n\n /**\n * Updates the buyer's shipping address on the checkout. The provided fields\n * are merged into the existing address without prompting the buyer. On success,\n * the `shippingAddress` property updates to reflect the change.\n *\n * > Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n applyShippingAddressChange?(\n change: ShippingAddressChange,\n ): Promise;\n}" + } + }, + "OrderConfirmation": { + "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts": { + "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", + "name": "OrderConfirmation", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", + "syntaxKind": "PropertySignature", + "name": "isFirstOrder", + "value": "boolean", + "description": "Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers." + }, + { + "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", + "syntaxKind": "PropertySignature", + "name": "number", + "value": "string", + "description": "A randomly generated alpha-numeric identifier for the order, distinct from `order.id`. The value is `undefined` for orders that were created before this field was introduced. All recent orders have a number.\n\nOptional. Might not be present for orders created before 2024.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", + "syntaxKind": "PropertySignature", + "name": "order", + "value": "{ id: string; }", + "description": "" + } + ], + "value": "export interface OrderConfirmation {\n order: {\n /**\n * A globally unique identifier for the order. This becomes the\n * [`Order`](/docs/api/admin-graphql/latest/objects/Order) object ID in the\n * GraphQL Admin API after the order is created.\n *\n * @example 'gid://shopify/Order/123'\n */\n id: string;\n };\n /**\n * A randomly generated alpha-numeric identifier for the order, distinct\n * from `order.id`. The value is `undefined` for orders that were created\n * before this field was introduced. All recent orders have a number.\n *\n * Optional. Might not be present for orders created before 2024.\n */\n number?: string;\n\n /**\n * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers.\n */\n isFirstOrder: boolean;\n}" + } + }, + "OrderConfirmationApi": { + "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts": { + "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", + "name": "OrderConfirmationApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/order-confirmation/order-confirmation.ts", + "syntaxKind": "PropertySignature", + "name": "orderConfirmation", + "value": "SubscribableSignalLike", + "description": "The order details available after the buyer completes checkout, including the order ID, order number, and whether it's the buyer's first purchase." + } + ], + "value": "export interface OrderConfirmationApi {\n /**\n * The order details available after the buyer completes checkout, including the order ID, order number, and whether it's the buyer's first purchase.\n */\n orderConfirmation: SubscribableSignalLike;\n}" + } + }, + "CartLineItemApi": { + "src/surfaces/checkout/api/cart-line/cart-line-item.ts": { + "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", + "name": "CartLineItemApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/cart-line/cart-line-item.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "SubscribableSignalLike", + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + } + ], + "value": "export interface CartLineItemApi {\n /**\n * The cart line that this extension is attached to. Use this to read the\n * line item's merchandise, quantity, cost, and attributes.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n *\n * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`.\n */\n target: SubscribableSignalLike;\n}" + } + }, + "PickupLocationListApi": { + "src/surfaces/checkout/api/pickup/pickup-location-list.ts": { + "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", + "name": "PickupLocationListApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/pickup/pickup-location-list.ts", + "syntaxKind": "PropertySignature", + "name": "isLocationFormVisible", + "value": "SubscribableSignalLike", + "description": "Whether the location search form is currently visible to the buyer. Use this to conditionally render UI that depends on the buyer actively searching for pickup locations." + } + ], + "value": "export interface PickupLocationListApi {\n /**\n * Whether the location search form is currently visible to the buyer.\n * Use this to conditionally render UI that depends on the buyer actively\n * searching for pickup locations.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + } + }, + "PickupPointListApi": { + "src/surfaces/checkout/api/pickup/pickup-point-list.ts": { + "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", + "name": "PickupPointListApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/pickup/pickup-point-list.ts", + "syntaxKind": "PropertySignature", + "name": "isLocationFormVisible", + "value": "SubscribableSignalLike", + "description": "Reflects which view was active when the extension loaded. When the buyer moves to the next view, the extension restarts with the current value rather than updating in place." + } + ], + "value": "export interface PickupPointListApi {\n /**\n * Reflects which view was active when the extension loaded. When the\n * buyer moves to the next view, the extension restarts with the\n * current value rather than updating in place.\n */\n isLocationFormVisible: SubscribableSignalLike;\n}" + } + }, + "PickupLocationItemApi": { + "src/surfaces/checkout/api/pickup/pickup-location-item.ts": { + "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", + "name": "PickupLocationItemApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", + "syntaxKind": "PropertySignature", + "name": "isTargetSelected", + "value": "SubscribableSignalLike", + "description": "Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." + }, + { + "filePath": "src/surfaces/checkout/api/pickup/pickup-location-item.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "SubscribableSignalLike", + "description": "The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." + } + ], + "value": "export interface PickupLocationItemApi {\n /**\n * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n}" + } + }, + "ShippingOptionItemApi": { + "src/surfaces/checkout/api/shipping/shipping-option-item.ts": { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", + "name": "ShippingOptionItemApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "isTargetSelected", + "value": "SubscribableSignalLike", + "description": "Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." + }, + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "renderMode", + "value": "ShippingOptionItemRenderMode", + "description": "The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.", + "deprecationMessage": "Do not rely on render context. This target can render inside an overlay, so use inline UI instead of opening overlays such as modals." + }, + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "SubscribableSignalLike", + "description": "The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties." + } + ], + "value": "export interface ShippingOptionItemApi {\n /**\n * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n target: SubscribableSignalLike;\n\n /**\n * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option.\n *\n * Available only on the corresponding item target. Shipping option item\n * targets expose shipping option properties; pickup location item targets\n * expose pickup location properties.\n */\n isTargetSelected: SubscribableSignalLike;\n\n /**\n * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI.\n *\n * @deprecated Do not rely on render context. This target can render inside an overlay, so use inline UI instead of opening overlays such as modals.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + } + }, + "ShippingOptionItemRenderMode": { + "src/surfaces/checkout/api/shipping/shipping-option-item.ts": { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", + "name": "ShippingOptionItemRenderMode", + "description": "The render mode of a shipping option.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "overlay", + "value": "boolean", + "description": "Whether the shipping option is rendered in an overlay. When `true`, the extension appears in a modal or sheet on top of the checkout page. When `false`, the extension renders inline within the shipping options list.", + "deprecationMessage": "Do not rely on render context. Use inline UI instead of opening overlays such as modals." + } + ], + "value": "export interface ShippingOptionItemRenderMode {\n /**\n * Whether the shipping option is rendered in an overlay. When `true`, the extension appears in a modal or sheet on top of the checkout page. When `false`, the extension renders inline within the shipping options list.\n *\n * @deprecated Do not rely on render context. Use inline UI instead of opening overlays such as modals.\n */\n overlay: boolean;\n}" + } + }, + "ShippingOptionListApi": { + "src/surfaces/checkout/api/shipping/shipping-option-list.ts": { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "name": "ShippingOptionListApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "deliverySelectionGroups", + "value": "SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >", + "description": "The list of delivery selection groups available to the buyer, which let buyers choose between grouped delivery options. The value is `undefined` when no selection groups are available." + }, + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "SubscribableSignalLike", + "description": "The delivery group list that this extension is attached to. Use this to access all delivery groups and their options. The value is `undefined` when there aren't any delivery groups for the given type." + } + ], + "value": "export interface ShippingOptionListApi {\n /**\n * The delivery group list that this extension is attached to. Use this to access all delivery groups and their options. The value is `undefined` when there aren't any delivery groups for the given type.\n */\n target: SubscribableSignalLike;\n /**\n * The list of delivery selection groups available to the buyer, which let buyers choose between grouped delivery options. The value is `undefined` when no selection groups are available.\n */\n deliverySelectionGroups: SubscribableSignalLike<\n DeliverySelectionGroup[] | undefined\n >;\n}" + } + }, + "DeliverySelectionGroup": { + "src/surfaces/checkout/api/shipping/shipping-option-list.ts": { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "name": "DeliverySelectionGroup", + "description": "A named group of delivery options that the buyer can select as a unit.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "associatedDeliveryOptions", + "value": "DeliveryOptionReference[]", + "description": "The delivery options that belong to this selection group. Each reference's `handle` matches a delivery option handle in the associated delivery group." + }, + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "cost", + "value": "Money", + "description": "The combined cost of all delivery options in this group before discounts." + }, + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "costAfterDiscounts", + "value": "Money", + "description": "The combined cost of all delivery options in this group after discounts have been applied. This is what the buyer actually pays." + }, + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "handle", + "value": "string", + "description": "A unique identifier for this selection group." + }, + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the buyer has selected this delivery selection group. When `true`, the associated delivery options are active. When `false`, the buyer has selected a different group." + }, + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The localized display title of this selection group, suitable for rendering in the checkout UI." + } + ], + "value": "export interface DeliverySelectionGroup {\n /**\n * A unique identifier for this selection group.\n */\n handle: string;\n /**\n * Whether the buyer has selected this delivery selection group. When `true`, the associated delivery options are active. When `false`, the buyer has selected a different group.\n */\n selected: boolean;\n /**\n * The localized display title of this selection group, suitable for rendering in the checkout UI.\n */\n title: string;\n /**\n * The delivery options that belong to this selection group. Each reference's `handle` matches a delivery option handle in the associated delivery group.\n */\n associatedDeliveryOptions: DeliveryOptionReference[];\n /**\n * The combined cost of all delivery options in this group before discounts.\n */\n cost: Money;\n /**\n * The combined cost of all delivery options in this group after discounts have been applied. This is what the buyer actually pays.\n */\n costAfterDiscounts: Money;\n}" + } + }, + "DeliveryGroupList": { + "src/surfaces/checkout/api/shipping/shipping-option-list.ts": { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "name": "DeliveryGroupList", + "description": "A collection of delivery groups that share the same group type.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "deliveryGroups", + "value": "DeliveryGroup[]", + "description": "The delivery groups in this list. Each group contains cart lines and available delivery options for those items." + }, + { + "filePath": "src/surfaces/checkout/api/shipping/shipping-option-list.ts", + "syntaxKind": "PropertySignature", + "name": "groupType", + "value": "DeliveryGroupType", + "description": "The type of delivery groups in this list. This is the same `DeliveryGroupType` used on `DeliveryGroup.groupType`.\n\n- `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n- `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries." + } + ], + "value": "export interface DeliveryGroupList {\n /**\n * The type of delivery groups in this list. This is the same `DeliveryGroupType` used on `DeliveryGroup.groupType`.\n *\n * - `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.\n * - `'subscription'`: Items bought through a [selling plan](/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.\n */\n groupType: DeliveryGroupType;\n /**\n * The delivery groups in this list. Each group contains cart lines and available delivery options for those items.\n */\n deliveryGroups: DeliveryGroup[];\n}" + } + }, + "AutocompleteAddress": { + "src/surfaces/checkout/api/address-autocomplete/shared.ts": { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "name": "AutocompleteAddress", + "description": "An address object used to auto-populate the address form fields.\n\nAll fields are optional", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "address1", + "value": "string", + "description": "The first line of the street address, including the street number and name. The value is `undefined` if the buyer hasn't entered an address yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'151 O'Connor Street'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "address2", + "value": "string", + "description": "The second line of the buyer's address, such as apartment number, suite, or unit. The value is `undefined` if the buyer didn't provide a second address line.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Ground floor'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "city", + "value": "string", + "description": "The city, town, or village of the address. The value is `undefined` if the buyer hasn't entered a city yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Ottawa'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "company", + "value": "string", + "description": "The buyer's company name. The value is `undefined` if the buyer didn't enter a company or the store doesn't collect company names.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'Shopify'", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "countryCode", + "value": "CountryCode", + "description": "The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if the buyer hasn't selected a country yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'CA' for Canada.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "latitude", + "value": "number", + "description": "The latitude coordinates of the buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "43.6556377", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "longitude", + "value": "number", + "description": "The longitude coordinates of the buyer.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "-79.38681079999999", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "provinceCode", + "value": "string", + "description": "The province, state, prefecture, or region code of the address. The format varies by country. The value is `undefined` if the buyer hasn't selected one yet or the country doesn't have provinces.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'ON' for Ontario.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "zip", + "value": "string", + "description": "The postal code or ZIP code of the address, used for mail sorting and delivery routing. The value is `undefined` if the buyer hasn't entered one yet or the country doesn't use postal codes.\n\n{% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'K2P 2L8'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface AutocompleteAddress\n extends Pick<\n MailingAddress,\n | 'address1'\n | 'address2'\n | 'city'\n | 'company'\n | 'countryCode'\n | 'provinceCode'\n | 'zip'\n > {\n /**\n * The latitude coordinates of the buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example 43.6556377\n */\n latitude?: number;\n\n /**\n * The longitude coordinates of the buyer.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * @example -79.38681079999999\n */\n longitude?: number;\n}" + } + }, + "AddressAutocompleteSuggestion": { + "src/surfaces/checkout/api/address-autocomplete/shared.ts": { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "name": "AddressAutocompleteSuggestion", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "formattedAddress", + "value": "AutocompleteAddress", + "description": "The address object used to auto-populate the remaining address fields.\n\nIf this value is returned for every suggestion, then the `purchase.address-autocomplete.format-suggestion` extension target is not needed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A textual identifier that uniquely identifies an autocomplete suggestion or address. This identifier may be used to search for a formatted address.", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "\"35ef8d55-dceb-4ed8-847b-2f2fc7472f14\"", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The address suggestion text presented to the buyer in the list of autocomplete suggestions.\n\nThis text is shown to the buyer as-is. No attempts will be made to parse it.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "\"123 Main St, Toronto, ON, CA\"", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "matchedSubstrings", + "value": "MatchedSubstring[]", + "description": "A list of substrings that matched the original search query.\n\nIf `matchedSubstrings` are provided, then they will be used to highlight the substrings of the suggestions that matched the original search query.", + "isOptional": true, + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "[{offset: 0, length: 4}]", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface AddressAutocompleteSuggestion {\n /**\n * The address suggestion text presented to the buyer in the list of autocomplete suggestions.\n *\n * This text is shown to the buyer as-is. No attempts will be made to parse it.\n *\n * @example \"123 Main St, Toronto, ON, CA\"\n */\n label: string;\n\n /**\n * A textual identifier that uniquely identifies an autocomplete suggestion\n * or address. This identifier may be used to search for a formatted address.\n *\n * @example \"35ef8d55-dceb-4ed8-847b-2f2fc7472f14\"\n */\n id?: string;\n\n /**\n * A list of substrings that matched the original search query.\n *\n * If `matchedSubstrings` are provided, then they will be used to highlight the substrings\n * of the suggestions that matched the original search query.\n *\n * @example [{offset: 0, length: 4}]\n */\n matchedSubstrings?: MatchedSubstring[];\n\n /**\n * The address object used to auto-populate the remaining address fields.\n *\n * If this value is returned for every suggestion, then the\n * `purchase.address-autocomplete.format-suggestion` extension target is not needed.\n */\n formattedAddress?: AutocompleteAddress;\n}" + } + }, + "MatchedSubstring": { + "src/surfaces/checkout/api/address-autocomplete/shared.ts": { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "name": "MatchedSubstring", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "length", + "value": "number", + "description": "The length of the matched substring in the suggestion label text." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/shared.ts", + "syntaxKind": "PropertySignature", + "name": "offset", + "value": "number", + "description": "The start location of the matched substring in the suggestion label text." + } + ], + "value": "export interface MatchedSubstring {\n /**\n * The start location of the matched substring in the suggestion label text.\n */\n offset: number;\n /**\n * The length of the matched substring in the suggestion label text.\n */\n length: number;\n}" + } + }, + "AddressAutocompleteFormatSuggestionApi": { + "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts": { + "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", + "name": "AddressAutocompleteFormatSuggestionApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "Target", + "description": "The autocomplete suggestion that the buyer selected during checkout.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + } + ], + "value": "export interface AddressAutocompleteFormatSuggestionApi {\n /**\n * The autocomplete suggestion that the buyer selected during checkout.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n target: Target;\n}" + } + }, + "Target": { + "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts": { + "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", + "name": "Target", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", + "syntaxKind": "PropertySignature", + "name": "selectedSuggestion", + "value": "AddressAutocompleteSuggestion", + "description": "" + } + ], + "value": "interface Target {\n selectedSuggestion: AddressAutocompleteSuggestion;\n}" + } + }, + "AddressAutocompleteFormatSuggestionOutput": { + "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts": { + "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", + "name": "AddressAutocompleteFormatSuggestionOutput", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts", + "syntaxKind": "PropertySignature", + "name": "formattedAddress", + "value": "AutocompleteAddress", + "description": "The formatted address that will be used to populate the native address fields." + } + ], + "value": "export interface AddressAutocompleteFormatSuggestionOutput {\n /**\n * The formatted address that will be used to populate the native address fields.\n */\n formattedAddress: AutocompleteAddress;\n}" + } + }, + "AddressAutocompleteSuggestApi": { + "src/surfaces/checkout/api/address-autocomplete/suggest.ts": { + "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", + "name": "AddressAutocompleteSuggestApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", + "syntaxKind": "PropertySignature", + "name": "signal", + "value": "AbortSignal", + "description": "The signal that the extension should listen to for cancellation requests.\n\nIf the signal is aborted, the extension should cancel any ongoing requests. The signal will be aborted either when the buyer navigates away from the address field or when the debounced query value changes.\n\nPass this signal to any asynchronous operations that need to be cancelled, like `fetch`." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "Target", + "description": "The current state of the address form that the buyer is interacting with.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + } + ], + "value": "export interface AddressAutocompleteSuggestApi {\n /**\n * The signal that the extension should listen to for cancellation requests.\n *\n * If the signal is aborted, the extension should cancel any ongoing requests.\n * The signal will be aborted either when the buyer navigates away from the\n * address field or when the debounced query value changes.\n *\n * Pass this signal to any asynchronous operations that need to be cancelled,\n * like `fetch`.\n */\n signal: AbortSignal;\n\n /**\n * The current state of the address form that the buyer is interacting with.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n target: Target;\n}" + } + }, + "AddressAutocompleteSuggestOutput": { + "src/surfaces/checkout/api/address-autocomplete/suggest.ts": { + "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", + "name": "AddressAutocompleteSuggestOutput", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/suggest.ts", + "syntaxKind": "PropertySignature", + "name": "suggestions", + "value": "AddressAutocompleteSuggestion[]", + "description": "An array of address autocomplete suggestions to show to the buyer. Checkout displays up to five address suggestions. Return no more than five. Additional suggestions are ignored." + } + ], + "value": "export interface AddressAutocompleteSuggestOutput {\n /**\n * An array of address autocomplete suggestions to show to the buyer.\n * Checkout displays up to five address suggestions. Return no more\n * than five. Additional suggestions are ignored.\n */\n suggestions: AddressAutocompleteSuggestion[];\n}" + } + }, + "AddressAutocompleteStandardApi": { + "src/surfaces/checkout/api/address-autocomplete/standard.ts": { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "name": "AddressAutocompleteStandardApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "analytics", + "value": "Analytics", + "description": "The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "appMetafields", + "value": "AppMetafieldEntry[]", + "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n\n> Tip: > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*" + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "Attribute[] | undefined", + "description": "The custom attributes left by the customer to the merchant, either in their cart or during checkout." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "billingAddress", + "value": "MailingAddress | undefined", + "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "checkoutToken", + "value": "CheckoutToken | undefined", + "description": "A stable ID that represents the current checkout.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object)." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "Extension", + "description": "The meta information about the extension." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating content and formatting values according to the current [`localization`](/docs/api/checkout-ui-extensions/apis/localization) Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n\nRefer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples) for more information." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "localization", + "value": "Localization", + "description": "The details about the location, language, and currency of the customer. For utilities to easily format and translate content based on these details, you can use the [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n) object instead." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "The method used to query the Storefront GraphQL API with a prefetched token.\n\nRefer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "sessionToken", + "value": "SessionToken", + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of 5 minutes.\n\nIf the previous token expires, this value will reflect a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "settings", + "value": "ExtensionSettings", + "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n\n> Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor)." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "shippingAddress", + "value": "MailingAddress | undefined", + "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke.\n\n> Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "shop", + "value": "Shop", + "description": "The shop where the checkout is taking place." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "The key-value storage for the extension.\n\nIt uses `localStorage` and should persist across the customer's current checkout session.\n\n> Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, each activated extension target had its own storage." + }, + { + "filePath": "src/surfaces/checkout/api/address-autocomplete/standard.ts", + "syntaxKind": "PropertySignature", + "name": "version", + "value": "Version", + "description": "The runner version being used for the extension.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'unstable'", + "title": "Example" + } + ] + } + ] + } + ], + "value": "export interface AddressAutocompleteStandardApi<\n Target extends\n | 'purchase.address-autocomplete.suggest'\n | 'purchase.address-autocomplete.format-suggestion',\n> {\n /**\n * The metafields requested in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration)\n * file. These metafields are updated when there's a change in the merchandise items\n * being purchased by the customer.\n *\n * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n *\n * > Tip:\n * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*\n */\n appMetafields: AppMetafieldEntry[];\n\n /**\n * The methods for interacting with [Web Pixels](/docs/apps/marketing), such as emitting an event.\n */\n analytics: Analytics;\n\n /**\n * The custom attributes left by the customer to the merchant, either in their cart or during checkout.\n */\n attributes: Attribute[] | undefined;\n\n /**\n * The proposed customer billing address. The address updates when the field is\n * committed (on change) rather than every keystroke.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n billingAddress?: MailingAddress | undefined;\n\n /**\n * A stable ID that represents the current checkout.\n *\n * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data)\n * and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n */\n checkoutToken: CheckoutToken | undefined;\n\n /**\n * The meta information about the extension.\n */\n extension: Extension;\n\n /**\n * Utilities for translating content and formatting values according to the current\n * [`localization`](/docs/api/checkout-ui-extensions/apis/localization)\n * Type 'RunnableExtensionInstance' is not assignable to type 'ExtensionInstance'.\n *\n * Refer to [`localization` examples](/docs/api/checkout-ui-extensions/apis/localization#examples)\n * for more information.\n */\n i18n: I18n;\n\n /**\n * The details about the location, language, and currency of the customer. For utilities to easily\n * format and translate content based on these details, you can use the\n * [`i18n`](/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n)\n * object instead.\n */\n localization: Localization;\n\n /**\n * The method used to query the Storefront GraphQL API with a prefetched token.\n *\n * Refer to [Storefront API access examples](/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.\n */\n query: >(\n query: string,\n options?: {variables?: Variables; version?: StorefrontApiVersion},\n ) => Promise<{data?: Data; errors?: GraphQLError[]}>;\n\n /**\n * The session token providing a set of claims as a signed JSON Web Token (JWT).\n *\n * The token has a TTL of 5 minutes.\n *\n * If the previous token expires, this value will reflect a new session token with a new signature and expiry.\n *\n * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).\n */\n sessionToken: SessionToken;\n\n /**\n * The settings matching the settings definition written in the\n * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/configuration) file.\n *\n * Refer to [settings examples](/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.\n *\n * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).\n\n */\n settings: ExtensionSettings;\n\n /**\n * The proposed customer shipping address. During the information step,\n * the address updates when the field is committed (on change) rather than every keystroke.\n *\n * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.\n *\n * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).\n */\n shippingAddress?: MailingAddress | undefined;\n\n /** The shop where the checkout is taking place. */\n shop: Shop;\n\n /**\n * The key-value storage for the extension.\n *\n * It uses `localStorage` and should persist across the customer's current checkout session.\n *\n * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.\n *\n * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,\n * each activated extension target had its own storage.\n */\n storage: Storage;\n\n /**\n * The runner version being used for the extension.\n *\n * @example 'unstable'\n */\n version: Version;\n}" + } + }, + "PaymentMethodAttributesResult": { + "src/surfaces/checkout/api/payment/payment-option-item.ts": { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PaymentMethodAttributesResult", + "value": "PaymentMethodAttributesResultSuccess | PaymentMethodAttributesResultError", + "description": "", + "isPublicDocs": true + } + }, + "PaymentMethodAttributesResultSuccess": { + "src/surfaces/checkout/api/payment/payment-option-item.ts": { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "name": "PaymentMethodAttributesResultSuccess", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'success'", + "description": "Indicates that the payment method attributes were set successfully." + } + ], + "value": "export interface PaymentMethodAttributesResultSuccess {\n /**\n * Indicates that the payment method attributes were set successfully.\n */\n type: 'success';\n}" + } + }, + "PaymentMethodAttributesResultError": { + "src/surfaces/checkout/api/payment/payment-option-item.ts": { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "name": "PaymentMethodAttributesResultError", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "message", + "value": "string", + "description": "A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer." + }, + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'error'", + "description": "Indicates that the payment method attributes were not set successfully." + } + ], + "value": "export interface PaymentMethodAttributesResultError {\n /**\n * Indicates that the payment method attributes were not set successfully.\n */\n type: 'error';\n\n /**\n * A message that explains the error. This message is useful for debugging.\n * It is **not** localized, and therefore should not be presented directly\n * to the buyer.\n */\n message: string;\n}" + } + }, + "PaymentMethodAttribute": { + "src/surfaces/checkout/api/payment/payment-option-item.ts": { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "name": "PaymentMethodAttribute", + "description": "A key-value pair that represents an attribute of a payment method.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string | number | boolean", + "description": "" + } + ], + "value": "export interface PaymentMethodAttribute {\n key: string;\n value: string | number | boolean;\n}" + } + }, + "PaymentMethodAttributesChange": { + "src/surfaces/checkout/api/payment/payment-option-item.ts": { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PaymentMethodAttributesChange", + "value": "PaymentMethodAttributesUpdateChange", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "PaymentMethodAttribute[]", + "description": "The payment method attributes" + }, + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updatePaymentMethodAttributes'", + "description": "The type of the `PaymentMethodAttributesChange` API." + } + ] + } + }, + "PaymentMethodAttributesUpdateChange": { + "src/surfaces/checkout/api/payment/payment-option-item.ts": { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "name": "PaymentMethodAttributesUpdateChange", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "PaymentMethodAttribute[]", + "description": "The payment method attributes" + }, + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'updatePaymentMethodAttributes'", + "description": "The type of the `PaymentMethodAttributesChange` API." + } + ], + "value": "export interface PaymentMethodAttributesUpdateChange {\n /**\n * The type of the `PaymentMethodAttributesChange` API.\n */\n type: 'updatePaymentMethodAttributes';\n\n /**\n * The payment method attributes\n */\n attributes: PaymentMethodAttribute[];\n}" + } + }, + "PaymentOptionItemApi": { + "src/surfaces/checkout/api/payment/payment-option-item.ts": { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "name": "PaymentOptionItemApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "MethodSignature", + "name": "applyPaymentMethodAttributesChange", + "value": "(change: PaymentMethodAttributesUpdateChange) => Promise", + "description": "Sets the attributes of the related payment method." + }, + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "bankIdNumber", + "value": "SubscribableSignalLike", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/payment/payment-option-item.ts", + "syntaxKind": "PropertySignature", + "name": "paymentMethodAttributes", + "value": "SubscribableSignalLike<\n PaymentMethodAttribute[] | undefined\n >", + "description": "", + "isOptional": true + } + ], + "value": "export interface PaymentOptionItemApi {\n /**\n * Sets the attributes of the related payment method.\n */\n applyPaymentMethodAttributesChange(\n change: PaymentMethodAttributesChange,\n ): Promise;\n paymentMethodAttributes?: SubscribableSignalLike<\n PaymentMethodAttribute[] | undefined\n >;\n bankIdNumber?: SubscribableSignalLike;\n}" + } + }, + "Resolution": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Resolution", + "value": "1 | 1.3 | 1.5 | 2 | 2.6 | 3 | 3.5 | 4", + "description": "", + "isPublicDocs": true + } + }, + "InteractiveConditions": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "name": "InteractiveConditions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "true", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "hover", + "value": "true", + "description": "" + } + ], + "value": "export interface InteractiveConditions {\n hover: true;\n focus: true;\n}" + } + }, + "ResolutionCondition": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "name": "ResolutionCondition", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "resolution", + "value": "Resolution", + "description": "" + } + ], + "value": "export interface ResolutionCondition {\n resolution: Resolution;\n}" + } + }, + "ViewportInlineSize": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ViewportInlineSize", + "value": "'extraSmall' | 'small' | 'medium' | 'large'", + "description": "", + "isPublicDocs": true + } + }, + "ViewportSizeCondition": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "name": "ViewportSizeCondition", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "viewportInlineSize", + "value": "{ min: T; }", + "description": "" + } + ], + "value": "export interface ViewportSizeCondition {\n viewportInlineSize: {min: T};\n}" + } + }, + "AtLeastOne": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AtLeastOne", + "value": "Partial & U[keyof U]", + "description": "", + "isPublicDocs": true + } + }, + "DefaultConditions": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "DefaultConditions", + "value": "InteractiveConditions & ViewportSizeCondition", + "description": "", + "isPublicDocs": true + } + }, + "Conditions": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "Conditions", + "value": "AtLeastOne", + "description": "", + "isPublicDocs": true + } + }, + "BaseConditions": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BaseConditions", + "value": "AtLeastOne<\n DefaultConditions & ResolutionCondition\n>", + "description": "", + "isPublicDocs": true + } + }, + "StylesBaseConditions": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "name": "StylesBaseConditions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "true", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "hover", + "value": "true", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "resolution", + "value": "1 | 1.3 | 1.5 | 2 | 2.6 | 3 | 3.5 | 4", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "viewportInlineSize", + "value": "{ min: ViewportInlineSize; }", + "description": "", + "isOptional": true + } + ], + "value": "export interface StylesBaseConditions {\n viewportInlineSize?: {min: ViewportInlineSize};\n hover?: true;\n focus?: true;\n resolution?: 1 | 1.3 | 1.5 | 2 | 2.6 | 3 | 3.5 | 4;\n}" + } + }, + "StylesConditions": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "name": "StylesConditions", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "true", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "hover", + "value": "true", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "viewportInlineSize", + "value": "{ min: ViewportInlineSize; }", + "description": "", + "isOptional": true + } + ], + "value": "export interface StylesConditions {\n viewportInlineSize?: {min: ViewportInlineSize};\n hover?: true;\n focus?: true;\n}" + } + }, + "StylesConditionalValue": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "name": "StylesConditionalValue", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "conditions", + "value": "AcceptedConditions", + "description": "The conditions that must be met for the value to be applied. At least one condition must be specified." + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "T", + "description": "The value that will be applied if the conditions are met." + } + ], + "value": "export interface StylesConditionalValue<\n T,\n AcceptedConditions extends StylesBaseConditions = StylesBaseConditions,\n> {\n /**\n * The conditions that must be met for the value to be applied. At least one\n * condition must be specified.\n */\n conditions: AcceptedConditions;\n /**\n * The value that will be applied if the conditions are met.\n */\n value: T;\n}" + } + }, + "StylesConditionalStyle": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "name": "StylesConditionalStyle", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "conditionals", + "value": "StylesConditionalValue[]", + "description": "An array of conditional values." + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "default", + "value": "T", + "description": "The default value applied when none of the conditional values specified in `conditionals` are met.", + "isOptional": true + } + ], + "value": "export interface StylesConditionalStyle<\n T,\n AcceptedConditions extends StylesBaseConditions = StylesBaseConditions,\n> {\n /**\n * The default value applied when none of the conditional values\n * specified in `conditionals` are met.\n */\n default?: T;\n /**\n * An array of conditional values.\n */\n conditionals: StylesConditionalValue[];\n}" + } + }, + "ConditionalValue": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "name": "ConditionalValue", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "conditions", + "value": "AcceptedConditions", + "description": "The conditions that must be met for the value to be applied. At least one condition must be specified." + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "T", + "description": "The value that will be applied if the conditions are met." + } + ], + "value": "export interface ConditionalValue<\n T,\n AcceptedConditions extends BaseConditions = Conditions,\n> {\n /**\n * The conditions that must be met for the value to be applied. At least one\n * condition must be specified.\n */\n conditions: AcceptedConditions;\n /**\n * The value that will be applied if the conditions are met.\n */\n value: T;\n}" + } + }, + "ConditionalStyle": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "name": "ConditionalStyle", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "conditionals", + "value": "ConditionalValue[]", + "description": "An array of conditional values." + }, + { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "PropertySignature", + "name": "default", + "value": "T", + "description": "The default value applied when none of the conditional values specified in `conditionals` are met.", + "isOptional": true + } + ], + "value": "export interface ConditionalStyle<\n T,\n AcceptedConditions extends BaseConditions = Conditions,\n> {\n /**\n * The default value applied when none of the conditional values\n * specified in `conditionals` are met.\n */\n default?: T;\n /**\n * An array of conditional values.\n */\n conditionals: ConditionalValue[];\n}" + } + }, + "MaybeConditionalStyle": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeConditionalStyle", + "value": "T | ConditionalStyle", + "description": "A type that represents a value that can be a conditional style. We highly recommend using the `Style` helper which simplifies the creation of conditional styles.", + "isPublicDocs": true + } + }, + "MaybeResponsiveConditionalStyle": { + "src/surfaces/checkout/style/types.ts": { + "filePath": "src/surfaces/checkout/style/types.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeResponsiveConditionalStyle", + "value": "T | ConditionalStyle", + "description": "A type that represents a value that can be a conditional style. The conditions are based on the viewport size. We highly recommend using the `Style` helper which simplifies the creation of conditional styles.", + "isPublicDocs": true + } + }, + "DocsStyle": { + "src/surfaces/checkout/style/style.ts": { + "filePath": "src/surfaces/checkout/style/style.ts", + "name": "DocsStyle", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/style/style.ts", + "syntaxKind": "PropertySignature", + "name": "default", + "value": "(defaultValue: T) => StylesConditionalStyle", + "description": "Sets an optional default value to use when no other condition is met." + }, + { + "filePath": "src/surfaces/checkout/style/style.ts", + "syntaxKind": "PropertySignature", + "name": "when", + "value": "(conditions: StylesConditions, value: T) => StylesConditionalStyle", + "description": "Adjusts the style based on different conditions. All conditions, expressed as a literal object, must be met for the associated value to be applied.\n\nThe `when` method can be chained together to build more complex styles." + } + ], + "value": "export interface DocsStyle {\n /**\n * Sets an optional default value to use when no other condition is met.\n *\n * @param defaultValue The default value\n * @returns The chainable condition style\n */\n default: (defaultValue: T) => StylesConditionalStyle;\n /**\n * Adjusts the style based on different conditions. All conditions, expressed\n * as a literal object, must be met for the associated value to be applied.\n *\n * The `when` method can be chained together to build more complex styles.\n *\n * @param conditions The condition(s)\n * @param value The conditional value that can be applied if the conditions are met\n * @returns The chainable condition style\n */\n when: (\n conditions: StylesConditions,\n value: T,\n ) => StylesConditionalStyle;\n}" + } + }, + "ShopifyGlobal": { + "src/surfaces/checkout/globals.ts": { + "filePath": "src/surfaces/checkout/globals.ts", + "name": "ShopifyGlobal", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/globals.ts", + "syntaxKind": "MethodSignature", + "name": "extend", + "value": "(target: ExtensionTarget, extend: () => ExtensionTargets[ExtensionTarget][\"output\"]) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/globals.ts", + "syntaxKind": "MethodSignature", + "name": "reload", + "value": "() => void", + "description": "" + } + ], + "value": "export interface ShopifyGlobal {\n extend(\n target: ExtensionTarget,\n extend: () => ExtensionTargets[ExtensionTarget]['output'],\n ): void;\n reload(): void;\n}" + } + }, + "ExtensionTarget": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ExtensionTarget", + "value": "keyof ExtensionTargets", + "description": "", + "isPublicDocs": true + } + }, + "ExtensionTargets": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "name": "ExtensionTargets", + "description": "A union of all extension targets. This is a special interface that is referenced by name \"ExtensionTargets\", in the `buildTargetDts.ts` script in ui-extensions. It is used to to generate the `shopify.d.ts` file, to provide type safety when coding UI extensions.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Actions::RenderBefore", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately before any actions within each step.", + "deprecationMessage": "Use `purchase.checkout.actions.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::CartLineDetails::RenderAfter", + "value": "RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every line item, inside the details under the line item properties element.", + "deprecationMessage": "Use `purchase.checkout.cart-line-item.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::CartLineDetails::RenderLineComponents", + "value": "RenderExtension<\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.", + "deprecationMessage": "Use `purchase.cart-line-item.line-components.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::CartLines::RenderAfter", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after all line items.", + "deprecationMessage": "Use `purchase.checkout.cart-line-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Contact::RenderAfter", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately after the contact form element.", + "deprecationMessage": "Use `purchase.checkout.contact.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::CustomerInformation::RenderAfter", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after a purchase below the customer information.", + "deprecationMessage": "Use `purchase.thank-you.customer-information.render-after` or\n`customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::DeliveryAddress::RenderBefore", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered between the shipping address header and shipping address form elements.", + "deprecationMessage": "Use `purchase.checkout.delivery-address.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Dynamic::Render", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", + "deprecationMessage": "Use `purchase.checkout.block.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::GiftCard::Render", + "value": "RenderExtension<\n RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.", + "deprecationMessage": "Use `purchase.checkout.gift-card.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PaymentMethod::HostedFields::RenderAfter", + "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders after the hosted fields of a credit card payment method. for a credit card payment method when selected by the buyer.", + "deprecationMessage": "Use `purchase.checkout.payment-option-item.hosted-fields.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PaymentMethod::Render", + "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders the form fields for a payment method when selected by the buyer.", + "deprecationMessage": "Use `purchase.checkout.payment-option-item.details.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PaymentMethod::RenderRequiredAction", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders a form modal when a buyer selects the custom onsite payment method.", + "deprecationMessage": "Use `purchase.checkout.payment-option-item.action-required.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PickupLocations::RenderAfter", + "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after pickup location options.", + "deprecationMessage": "Use `purchase.checkout.pickup-location-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PickupLocations::RenderBefore", + "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered before pickup location options.", + "deprecationMessage": "Use `purchase.checkout.pickup-location-list.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PickupPoints::RenderAfter", + "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately after the pickup points.", + "deprecationMessage": "Use `purchase.checkout.pickup-point-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PickupPoints::RenderBefore", + "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately before the pickup points.", + "deprecationMessage": "Use `purchase.checkout.pickup-point-list.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Reductions::RenderAfter", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered in the order summary, after the discount form and discount tag elements.", + "deprecationMessage": "Use `purchase.checkout.reductions.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Reductions::RenderBefore", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered in the order summary, before the discount form element.", + "deprecationMessage": "Use `purchase.checkout.reductions.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ShippingMethodDetails::RenderAfter", + "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping method details within the shipping method option list, for each option.", + "deprecationMessage": "Use `purchase.checkout.shipping-option-item.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ShippingMethodDetails::RenderExpanded", + "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered under the shipping method within the shipping method option list, for each option.", + "deprecationMessage": "Use `purchase.checkout.shipping-option-item.details.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ShippingMethods::RenderAfter", + "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping method options.", + "deprecationMessage": "Use `purchase.checkout.shipping-option-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ShippingMethods::RenderBefore", + "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered between the shipping method header and shipping method options.", + "deprecationMessage": "Use `purchase.checkout.shipping-option-list.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ThankYou::CartLineDetails::RenderAfter", + "value": "RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page.", + "deprecationMessage": "Use `purchase.thank-you.cart-line-item.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ThankYou::CartLines::RenderAfter", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after all line items on the **Thank you** page.", + "deprecationMessage": "Use `purchase.thank-you.cart-line-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ThankYou::CustomerInformation::RenderAfter", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.", + "deprecationMessage": "Use `purchase.thank-you.customer-information.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ThankYou::Dynamic::Render", + "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", + "deprecationMessage": "Use `purchase.thank-you.block.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.address-autocomplete.format-suggestion", + "value": "RunnableExtension<\n AddressAutocompleteStandardApi<'purchase.address-autocomplete.format-suggestion'> &\n AddressAutocompleteFormatSuggestionApi,\n AddressAutocompleteFormatSuggestionOutput\n >", + "description": "An extension target that formats the selected address suggestion provided by a `purchase.address-autocomplete.suggest` target. This address is used to auto-populate the fields in the address form.\n\nIt must return a formatted address.\n\nThis target does not support rendering UI components." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.address-autocomplete.suggest", + "value": "RunnableExtension<\n AddressAutocompleteStandardApi<'purchase.address-autocomplete.suggest'> &\n AddressAutocompleteSuggestApi,\n AddressAutocompleteSuggestOutput\n >", + "description": "An extension target that provides address autocomplete suggestions. These suggestions are shown to buyers as they interact with address forms during checkout.\n\nIt must return a list of address suggestions. If a formatted address is provided with each suggestion, it will be used to auto-populate the fields in the address form when the buyer selects a suggestion.\n\nThis target does not support rendering UI components." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.cart-line-item.line-components.render", + "value": "RenderExtension<\n CartLineItemApi &\n StandardApi<'purchase.cart-line-item.line-components.render'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.actions.render-before", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately before any actions within each step." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.block.render", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.cart-line-item.render-after", + "value": "RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'purchase.checkout.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every line item, inside the details under the line item properties element." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.cart-line-list.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after all line items." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.chat.render", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,\n AllowedComponents<'Chat'>\n >", + "description": "A static extension target that is rendered on top of the checkout page as an overlay. It is positioned in the bottom right corner of the screen." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.contact.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately after the contact form element." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.delivery-address.render-after", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping address form elements." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.delivery-address.render-before", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered between the shipping address header and shipping address form elements." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.footer.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered below the footer." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.gift-card.render", + "value": "RenderExtension<\n RedeemableApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.gift-card.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.header.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered below the header." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-method-list.render-after", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders below the list of payment methods." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-method-list.render-before", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders between the payment heading and payment method list." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-option-item.action-required.render", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders a form modal when a buyer selects the custom onsite payment method.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-option-item.details.render", + "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.details.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders the form fields for a payment method when selected by the buyer.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-option-item.hosted-fields.render-after", + "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders after the hosted fields of a credit card payment method.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-location-list.render-after", + "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after pickup location options." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-location-list.render-before", + "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered before pickup location options." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-location-option-item.render-after", + "value": "RenderExtension<\n PickupLocationItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the pickup location details within the local pickup option list, for each option." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-point-list.render-after", + "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately after the pickup points." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-point-list.render-before", + "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately before the pickup points." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.reductions.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered in the order summary, after the discount form and discount tag elements." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.reductions.render-before", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered in the order summary, before the discount form element." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.shipping-option-item.details.render", + "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.details.render'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered under the shipping method within the shipping method option list, for each option." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.shipping-option-item.render-after", + "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping method details within the shipping method option list, for each option." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.shipping-option-list.render-after", + "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping method options." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.shipping-option-list.render-before", + "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered between the shipping method header and shipping method options." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.announcement.render", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.announcement.render'>,\n AnyThankYouComponent\n >", + "description": "A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.block.render", + "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.cart-line-item.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'purchase.thank-you.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.cart-line-list.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after all line items on the **Thank you** page." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.chat.render", + "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,\n AllowedComponents<'Chat'>\n >", + "description": "A static extension target that is rendered on top of the **Thank you page** as an overlay. It is positioned in the bottom right corner of the screen." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.customer-information.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.customer-information.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after a purchase below the customer information on the **Thank you** page." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.footer.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.footer.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered below the footer on the **Thank you** page." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.header.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.header.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered below the header on the **Thank you** page." + } + ], + "value": "export interface ExtensionTargets\n extends RenderExtensionTargets,\n RunnableExtensionTargets {}" + } + }, + "RenderExtension": { + "src/extension.ts": { + "filePath": "src/extension.ts", + "name": "RenderExtension", + "description": "Defines the structure of a render extension, which displays UI in the Shopify admin.", + "members": [ + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "api", + "value": "Api", + "description": "The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "components", + "value": "ComponentsSet", + "description": "The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "output", + "value": "void | Promise", + "description": "The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads." + } + ], + "value": "export interface RenderExtension {\n /**\n * The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying.\n */\n api: Api;\n /**\n * The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target.\n */\n components: ComponentsSet;\n /**\n * The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads.\n */\n output: void | Promise;\n}" + } + }, + "AnyCheckoutComponent": { + "src/surfaces/checkout/shared.ts": { + "filePath": "src/surfaces/checkout/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyCheckoutComponent", + "value": "'Abbreviation' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Chat' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField'", + "description": "The list of supported components. As of October 1st, 2025, this is a subset of the components that will be available in the 2025-10 stable release." + } + }, + "AnyCheckoutComponentExcept": { + "src/surfaces/checkout/shared.ts": { + "filePath": "src/surfaces/checkout/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyCheckoutComponentExcept", + "value": "'Abbreviation' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Chat' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField'", + "description": "" + } + }, + "RunnableExtension": { + "src/extension.ts": { + "filePath": "src/extension.ts", + "name": "RunnableExtension", + "description": "Defines the structure of a runnable extension, which executes logic and returns data without rendering UI.", + "members": [ + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "api", + "value": "Api", + "description": "The API object providing access to extension capabilities and methods. The specific API type depends on the extension target and determines what functionality is available to your extension." + }, + { + "filePath": "src/extension.ts", + "syntaxKind": "PropertySignature", + "name": "output", + "value": "Output | Promise", + "description": "The function output. Your extension function should return the expected output type or a Promise that resolves to that type. The output type is determined by your specific extension target and use case." + } + ], + "value": "export interface RunnableExtension {\n /**\n * The API object providing access to extension capabilities and methods. The specific API type depends on the extension target and determines what functionality is available to your extension.\n */\n api: Api;\n /**\n * The function output. Your extension function should return the expected output type or a Promise that resolves to that type. The output type is determined by your specific extension target and use case.\n */\n output: Output | Promise;\n}" + } + }, + "AllowedComponents": { + "src/surfaces/checkout/shared.ts": { + "filePath": "src/surfaces/checkout/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AllowedComponents", + "value": "Allowed", + "description": "" + } + }, + "AnyThankYouComponent": { + "src/surfaces/checkout/shared.ts": { + "filePath": "src/surfaces/checkout/shared.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyThankYouComponent", + "value": "'Abbreviation' | 'Announcement' | 'Badge' | 'Banner' | 'Box' | 'Button' | 'Chat' | 'Checkbox' | 'Chip' | 'Choice' | 'ChoiceList' | 'Clickable' | 'ClickableChip' | 'ClipboardItem' | 'ConsentCheckbox' | 'ConsentPhoneField' | 'DateField' | 'DatePicker' | 'Details' | 'Divider' | 'DropZone' | 'EmailField' | 'Form' | 'Grid' | 'GridItem' | 'Heading' | 'Icon' | 'Image' | 'Link' | 'ListItem' | 'Map' | 'MapMarker' | 'Modal' | 'MoneyField' | 'NumberField' | 'Option' | 'OrderedList' | 'Paragraph' | 'PasswordField' | 'PaymentIcon' | 'PhoneField' | 'Popover' | 'PressButton' | 'ProductThumbnail' | 'Progress' | 'QueryContainer' | 'QRCode' | 'ScrollBox' | 'Section' | 'Select' | 'Sheet' | 'SkeletonParagraph' | 'Spinner' | 'Stack' | 'Summary' | 'Switch' | 'Text' | 'TextArea' | 'TextField' | 'Time' | 'Tooltip' | 'UnorderedList' | 'UrlField'", + "description": "" + } + }, + "RenderExtensionTargets": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "name": "RenderExtensionTargets", + "description": "A UI extension will register for one or more extension targets using `shopify.extend()`. An extension target in a UI extension is a plain JavaScript function. This function receives some API for interacting with the application, and is expected to return a value in a specific shape. The input arguments and the output type are different for each extension target.", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Actions::RenderBefore", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately before any actions within each step.", + "deprecationMessage": "Use `purchase.checkout.actions.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::CartLineDetails::RenderAfter", + "value": "RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every line item, inside the details under the line item properties element.", + "deprecationMessage": "Use `purchase.checkout.cart-line-item.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::CartLineDetails::RenderLineComponents", + "value": "RenderExtension<\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.", + "deprecationMessage": "Use `purchase.cart-line-item.line-components.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::CartLines::RenderAfter", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after all line items.", + "deprecationMessage": "Use `purchase.checkout.cart-line-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Contact::RenderAfter", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately after the contact form element.", + "deprecationMessage": "Use `purchase.checkout.contact.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::CustomerInformation::RenderAfter", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after a purchase below the customer information.", + "deprecationMessage": "Use `purchase.thank-you.customer-information.render-after` or\n`customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::DeliveryAddress::RenderBefore", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered between the shipping address header and shipping address form elements.", + "deprecationMessage": "Use `purchase.checkout.delivery-address.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Dynamic::Render", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", + "deprecationMessage": "Use `purchase.checkout.block.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::GiftCard::Render", + "value": "RenderExtension<\n RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.", + "deprecationMessage": "Use `purchase.checkout.gift-card.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PaymentMethod::HostedFields::RenderAfter", + "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders after the hosted fields of a credit card payment method. for a credit card payment method when selected by the buyer.", + "deprecationMessage": "Use `purchase.checkout.payment-option-item.hosted-fields.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PaymentMethod::Render", + "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders the form fields for a payment method when selected by the buyer.", + "deprecationMessage": "Use `purchase.checkout.payment-option-item.details.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PaymentMethod::RenderRequiredAction", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders a form modal when a buyer selects the custom onsite payment method.", + "deprecationMessage": "Use `purchase.checkout.payment-option-item.action-required.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PickupLocations::RenderAfter", + "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after pickup location options.", + "deprecationMessage": "Use `purchase.checkout.pickup-location-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PickupLocations::RenderBefore", + "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered before pickup location options.", + "deprecationMessage": "Use `purchase.checkout.pickup-location-list.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PickupPoints::RenderAfter", + "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately after the pickup points.", + "deprecationMessage": "Use `purchase.checkout.pickup-point-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::PickupPoints::RenderBefore", + "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately before the pickup points.", + "deprecationMessage": "Use `purchase.checkout.pickup-point-list.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Reductions::RenderAfter", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered in the order summary, after the discount form and discount tag elements.", + "deprecationMessage": "Use `purchase.checkout.reductions.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::Reductions::RenderBefore", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered in the order summary, before the discount form element.", + "deprecationMessage": "Use `purchase.checkout.reductions.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ShippingMethodDetails::RenderAfter", + "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping method details within the shipping method option list, for each option.", + "deprecationMessage": "Use `purchase.checkout.shipping-option-item.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ShippingMethodDetails::RenderExpanded", + "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered under the shipping method within the shipping method option list, for each option.", + "deprecationMessage": "Use `purchase.checkout.shipping-option-item.details.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ShippingMethods::RenderAfter", + "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping method options.", + "deprecationMessage": "Use `purchase.checkout.shipping-option-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ShippingMethods::RenderBefore", + "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderBefore'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered between the shipping method header and shipping method options.", + "deprecationMessage": "Use `purchase.checkout.shipping-option-list.render-before` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ThankYou::CartLineDetails::RenderAfter", + "value": "RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page.", + "deprecationMessage": "Use `purchase.thank-you.cart-line-item.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ThankYou::CartLines::RenderAfter", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after all line items on the **Thank you** page.", + "deprecationMessage": "Use `purchase.thank-you.cart-line-list.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ThankYou::CustomerInformation::RenderAfter", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.", + "deprecationMessage": "Use `purchase.thank-you.customer-information.render-after` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "Checkout::ThankYou::Dynamic::Render", + "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).", + "deprecationMessage": "Use `purchase.thank-you.block.render` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.cart-line-item.line-components.render", + "value": "RenderExtension<\n CartLineItemApi &\n StandardApi<'purchase.cart-line-item.line-components.render'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every bundle line item, inside the details under the line item properties element. It replaces the default bundle products rendering.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.actions.render-before", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately before any actions within each step." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.block.render", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.cart-line-item.render-after", + "value": "RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'purchase.checkout.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every line item, inside the details under the line item properties element." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.cart-line-list.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after all line items." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.chat.render", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,\n AllowedComponents<'Chat'>\n >", + "description": "A static extension target that is rendered on top of the checkout page as an overlay. It is positioned in the bottom right corner of the screen." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.contact.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately after the contact form element." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.delivery-address.render-after", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping address form elements." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.delivery-address.render-before", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered between the shipping address header and shipping address form elements." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.footer.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered below the footer." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.gift-card.render", + "value": "RenderExtension<\n RedeemableApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.gift-card.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders the gift card entry form fields after the buyer ticks a box to use a gift card. This does not replace the native gift card entry form which is rendered in a separate part of checkout.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.header.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered below the header." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-method-list.render-after", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders below the list of payment methods." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-method-list.render-before", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders between the payment heading and payment method list." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-option-item.action-required.render", + "value": "RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders a form modal when a buyer selects the custom onsite payment method.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-option-item.details.render", + "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.details.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >", + "description": "A static extension target that renders the form fields for a payment method when selected by the buyer.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.payment-option-item.hosted-fields.render-after", + "value": "RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders after the hosted fields of a credit card payment method.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-location-list.render-after", + "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after pickup location options." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-location-list.render-before", + "value": "RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered before pickup location options." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-location-option-item.render-after", + "value": "RenderExtension<\n PickupLocationItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the pickup location details within the local pickup option list, for each option." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-point-list.render-after", + "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately after the pickup points." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.pickup-point-list.render-before", + "value": "RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered immediately before the pickup points." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.reductions.render-after", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered in the order summary, after the discount form and discount tag elements." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.reductions.render-before", + "value": "RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered in the order summary, before the discount form element." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.shipping-option-item.details.render", + "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.details.render'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered under the shipping method within the shipping method option list, for each option." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.shipping-option-item.render-after", + "value": "RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping method details within the shipping method option list, for each option." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.shipping-option-list.render-after", + "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after the shipping method options." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.checkout.shipping-option-list.render-before", + "value": "RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-before'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered between the shipping method header and shipping method options." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.announcement.render", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.announcement.render'>,\n AnyThankYouComponent\n >", + "description": "A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.block.render", + "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >", + "description": "A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n\nThe [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets)." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.cart-line-item.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'purchase.thank-you.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that renders on every line item, inside the details under the line item properties element on the **Thank you** page." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.cart-line-list.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after all line items on the **Thank you** page." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.chat.render", + "value": "RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,\n AllowedComponents<'Chat'>\n >", + "description": "A static extension target that is rendered on top of the **Thank you page** as an overlay. It is positioned in the bottom right corner of the screen." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.customer-information.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.customer-information.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered after a purchase below the customer information on the **Thank you** page." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.footer.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.footer.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered below the footer on the **Thank you** page." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.thank-you.header.render-after", + "value": "RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.header.render-after'>,\n AnyCheckoutComponent\n >", + "description": "A static extension target that is rendered below the header on the **Thank you** page." + } + ], + "value": "export interface RenderExtensionTargets {\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n */\n 'purchase.checkout.actions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.actions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before any actions within each step.\n *\n * @deprecated Use `purchase.checkout.actions.render-before` instead.\n * @private\n */\n 'Checkout::Actions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Actions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n */\n 'purchase.checkout.cart-line-list.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items.\n *\n * @deprecated Use `purchase.checkout.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::CartLines::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n */\n 'purchase.checkout.cart-line-item.render-after': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'purchase.checkout.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element.\n *\n * @deprecated Use `purchase.checkout.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderAfter': RenderExtension<\n CheckoutApi &\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n * @private\n */\n 'purchase.cart-line-item.line-components.render': RenderExtension<\n CartLineItemApi &\n StandardApi<'purchase.cart-line-item.line-components.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every bundle line item, inside the details\n * under the line item properties element. It replaces the default bundle products rendering.\n *\n * @deprecated Use `purchase.cart-line-item.line-components.render` instead.\n * @private\n */\n 'Checkout::CartLineDetails::RenderLineComponents': RenderExtension<\n CartLineItemApi &\n StandardApi<'Checkout::CartLineDetails::RenderLineComponents'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n */\n 'purchase.checkout.contact.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.contact.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the contact form element.\n *\n * @deprecated Use `purchase.checkout.contact.render-after` instead.\n * @private\n */\n 'Checkout::Contact::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Contact::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` or\n * `customer-account.order-status.customer-information.render-after` from `@shopify/ui-extension/customer-account` instead.\n * @private\n */\n 'Checkout::CustomerInformation::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping address header\n * and shipping address form elements.\n *\n * @deprecated Use `purchase.checkout.delivery-address.render-before` instead.\n * @private\n */\n 'Checkout::DeliveryAddress::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::DeliveryAddress::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping address form elements.\n */\n 'purchase.checkout.delivery-address.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.delivery-address.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n */\n 'purchase.checkout.block.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.checkout.block.render` instead.\n * @private\n */\n 'Checkout::Dynamic::Render': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n */\n 'purchase.thank-you.block.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.block.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page.\n * Unlike static extension targets, block extension targets render where the merchant\n * sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor).\n *\n * The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development\n * by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).\n *\n * @deprecated Use `purchase.thank-you.block.render` instead.\n * @private\n */\n 'Checkout::ThankYou::Dynamic::Render': RenderExtension<\n OrderConfirmationApi & StandardApi<'Checkout::ThankYou::Dynamic::Render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-item.render-after': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'purchase.thank-you.cart-line-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders on every line item, inside the details\n * under the line item properties element on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-item.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLineDetails::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n CartLineItemApi &\n StandardApi<'Checkout::ThankYou::CartLineDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n */\n 'purchase.thank-you.cart-line-list.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.cart-line-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after all line items on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.cart-line-list.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CartLines::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CartLines::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n */\n 'purchase.thank-you.customer-information.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.customer-information.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.\n *\n * @deprecated Use `purchase.thank-you.customer-information.render-after` instead.\n * @private\n */\n 'Checkout::ThankYou::CustomerInformation::RenderAfter': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'Checkout::ThankYou::CustomerInformation::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n */\n 'purchase.checkout.gift-card.render': RenderExtension<\n RedeemableApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.gift-card.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the gift card entry form fields after\n * the buyer ticks a box to use a gift card. This does not replace the\n * native gift card entry form which is rendered in a separate part of checkout.\n *\n * @private\n * @deprecated Use `purchase.checkout.gift-card.render` instead.\n */\n 'Checkout::GiftCard::Render': RenderExtension<\n RedeemableApi & CheckoutApi & StandardApi<'Checkout::GiftCard::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.details.render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.details.render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders the form fields for a payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.details.render` instead.\n */\n 'Checkout::PaymentMethod::Render': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::Render'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.hosted-fields.render-after': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.hosted-fields.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders after the hosted fields of a credit card payment method.\n * for a credit card payment method when selected by the buyer.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.hosted-fields.render-after` instead.\n */\n 'Checkout::PaymentMethod::HostedFields::RenderAfter': RenderExtension<\n PaymentOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::PaymentMethod::HostedFields::RenderAfter'>,\n AnyCheckoutComponentExcept<'Image' | 'Banner'>\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n */\n 'purchase.checkout.payment-option-item.action-required.render': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-option-item.action-required.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders a form modal when a buyer selects the custom onsite payment method.\n *\n * @private\n * @deprecated Use `purchase.checkout.payment-option-item.action-required.render` instead.\n */\n 'Checkout::PaymentMethod::RenderRequiredAction': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::PaymentMethod::RenderRequiredAction'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders between the payment heading and payment method list.\n *\n */\n 'purchase.checkout.payment-method-list.render-before': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that renders below the list of payment methods.\n *\n */\n 'purchase.checkout.payment-method-list.render-after': RenderExtension<\n CheckoutApi &\n StandardApi<'purchase.checkout.payment-method-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n */\n 'purchase.checkout.reductions.render-before': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, before the discount form element.\n *\n * @deprecated Use `purchase.checkout.reductions.render-before` instead.\n * @private\n */\n 'Checkout::Reductions::RenderBefore': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n */\n 'purchase.checkout.reductions.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.reductions.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered in the order summary, after the discount form\n * and discount tag elements.\n *\n * @deprecated Use `purchase.checkout.reductions.render-after` instead.\n * @private\n */\n 'Checkout::Reductions::RenderAfter': RenderExtension<\n CheckoutApi & StandardApi<'Checkout::Reductions::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n */\n 'purchase.checkout.shipping-option-list.render-before': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered between the shipping method\n * header and shipping method options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-before` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderBefore': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n */\n 'purchase.checkout.shipping-option-list.render-after': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * options.\n *\n * @deprecated Use `purchase.checkout.shipping-option-list.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethods::RenderAfter': RenderExtension<\n ShippingOptionListApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethods::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-before': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered before pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderBefore': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n */\n 'purchase.checkout.pickup-location-list.render-after': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after pickup location options.\n *\n * @deprecated Use `purchase.checkout.pickup-location-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupLocations::RenderAfter': RenderExtension<\n PickupLocationListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupLocations::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.render-after': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the shipping method\n * details within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.render-after` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderAfter': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n */\n 'purchase.checkout.shipping-option-item.details.render': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.shipping-option-item.details.render'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered under the shipping method\n * within the shipping method option list, for each option.\n *\n * @deprecated Use `purchase.checkout.shipping-option-item.details.render` instead.\n * @private\n */\n 'Checkout::ShippingMethodDetails::RenderExpanded': RenderExtension<\n ShippingOptionItemApi &\n CheckoutApi &\n StandardApi<'Checkout::ShippingMethodDetails::RenderExpanded'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-before': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-before'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately before the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-before` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderBefore': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderBefore'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n */\n 'purchase.checkout.pickup-point-list.render-after': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-point-list.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered immediately after the pickup points.\n *\n * @deprecated Use `purchase.checkout.pickup-point-list.render-after` instead.\n * @private\n */\n 'Checkout::PickupPoints::RenderAfter': RenderExtension<\n PickupPointListApi &\n CheckoutApi &\n StandardApi<'Checkout::PickupPoints::RenderAfter'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered after the pickup location\n * details within the local pickup option list, for each option.\n */\n 'purchase.checkout.pickup-location-option-item.render-after': RenderExtension<\n PickupLocationItemApi &\n CheckoutApi &\n StandardApi<'purchase.checkout.pickup-location-option-item.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the header.\n */\n 'purchase.checkout.header.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer.\n */\n 'purchase.checkout.footer.render-after': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the checkout page as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.checkout.chat.render': RenderExtension<\n CheckoutApi & StandardApi<'purchase.checkout.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered below the header on the **Thank you** page.\n */\n 'purchase.thank-you.header.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.header.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered below the footer on the **Thank you** page.\n */\n 'purchase.thank-you.footer.render-after': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.footer.render-after'>,\n AnyCheckoutComponent\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as an overlay.\n * It is positioned in the bottom right corner of the screen.\n */\n 'purchase.thank-you.chat.render': RenderExtension<\n OrderConfirmationApi & StandardApi<'purchase.thank-you.chat.render'>,\n AllowedComponents<'Chat'>\n >;\n /**\n * A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement.\n */\n 'purchase.thank-you.announcement.render': RenderExtension<\n OrderConfirmationApi &\n StandardApi<'purchase.thank-you.announcement.render'>,\n AnyThankYouComponent\n >;\n}" + } + }, + "RunnableExtensionTargets": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "name": "RunnableExtensionTargets", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.address-autocomplete.format-suggestion", + "value": "RunnableExtension<\n AddressAutocompleteStandardApi<'purchase.address-autocomplete.format-suggestion'> &\n AddressAutocompleteFormatSuggestionApi,\n AddressAutocompleteFormatSuggestionOutput\n >", + "description": "An extension target that formats the selected address suggestion provided by a `purchase.address-autocomplete.suggest` target. This address is used to auto-populate the fields in the address form.\n\nIt must return a formatted address.\n\nThis target does not support rendering UI components." + }, + { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "PropertySignature", + "name": "purchase.address-autocomplete.suggest", + "value": "RunnableExtension<\n AddressAutocompleteStandardApi<'purchase.address-autocomplete.suggest'> &\n AddressAutocompleteSuggestApi,\n AddressAutocompleteSuggestOutput\n >", + "description": "An extension target that provides address autocomplete suggestions. These suggestions are shown to buyers as they interact with address forms during checkout.\n\nIt must return a list of address suggestions. If a formatted address is provided with each suggestion, it will be used to auto-populate the fields in the address form when the buyer selects a suggestion.\n\nThis target does not support rendering UI components." + } + ], + "value": "export interface RunnableExtensionTargets {\n /**\n * An extension target that provides address autocomplete suggestions. These suggestions are shown to buyers as they\n * interact with address forms during checkout.\n *\n * It must return a list of address suggestions. If a formatted address is provided with each suggestion, it will be\n * used to auto-populate the fields in the address form when the buyer selects a suggestion.\n *\n * This target does not support rendering UI components.\n */\n 'purchase.address-autocomplete.suggest': RunnableExtension<\n AddressAutocompleteStandardApi<'purchase.address-autocomplete.suggest'> &\n AddressAutocompleteSuggestApi,\n AddressAutocompleteSuggestOutput\n >;\n /**\n * An extension target that formats the selected address suggestion provided by a\n * `purchase.address-autocomplete.suggest` target. This address is used to auto-populate the fields in the address\n * form.\n *\n * It must return a formatted address.\n *\n * This target does not support rendering UI components.\n */\n 'purchase.address-autocomplete.format-suggestion': RunnableExtension<\n AddressAutocompleteStandardApi<'purchase.address-autocomplete.format-suggestion'> &\n AddressAutocompleteFormatSuggestionApi,\n AddressAutocompleteFormatSuggestionOutput\n >;\n}" + } + }, + "AvailableExtensionDefinitions": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AvailableExtensionDefinitions", + "value": "RenderExtension | RunnableExtension", + "description": "", + "isPublicDocs": true + } + }, + "ReturnTypeForExtension": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReturnTypeForExtension", + "value": "ReturnTypeForExtension", + "description": "For a given extension target, returns the value that is expected to be returned by that extension target’s callback type.", + "isPublicDocs": true + } + }, + "ApiForExtension": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ApiForExtension", + "value": "ApiForExtension", + "description": "For a given extension target, returns the type of the API that the extension will receive at runtime.", + "isPublicDocs": true + } + }, + "RenderExtensionTarget": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RenderExtensionTarget", + "value": "keyof RenderExtensionTargets", + "description": "A union type containing all of the extension targets that follow the pattern of accepting a [`@remote-ui/core` `RemoteRoot`](https://github.com/Shopify/remote-dom/tree/remote-ui/packages/core) and an additional `api` argument, and using those arguments to render UI.", + "isPublicDocs": true + } + }, + "RenderExtensions": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RenderExtensions", + "value": "{\n [Target in RenderExtensionTarget]: RenderExtensionTargets[Target];\n}", + "description": "A mapping of each “render extension” name to its callback type.", + "isPublicDocs": true + } + }, + "ApiForRenderExtension": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ApiForRenderExtension", + "value": "ApiForRenderExtension", + "description": "Deprecated. Use `ApiForExtension` instead.\n\nFor a given rendering extension target, returns the type of the API that the extension will receive at runtime. This API type is the second argument to the callback for that extension target. The first callback for all of the rendering extension targets each receive a `RemoteRoot` object.", + "isPublicDocs": true + } + }, + "AllowedComponentsForRenderExtension": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AllowedComponentsForRenderExtension", + "value": "AllowedComponentsForRenderExtension", + "description": "For a given rendering extension target, returns the UI components that the extension target supports.", + "isPublicDocs": true + } + }, + "RunnableExtensionTarget": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RunnableExtensionTarget", + "value": "keyof RunnableExtensionTargets", + "description": "", + "isPublicDocs": true + } + }, + "RunnableExtensions": { + "src/surfaces/checkout/extension-targets.ts": { + "filePath": "src/surfaces/checkout/extension-targets.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "RunnableExtensions", + "value": "{\n [Target in RunnableExtensionTarget]: RunnableExtensionTargets[Target];\n}", + "description": "", + "isPublicDocs": true + } + }, + "Docs_Standard_AddressApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_AddressApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "billingAddress", + "value": "SubscribableSignalLike", + "description": "The proposed customer billing address. The address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. The subscribable value is `undefined` if the billing address hasn't been provided yet.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "shippingAddress", + "value": "SubscribableSignalLike", + "description": "The proposed customer shipping address. During the information step, the address updates when the field is committed (on change) rather than every keystroke. The property is available only if the extension has access to protected customer data. When available, the subscribable value is `undefined` if delivery isn't required.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + } + ], + "value": "export interface Docs_Standard_AddressApi\n extends Pick {}" + } + }, + "Docs_Checkout_AddressApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Checkout_AddressApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "MethodSignature", + "name": "applyShippingAddressChange", + "value": "(change: ShippingAddressUpdateChange) => Promise", + "description": "Updates the buyer's shipping address on the checkout. The provided fields are merged into the existing address without prompting the buyer. On success, the `shippingAddress` property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + } + ], + "value": "export interface Docs_Checkout_AddressApi\n extends Pick {}" + } + }, + "Docs_Standard_AttributesApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_AttributesApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "SubscribableSignalLike", + "description": "The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added." + } + ], + "value": "export interface Docs_Standard_AttributesApi\n extends Pick {}" + } + }, + "Docs_Checkout_AttributesApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Checkout_AttributesApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "MethodSignature", + "name": "applyAttributeChange", + "value": "(change: AttributeChange) => Promise", + "description": "Updates or removes an attribute on the cart and checkout. On success, the [`attributes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay.", + "deprecationMessage": "Use cart metafields instead." + } + ], + "value": "export interface Docs_Checkout_AttributesApi\n extends Pick {}" + } + }, + "Docs_Standard_BuyerIdentityApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_BuyerIdentityApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "buyerIdentity", + "value": "BuyerIdentity", + "description": "Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).", + "isOptional": true + } + ], + "value": "export interface Docs_Standard_BuyerIdentityApi\n extends Pick {}" + } + }, + "Docs_Standard_BuyerJourneyApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_BuyerJourneyApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "buyerJourney", + "value": "BuyerJourney", + "description": "Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues." + } + ], + "value": "export interface Docs_Standard_BuyerJourneyApi\n extends Pick {}" + } + }, + "Docs_Standard_CartInstructionsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_CartInstructionsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "instructions", + "value": "SubscribableSignalLike", + "description": "The cart instructions used to create the checkout and possibly limit extension capabilities.\n\nThese instructions should be checked before performing any actions that might be affected by them.\n\nFor example, if you intend to add a discount code via the `applyDiscountCodeChange` method, check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout.\n\n> Caution: Check cart instructions before calling select APIs, as > some may not be available. See the > [Cart Instructions API](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) > for more information." + } + ], + "value": "export interface Docs_Standard_CartInstructionsApi\n extends Pick {}" + } + }, + "Docs_Standard_CartLinesApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_CartLinesApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "lines", + "value": "SubscribableSignalLike", + "description": "The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items." + } + ], + "value": "export interface Docs_Standard_CartLinesApi\n extends Pick {}" + } + }, + "Docs_Checkout_CartLinesApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Checkout_CartLinesApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "MethodSignature", + "name": "applyCartLinesChange", + "value": "(change: CartLineChange) => Promise", + "description": "Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state.\n\nAccepts a single change per call. To make multiple changes, call this method separately for each one.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + } + ], + "value": "export interface Docs_Checkout_CartLinesApi\n extends Pick {}" + } + }, + "Docs_CartLineItem_CartLinesApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_CartLineItem_CartLinesApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "SubscribableSignalLike", + "description": "The cart line that this extension is attached to. Use this to read the line item's merchandise, quantity, cost, and attributes.\n\nAvailable only on the corresponding item target. Shipping option item targets expose shipping option properties; pickup location item targets expose pickup location properties.\n\n> Note: Until version `2023-04`, this property was a `ReadonlySignalLike`." + } + ], + "value": "export interface Docs_CartLineItem_CartLinesApi\n extends Pick {}" + } + }, + "Docs_Standard_CostApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_CostApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "cost", + "value": "CartCost", + "description": "The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated." + } + ], + "value": "export interface Docs_Standard_CostApi extends Pick {}" + } + }, + "Docs_Standard_LocalizationApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_LocalizationApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "i18n", + "value": "I18n", + "description": "Utilities for translating strings, formatting currencies, numbers, and dates according to the buyer's locale. Use alongside [`localization`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) to build fully localized extensions." + }, + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "localization", + "value": "Localization", + "description": "The buyer's language, country, currency, and timezone context. For formatting and translation helpers, use the [`i18n`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) object instead." + } + ], + "value": "export interface Docs_Standard_LocalizationApi\n extends Pick {}" + } + }, + "Docs_Standard_LocalizedFieldsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_LocalizedFieldsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "localizedFields", + "value": "SubscribableSignalLike", + "description": "Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields.", + "isOptional": true + } + ], + "value": "export interface Docs_Standard_LocalizedFieldsApi\n extends Pick {}" + } + }, + "Docs_Standard_MetafieldsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_MetafieldsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "appMetafields", + "value": "SubscribableSignalLike", + "description": "The metafields requested in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file. These metafields are updated when there's a change in the merchandise items being purchased by the customer.\n\nApp owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + } + ], + "value": "export interface Docs_Standard_MetafieldsApi\n extends Pick {}" + } + }, + "Docs_Checkout_MetafieldsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Checkout_MetafieldsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "MethodSignature", + "name": "applyMetafieldChange", + "value": "(change: MetafieldChange) => Promise", + "description": "Creates, updates, or removes a cart metafield on the checkout. On success, the [`metafields`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change.\n\nCart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + } + ], + "value": "export interface Docs_Checkout_MetafieldsApi\n extends Pick {}" + } + }, + "Docs_Standard_DeliveryApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_DeliveryApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "deliveryGroups", + "value": "SubscribableSignalLike", + "description": "The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items.\n\nEmpty until the buyer enters enough address information for Shopify to calculate shipping rates." + } + ], + "value": "export interface Docs_Standard_DeliveryApi\n extends Pick {}" + } + }, + "Docs_Standard_CheckoutTokenApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_CheckoutTokenApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "checkoutToken", + "value": "SubscribableSignalLike", + "description": "A stable ID that represents the current checkout.\n\nThe value is `undefined` when the checkout hasn't been created on the server yet.\n\nUse this to correlate checkout sessions across your extension, web pixels, and backend systems.\n\nThis matches the `data.checkout.token` field in a [checkout-related WebPixel event](/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) and the `checkout_token` field in the [REST Admin API `Order` resource](/docs/api/admin-rest/unstable/resources/order#resource-object).\n\nCan be `undefined`. Handle the `undefined` state before using the value." + } + ], + "value": "export interface Docs_Standard_CheckoutTokenApi\n extends Pick {}" + } + }, + "Docs_Standard_ExtensionMetaApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_ExtensionMetaApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "extension", + "value": "Extension", + "description": "Metadata about the running extension, including the current target, API version, capabilities, and editor context. Use this to conditionally render content based on where the extension is running." + } + ], + "value": "export interface Docs_Standard_ExtensionMetaApi\n extends Pick {}" + } + }, + "Docs_Standard_CheckoutSettingsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_CheckoutSettingsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "checkoutSettings", + "value": "SubscribableSignalLike", + "description": "Settings applied to the buyer's checkout." + } + ], + "value": "export interface Docs_Standard_CheckoutSettingsApi\n extends Pick {}" + } + }, + "Docs_Standard_ShopApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_ShopApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "shop", + "value": "Shop", + "description": "The store where the checkout is taking place, including the shop name, storefront URL, `.myshopify.com` subdomain, and a globally-unique ID." + } + ], + "value": "export interface Docs_Standard_ShopApi extends Pick {}" + } + }, + "Docs_Standard_NoteApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_NoteApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "note", + "value": "SubscribableSignalLike", + "description": "A note left by the customer to the merchant, either in their cart or during checkout.\n\nThe value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages." + } + ], + "value": "export interface Docs_Standard_NoteApi extends Pick {}" + } + }, + "Docs_Checkout_NoteApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Checkout_NoteApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "MethodSignature", + "name": "applyNoteChange", + "value": "(change: NoteChange) => Promise", + "description": "Sets or removes the buyer's note on the checkout. On success, the [`note`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) property updates to reflect the change.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + } + ], + "value": "export interface Docs_Checkout_NoteApi\n extends Pick {}" + } + }, + "Docs_Standard_PaymentOptionsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_PaymentOptionsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "availablePaymentOptions", + "value": "SubscribableSignalLike", + "description": "All payment options available to the buyer for this checkout, such as credit cards, wallets, and local payment methods. The list depends on the shop's payment configuration and the buyer's region.\n\nThe set of payment options can change when the buyer updates their address or cart, so subscribe to changes rather than reading once during initialization. Each option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." + }, + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "selectedPaymentOptions", + "value": "SubscribableSignalLike", + "description": "The payment options the buyer has currently selected. This updates as the buyer changes their payment method. The array can contain multiple entries when the buyer splits payment across methods (for example, a gift card and a credit card).\n\nEach option exposes `handle` and `type` only. Provider names, logos, fees, and installment terms aren't available." + } + ], + "value": "export interface Docs_Standard_PaymentOptionsApi\n extends Pick<\n StandardApi,\n 'availablePaymentOptions' | 'selectedPaymentOptions'\n > {}" + } + }, + "Docs_Standard_GiftCardsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_GiftCardsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "appliedGiftCards", + "value": "SubscribableSignalLike", + "description": "The gift cards that have been applied to the checkout. Each entry includes the last four characters of the gift card code, the amount used at checkout, and the card's remaining balance." + } + ], + "value": "export interface Docs_Standard_GiftCardsApi\n extends Pick {}" + } + }, + "Docs_Checkout_GiftCardsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Checkout_GiftCardsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "MethodSignature", + "name": "applyGiftCardChange", + "value": "(change: GiftCardChange) => Promise", + "description": "Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state.\n\nUnlike other write operations, gift card changes aren't gated by a cart instruction flag.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call.\n\n> Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + } + ], + "value": "export interface Docs_Checkout_GiftCardsApi\n extends Pick {}" + } + }, + "Docs_Standard_DiscountsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_DiscountsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "discountAllocations", + "value": "SubscribableSignalLike", + "description": "The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered." + }, + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "discountCodes", + "value": "SubscribableSignalLike", + "description": "The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes." + } + ], + "value": "export interface Docs_Standard_DiscountsApi\n extends Pick {}" + } + }, + "Docs_Checkout_DiscountsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Checkout_DiscountsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "MethodSignature", + "name": "applyDiscountCodeChange", + "value": "(change: DiscountCodeChange) => Promise", + "description": "Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call.\n\n> Note: This method returns an error if the [cart instruction](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay." + } + ], + "value": "export interface Docs_Checkout_DiscountsApi\n extends Pick {}" + } + }, + "Docs_Standard_SessionTokenApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_SessionTokenApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "sessionToken", + "value": "SessionToken", + "description": "The session token providing a set of claims as a signed JSON Web Token (JWT).\n\nThe token has a TTL of five minutes.\n\nIf the previous token expires, this value reflects a new session token with a new signature and expiry.\n\nLearn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens)." + } + ], + "value": "export interface Docs_Standard_SessionTokenApi\n extends Pick {}" + } + }, + "Docs_Standard_SettingsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_SettingsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "settings", + "value": "SubscribableSignalLike", + "description": "The settings matching the settings definition written in the [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.\n\n Refer to [settings examples](/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information.\n\n> Note: When an extension is being installed in the editor, the settings are empty until a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings." + } + ], + "value": "export interface Docs_Standard_SettingsApi\n extends Pick {}" + } + }, + "Docs_Standard_StorageApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_StorageApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "storage", + "value": "Storage", + "description": "Key-value storage that persists across page loads within the current checkout session. Data is shared across all activated targets associated with this extension.\n\n> Caution: Data persistence isn't guaranteed and storage is cleared when the buyer starts a new checkout." + } + ], + "value": "export interface Docs_Standard_StorageApi\n extends Pick {}" + } + }, + "Docs_Standard_QueryApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_QueryApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "query", + "value": ">(query: string, options?: { variables?: Variables; version?: StorefrontApiVersion; }) => Promise<{ data?: Data; errors?: GraphQLError[]; }>", + "description": "The method used to query the Storefront GraphQL API with a prefetched token." + } + ], + "value": "export interface Docs_Standard_QueryApi extends Pick {}" + } + }, + "Docs_Standard_AnalyticsApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_AnalyticsApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "analytics", + "value": "Analytics", + "description": "Tracks custom events and sends visitor information to [Web Pixels](/docs/apps/marketing). Use `publish()` to emit events and `visitor()` to submit buyer contact details." + } + ], + "value": "export interface Docs_Standard_AnalyticsApi\n extends Pick {}" + } + }, + "Docs_Standard_CustomerPrivacyApi": { + "src/surfaces/checkout/api/docs.ts": { + "filePath": "src/surfaces/checkout/api/docs.ts", + "name": "Docs_Standard_CustomerPrivacyApi", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "applyTrackingConsentChange", + "value": "ApplyTrackingConsentChangeType", + "description": "Enables setting and updating customer privacy consent settings and tracking consent metafields.\n\n> Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`.\n\n{% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data)." + }, + { + "filePath": "src/surfaces/checkout/api/docs.ts", + "syntaxKind": "PropertySignature", + "name": "customerPrivacy", + "value": "SubscribableSignalLike", + "description": "Customer privacy consent settings and a flag denoting if consent has previously been collected." + } + ], + "value": "export interface Docs_Standard_CustomerPrivacyApi\n extends Pick {}" + } + }, + "BaseElementPropsWithChildren": { + "src/surfaces/checkout/components/Abbreviation.ts": { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "name": "BaseElementPropsWithChildren", + "description": "Used when an element has children.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "preact.ComponentChildren", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "preact.Key", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ref", + "value": "preact.Ref", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "Lowercase", + "description": "", + "isOptional": true + } + ], + "value": "export interface BaseElementPropsWithChildren extends BaseElementProps {\n children?: preact.ComponentChildren;\n}" + } + }, + "ComponentChildren": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ComponentChildren", + "value": "any", + "description": "TODO: Update `any` type here after this is resolved https://github.com/Shopify/ui-api-design/issues/139" + } + }, + "AbbreviationElementProps": { + "src/surfaces/checkout/components/Abbreviation.ts": { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "name": "AbbreviationElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "Defines the full expansion of the abbreviation or acronym. Helps user agents and users understand the meaning of the abbreviated text.\n\nLearn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface AbbreviationElementProps extends Pick {\n}" + } + }, + "AbbreviationElement": { + "src/surfaces/checkout/components/Abbreviation.ts": { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "name": "AbbreviationElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "Defines the full expansion of the abbreviation or acronym. Helps user agents and users understand the meaning of the abbreviated text.\n\nLearn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface AbbreviationElement extends AbbreviationElementProps, Omit {\n}" + } + }, + "AbbreviationProps": { + "src/surfaces/checkout/components/Abbreviation.ts": { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "name": "AbbreviationProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Abbreviation.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "Defines the full expansion of the abbreviation or acronym. Helps user agents and users understand the meaning of the abbreviated text.\n\nLearn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface AbbreviationProps extends AbbreviationElementProps {\n}" + } + }, + "CallbackEvent": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackEvent", + "value": "TEvent & {\n currentTarget: HTMLElementTagNameMap[TTagName];\n}", + "description": "An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners." + } + }, + "CallbackEventListener": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "CallbackEventListener", + "value": "(EventListener & {\n (event: CallbackEvent & TData): void;\n}) | null", + "description": "A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag." + } + }, + "AnnouncementEvents": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "name": "AnnouncementEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "(event: Event) => void", + "description": "A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and the [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + } + ], + "value": "export interface AnnouncementEvents extends Pick {\n}" + } + }, + "AnnouncementElementEvents": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "name": "AnnouncementElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "aftertoggle", + "value": "CallbackEventListener", + "description": "A callback that fires when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "dismiss", + "value": "CallbackEventListener", + "description": "A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "toggle", + "value": "CallbackEventListener", + "description": "A callback that fires immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + } + ], + "value": "export interface AnnouncementElementEvents {\n /**\n * A callback that fires when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n aftertoggle?: CallbackEventListener;\n /**\n * A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.\n */\n dismiss?: CallbackEventListener;\n /**\n * A callback that fires immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n toggle?: CallbackEventListener;\n}" + } + }, + "ToggleArgumentsEvent": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "name": "ToggleArgumentsEvent", + "description": "The event data provided to toggle-related callbacks. Contains the previous and next visibility states of the element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "newState", + "value": "ToggleState", + "description": "The visibility state of the element after the toggle occurred.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oldState", + "value": "ToggleState", + "description": "The visibility state of the element before the toggle occurred.", + "isOptional": true + } + ], + "value": "export interface ToggleArgumentsEvent {\n /**\n * The visibility state of the element before the toggle occurred.\n */\n oldState?: ToggleState;\n /**\n * The visibility state of the element after the toggle occurred.\n */\n newState?: ToggleState;\n}" + } + }, + "ToggleState": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ToggleState", + "value": "'open' | 'closed'", + "description": "The visibility state of a toggleable element.\n\n- `open`: The element is visible and showing its content.\n- `closed`: The element is hidden and its content is not visible." + } + }, + "AnnouncementElement": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "name": "AnnouncementElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "dismiss", + "value": "() => void", + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onaftertoggle", + "value": "(event: ToggleEvent$1) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondismiss", + "value": "(event: Event) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "(event: ToggleEvent$1) => void", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface AnnouncementElement extends AnnouncementMethods, Omit {\n onaftertoggle?: AnnouncementEvents['onAfterToggle'];\n ondismiss?: AnnouncementEvents['onDismiss'];\n ontoggle?: AnnouncementEvents['onToggle'];\n}" + } + }, + "AnnouncementProps": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "name": "AnnouncementProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "(event: Event) => void", + "description": "A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "onToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and the [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + } + ], + "value": "export interface AnnouncementProps extends AnnouncementEvents {\n}" + } + }, + "AnnouncementMethods": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "name": "AnnouncementMethods", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "dismiss", + "value": "() => void", + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." + } + ], + "value": "export interface AnnouncementMethods {\n /**\n * Programmatically dismisses the announcement. This triggers the `dismiss` event callback.\n */\n dismiss: () => void;\n}" + } + }, + "AnnouncementElementMethods": { + "src/surfaces/checkout/components/Announcement.ts": { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "name": "AnnouncementElementMethods", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Announcement.ts", + "syntaxKind": "PropertySignature", + "name": "dismiss", + "value": "() => void", + "description": "Programmatically dismisses the announcement. This triggers the `dismiss` event callback." + } + ], + "value": "export interface AnnouncementElementMethods {\n /**\n * Programmatically dismisses the announcement. This triggers the `dismiss` event callback.\n */\n dismiss: AnnouncementMethods['dismiss'];\n}" + } + }, + "ReducedIconTypes": { + "src/surfaces/checkout/components/Badge.ts": { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReducedIconTypes", + "value": "'cart' | 'note' | 'settings' | 'reset' | 'map' | 'menu' | 'search' | 'circle' | 'filter' | 'image' | 'alert-circle' | 'alert-triangle-filled' | 'alert-triangle' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up-right' | 'arrow-up' | 'bag' | 'bullet' | 'calendar' | 'camera' | 'caret-down' | 'cash-dollar' | 'categories' | 'check-circle' | 'check-circle-filled' | 'check' | 'chevron-down' | 'chevron-left' | 'chevron-right' | 'chevron-up' | 'clipboard' | 'clock' | 'credit-card' | 'delete' | 'delivered' | 'delivery' | 'disabled' | 'discount' | 'edit' | 'email' | 'empty' | 'external' | 'geolocation' | 'gift-card' | 'globe' | 'grid' | 'info-filled' | 'info' | 'list-bulleted' | 'location' | 'lock' | 'menu-horizontal' | 'menu-vertical' | 'minus' | 'mobile' | 'order' | 'organization' | 'plus' | 'profile' | 'question-circle-filled' | 'question-circle' | 'reorder' | 'return' | 'savings' | 'star-filled' | 'star-half' | 'star' | 'store' | 'truck' | 'upload' | 'x-circle-filled' | 'x-circle' | 'x'", + "description": "The subset of icon types available in checkout and customer account surfaces. This is a narrowed set from the full Shopify icon library, containing only the icons supported in these contexts.", + "isPublicDocs": true + } + }, + "BadgeElementProps": { + "src/surfaces/checkout/components/Badge.ts": { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "name": "BadgeElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "'base' | 'subdued'", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "'' | ReducedIconTypes", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "iconPosition", + "value": "'start' | 'end'", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'base' | 'small-100'", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface BadgeElementProps extends Pick {\n /**\n * The size of the badge.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A smaller badge for compact layouts.\n * - `small-100`: The smallest badge for tight spaces or dense lists.\n *\n * @default 'base'\n */\n size?: Extract;\n /**\n * The semantic meaning and color treatment of the badge.\n *\n * - `auto`: Automatically determined based on context.\n * - `neutral`: General information without specific intent.\n * - `critical`: Urgent problems or destructive actions.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * Controls the visual weight and emphasis of the badge.\n *\n * - `base`: Standard weight with moderate emphasis, suitable for most use cases.\n * - `subdued`: Reduced visual weight for less prominent or secondary badges.\n *\n * @default 'base'\n */\n color?: Extract;\n /**\n * An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.\n *\n * @default ''\n */\n icon?: '' | ReducedIconTypes;\n /**\n * The position of the icon relative to the badge text.\n *\n * - `start`: Places the icon before the text.\n * - `end`: Places the icon after the text.\n */\n iconPosition?: BadgeProps$1['iconPosition'];\n}" + } + }, + "BadgeElement": { + "src/surfaces/checkout/components/Badge.ts": { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "name": "BadgeElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "'base' | 'subdued'", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "'' | ReducedIconTypes", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "iconPosition", + "value": "'start' | 'end'", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'base' | 'small-100'", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface BadgeElement extends BadgeElementProps, Omit {\n}" + } + }, + "BadgeProps": { + "src/surfaces/checkout/components/Badge.ts": { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "name": "BadgeProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "'base' | 'subdued'", + "description": "Controls the visual weight and emphasis of the badge.\n\n- `base`: Standard weight with moderate emphasis, suitable for most use cases.\n- `subdued`: Reduced visual weight for less prominent or secondary badges.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "'' | ReducedIconTypes", + "description": "An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "iconPosition", + "value": "'start' | 'end'", + "description": "The position of the icon relative to the badge text.\n\n- `start`: Places the icon before the text.\n- `end`: Places the icon after the text.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'base' | 'small-100'", + "description": "The size of the badge.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A smaller badge for compact layouts.\n- `small-100`: The smallest badge for tight spaces or dense lists.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Badge.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "The semantic meaning and color treatment of the badge.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `critical`: Urgent problems or destructive actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface BadgeProps extends BadgeElementProps {\n}" + } + }, + "BannerElementProps": { + "src/surfaces/checkout/components/Banner.ts": { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "name": "BannerElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "collapsible", + "value": "boolean", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "dismissible", + "value": "boolean", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'success' | 'info' | 'auto' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface BannerElementProps extends Pick {\n /**\n * Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.\n *\n * @default false\n */\n collapsible?: BannerProps$1['collapsible'];\n /**\n * Whether the banner displays a close button that allows users to dismiss it.\n *\n * When the close button is pressed, the `dismiss` event will fire,\n * then `hidden` will be set to `true`,\n * any animation will complete,\n * and the `afterhide` event will fire.\n *\n * @default false\n */\n dismissible?: BannerProps$1['dismissible'];\n /**\n * The heading text displayed at the top of the banner to summarize the message or alert.\n *\n * @default ''\n */\n heading?: BannerProps$1['heading'];\n /**\n * Controls whether the banner is visible or hidden.\n *\n * When using a controlled component pattern and the banner is `dismissible`,\n * update this property to `true` when the `dismiss` event fires.\n *\n * You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.\n *\n * @default false\n */\n hidden?: BannerProps$1['hidden'];\n /**\n * The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n *\n * - `info`: Informational content or helpful tips.\n * - `auto`: Automatically determined based on context.\n * - `success`: Positive outcomes or successful states.\n * - `warning`: Important warnings about potential issues.\n * - `critical`: Urgent problems or destructive actions.\n *\n * The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.\n *\n * @default 'auto'\n */\n tone?: Extract;\n}" + } + }, + "BannerEvents": { + "src/surfaces/checkout/components/Banner.ts": { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "name": "BannerEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property is `true` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "(event: Event) => void", + "description": "A callback that fires when the banner is dismissed by the user clicking the close button.\n\nThis doesn't fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", + "isOptional": true + } + ], + "value": "export interface BannerEvents extends Pick {\n}" + } + }, + "BannerElementEvents": { + "src/surfaces/checkout/components/Banner.ts": { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "name": "BannerElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener", + "description": "A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property is `true` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "dismiss", + "value": "CallbackEventListener", + "description": "A callback that fires when the banner is dismissed by the user clicking the close button.\n\nThis doesn't fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", + "isOptional": true + } + ], + "value": "export interface BannerElementEvents {\n /**\n * A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n *\n * The `hidden` property is `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback that fires when the banner is dismissed by the user clicking the close button.\n *\n * This doesn't fire when setting `hidden` manually.\n *\n * The `hidden` property is `false` when this event fires.\n */\n dismiss?: CallbackEventListener;\n}" + } + }, + "BannerElement": { + "src/surfaces/checkout/components/Banner.ts": { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "name": "BannerElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "collapsible", + "value": "boolean", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "dismissible", + "value": "boolean", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onafterhide", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondismiss", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'success' | 'info' | 'auto' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface BannerElement extends BannerElementProps, Omit {\n onafterhide: BannerEvents['onAfterHide'];\n ondismiss: BannerEvents['onDismiss'];\n}" + } + }, + "BannerProps": { + "src/surfaces/checkout/components/Banner.ts": { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "name": "BannerProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "collapsible", + "value": "boolean", + "description": "Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "dismissible", + "value": "boolean", + "description": "Whether the banner displays a close button that allows users to dismiss it.\n\nWhen the close button is pressed, the `dismiss` event will fire, then `hidden` will be set to `true`, any animation will complete, and the `afterhide` event will fire.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the banner to summarize the message or alert.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Controls whether the banner is visible or hidden.\n\nWhen using a controlled component pattern and the banner is `dismissible`, update this property to `true` when the `dismiss` event fires.\n\nYou can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback that fires when the banner has fully hidden, including after any hide animations have completed.\n\nThe `hidden` property is `true` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "onDismiss", + "value": "(event: Event) => void", + "description": "A callback that fires when the banner is dismissed by the user clicking the close button.\n\nThis doesn't fire when setting `hidden` manually.\n\nThe `hidden` property is `false` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Banner.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'success' | 'info' | 'auto' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.\n\n- `info`: Informational content or helpful tips.\n- `auto`: Automatically determined based on context.\n- `success`: Positive outcomes or successful states.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n\nThe `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface BannerProps extends BannerElementProps, BannerEvents {\n}" + } + }, + "ReducedBorderSizeKeyword": { + "src/surfaces/checkout/components/Box.ts": { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReducedBorderSizeKeyword", + "value": "'large' | 'base' | 'large-100' | 'large-200' | 'none'", + "description": "The subset of border size values available for this component.\n\n- `base`: Standard border width.\n- `large`: Thick border for strong emphasis.\n- `large-100`: Extra thick border for maximum prominence.\n- `large-200`: The thickest available border.\n- `none`: No border." + } + }, + "ReducedColorKeyword": { + "src/surfaces/checkout/components/Box.ts": { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReducedColorKeyword", + "value": "'base'", + "description": "The subset of border color values available for this component.\n\n- `base`: The standard border color for most contexts." + } + }, + "BorderShorthand": { + "src/surfaces/checkout/components/Box.ts": { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderShorthand", + "value": "ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`", + "description": "A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults." + } + }, + "BorderStyleKeyword": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "BorderStyleKeyword", + "value": "\"none\" | \"solid\" | \"dashed\" | \"dotted\" | \"auto\"", + "description": "The visual style of a border. Learn more about [border-style](https://developer.mozilla.org/en-US/docs/Web/CSS/border-style).\n\n- `none`: No border is rendered.\n- `solid`: A single continuous line.\n- `dashed`: A series of short dashes.\n- `dotted`: A series of round dots.\n- `auto`: The border style is determined automatically based on the surface's design system." + } + }, + "BoxElementProps": { + "src/surfaces/checkout/components/Box.ts": { + "filePath": "src/surfaces/checkout/components/Box.ts", + "name": "BoxElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface BoxElementProps extends Pick {\n /**\n * The background color of the box.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the box's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" + } + }, + "AccessibilityRole": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AccessibilityRole", + "value": "\"main\" | \"header\" | \"footer\" | \"section\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"status\" | \"alert\" | \"generic\" | \"presentation\" | \"none\"", + "description": "The semantic role of a component, used by assistive technologies to convey the element’s purpose to users. Each role maps to a specific HTML element or ARIA role.\n\n- `main`: The primary content of the page.\n- `header`: A page or section header.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `aside`: Supporting content related to the main content.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `status`: A live region with advisory information that is not urgent.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).\n- `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.\n- `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`." + } + }, + "MaybeResponsive": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeResponsive", + "value": "T | `@container${string}`", + "description": "Makes a property responsive by allowing it to be set conditionally based on container query conditions. The value can be either a base value or a container query string.\n\n- `T`: Base value that applies in all conditions.\n- `@container${string}`: Container query string for conditional responsive styling based on container size." + } + }, + "SizeUnitsOrAuto": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnitsOrAuto", + "value": "SizeUnits | \"auto\"", + "description": "Represents size values that can also be set to `auto` for automatic sizing.\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints. Learn more about the [auto value](https://developer.mozilla.org/en-US/docs/Web/CSS/width#auto)." + } + }, + "SizeUnits": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnits", + "value": "`${number}px` | `${number}%` | `0`", + "description": "Represents size values in pixels, percentages, or zero.\n\n- `` `${number}px` ``: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`).\n- `` `${number}%` ``: Relative size as a percentage of the parent container (such as `50%`, `100%`).\n- `0`: Zero size, equivalent to no dimension." + } + }, + "MaybeAllValuesShorthandProperty": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeAllValuesShorthandProperty", + "value": "T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`", + "description": "Represents CSS shorthand properties that accept one to four values, following the [CSS shorthand syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box). Supports specifying values for all four sides: top, right, bottom, and left.\n\n- `T`: Single value that applies to all four sides.\n- `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right).\n- `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom).\n- `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left)." + } + }, + "BoxProps": { + "src/surfaces/checkout/components/Box.ts": { + "filePath": "src/surfaces/checkout/components/Box.ts", + "name": "BoxProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface BoxProps extends BoxElementProps {\n}" + } + }, + "SizeUnitsOrNone": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeUnitsOrNone", + "value": "SizeUnits | \"none\"", + "description": "Represents size values that can also be set to `none` to remove the size constraint.\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `none`: No size constraint, allowing unlimited growth. Learn more about the [none value](https://developer.mozilla.org/en-US/docs/Web/CSS/max-width#none)." + } + }, + "PaddingKeyword": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PaddingKeyword", + "value": "SizeKeyword | \"none\"", + "description": "Defines the padding size for elements, using the standard size scale or `none` for no padding.\n\n- `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing.\n- `none`: No padding." + } + }, + "SizeKeyword": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SizeKeyword", + "value": "\"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"small\" | \"base\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\"", + "description": "The design system's size scale, used to control the dimensions of components like avatars, icons, and thumbnails. Values range from `\"small-500\"` (smallest) through `\"base\"` (standard) to `\"large-500\"` (largest). Not all components support every size — check the component's `size` property type for its available options." + } + }, + "MaybeTwoValuesShorthandProperty": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "MaybeTwoValuesShorthandProperty", + "value": "T | `${T} ${T}`", + "description": "Represents CSS shorthand properties that accept one or two values. Supports specifying the same value for both dimensions or different values.\n\n- `T`: Single value that applies to both dimensions.\n- `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal)." + } + }, + "BoxElement": { + "src/surfaces/checkout/components/Box.ts": { + "filePath": "src/surfaces/checkout/components/Box.ts", + "name": "BoxElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Box.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface BoxElement extends BoxElementProps, Omit {\n}" + } + }, + "ButtonElementProps": { + "src/surfaces/checkout/components/Button.ts": { + "filePath": "src/surfaces/checkout/components/Button.ts", + "name": "ButtonElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The inline width of the button component.\n\n- `'auto'`: The size depends on the surface and context.\n- `'fill'`: The button takes up 100% of the available inline size.\n- `'fit-content'`: The button takes up the minimum inline size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed. This also disables the button.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n\n- `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.\n- `'_blank'`: Opens the URL in a new tab or window.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button'", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary'", + "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface ButtonElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n /**\n * The behavioral type of the button component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n variant?: Extract;\n}" + } + }, + "ButtonEvents": { + "src/surfaces/checkout/components/Button.ts": { + "filePath": "src/surfaces/checkout/components/Button.ts", + "name": "ButtonEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + } + ], + "value": "export interface ButtonEvents extends Pick {\n}" + } + }, + "ButtonElementEvents": { + "src/surfaces/checkout/components/Button.ts": { + "filePath": "src/surfaces/checkout/components/Button.ts", + "name": "ButtonElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener", + "description": "A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + } + ], + "value": "export interface ButtonElementEvents {\n /**\n * A callback fired when the button is clicked. This will be called before the action indicated by `type`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n}" + } + }, + "ButtonElement": { + "src/surfaces/checkout/components/Button.ts": { + "filePath": "src/surfaces/checkout/components/Button.ts", + "name": "ButtonElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The inline width of the button component.\n\n- `'auto'`: The size depends on the surface and context.\n- `'fill'`: The button takes up 100% of the available inline size.\n- `'fit-content'`: The button takes up the minimum inline size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed. This also disables the button.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n\n- `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.\n- `'_blank'`: Opens the URL in a new tab or window.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button'", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary'", + "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ButtonElement extends ButtonElementProps, Omit {\n onclick: ButtonEvents['onClick'];\n}" + } + }, + "ButtonProps": { + "src/surfaces/checkout/components/Button.ts": { + "filePath": "src/surfaces/checkout/components/Button.ts", + "name": "ButtonProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The inline width of the button component.\n\n- `'auto'`: The size depends on the surface and context.\n- `'fill'`: The button takes up 100% of the available inline size.\n- `'fit-content'`: The button takes up the minimum inline size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed. This also disables the button.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n\n- `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.\n- `'_blank'`: Opens the URL in a new tab or window.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral' | 'critical'", + "description": "The semantic meaning and color treatment of the button.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'critical'`: Urgent problems or destructive actions.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button'", + "description": "The behavioral type of the button component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/checkout/components/Button.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'primary' | 'secondary'", + "description": "The visual style variant of the button component, which controls its prominence and emphasis.\n\n- `'auto'`: Automatically determined by the button's context.\n- `'primary'`: High-emphasis style for the main action.\n- `'secondary'`: Medium-emphasis style for supporting actions.\n- `'tertiary'`: Low-emphasis style for less prominent actions.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface ButtonProps extends ButtonElementProps, ButtonEvents {\n}" + } + }, + "ChatElementProps": { + "src/surfaces/checkout/components/Chat.ts": { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "name": "ChatElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "ChatProps$1", + "description": "A label that describes the purpose of the chat, announced by assistive technologies like screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "", + "description": "Adjust the block size.\n\nCheckout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered.\n\nLearn more about [block size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "", + "description": "Adjust the inline size.\n\nCheckout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered.\n\nLearn more about [inline size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "isOptional": true + } + ], + "value": "export interface ChatElementProps extends Pick {\n /**\n * A label that describes the purpose of the chat, announced by assistive technologies like screen readers.\n */\n accessibilityLabel?: ChatProps$1['accessibilityLabel'];\n /**\n * Adjust the block size.\n *\n * Checkout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered.\n *\n * Learn more about [block size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n */\n blockSize?: Extract;\n /**\n * Adjust the inline size.\n *\n * Checkout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered.\n *\n * Learn more about [inline size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n */\n inlineSize?: Extract;\n}" + } + }, + "ChatProps": { + "src/surfaces/checkout/components/Chat.ts": { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "name": "ChatProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "ChatProps$1", + "description": "A label that describes the purpose of the chat, announced by assistive technologies like screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "", + "description": "Adjust the block size.\n\nCheckout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered.\n\nLearn more about [block size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "", + "description": "Adjust the inline size.\n\nCheckout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered.\n\nLearn more about [inline size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "isOptional": true + } + ], + "value": "export interface ChatProps extends ChatElementProps, ChatEvents {\n}" + } + }, + "ChatElementEvents": { + "src/surfaces/checkout/components/Chat.ts": { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "name": "ChatElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ready", + "value": "CallbackEventListener", + "description": "A callback that fires when the embedded page is ready and a message port has been created to communicate with the host page.", + "isOptional": true + } + ], + "value": "export interface ChatElementEvents {\n /**\n * A callback that fires when the embedded page is ready and a message port has been created to communicate with the host page.\n */\n ready?: CallbackEventListener;\n}" + } + }, + "ChatElementMethods": { + "src/surfaces/checkout/components/Chat.ts": { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "name": "ChatElementMethods", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "contentWindow", + "value": "{\n postMessage(message: any): void;\n }", + "description": "Returns an object exposing a `postMessage` method used to send messages to the embedded page rendered inside the chat iframe. Pair this with the `ready` event (or `onReady` callback) to know when the message channel is available." + } + ], + "value": "export interface ChatElementMethods {\n /**\n * Returns an object exposing a `postMessage` method used to send messages to the embedded page rendered inside the chat iframe. Pair this with the `ready` event (or `onReady` callback) to know when the message channel is available.\n */\n readonly contentWindow: {\n postMessage(message: any): void;\n };\n}" + } + }, + "ChatElement": { + "src/surfaces/checkout/components/Chat.ts": { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "name": "ChatElement", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "ChatProps$1", + "description": "A label that describes the purpose of the chat, announced by assistive technologies like screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "", + "description": "Adjust the block size.\n\nCheckout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered.\n\nLearn more about [block size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "contentWindow", + "value": "{\n postMessage(message: any): void;\n }", + "description": "Returns an object exposing a `postMessage` method used to send messages to the embedded page rendered inside the chat iframe. Pair this with the `ready` event (or `onReady` callback) to know when the message channel is available." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "", + "description": "Adjust the inline size.\n\nCheckout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered.\n\nLearn more about [inline size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onready", + "value": "ChatProps$1", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Chat.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ChatElement extends ChatElementProps, ChatElementMethods, Omit {\n onready: ChatEvents['onReady'];\n}" + } + }, + "CheckboxElementProps": { + "src/surfaces/checkout/components/Checkbox.ts": { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface CheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n *\n * If a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).\n */\n label?: string;\n}" + } + }, + "CheckboxEvents": { + "src/surfaces/checkout/components/Checkbox.ts": { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed.", + "isOptional": true + } + ], + "value": "export interface CheckboxEvents extends Pick {\n}" + } + }, + "CheckboxElementEvents": { + "src/surfaces/checkout/components/Checkbox.ts": { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + } + ], + "value": "export interface CheckboxElementEvents {\n /**\n * A callback fired when the checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" + } + }, + "CheckboxElement": { + "src/surfaces/checkout/components/Checkbox.ts": { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface CheckboxElement extends CheckboxElementProps, Omit {\n onchange: CheckboxEvents['onChange'];\n}" + } + }, + "CheckboxElementSlots": { + "src/surfaces/checkout/components/Checkbox.ts": { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "HTMLElement", + "description": "The visual content to use as the control label.\n\nUse an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.", + "isOptional": true + } + ], + "value": "export interface CheckboxElementSlots {\n /**\n * The visual content to use as the control label.\n *\n * Use an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content.\n */\n label?: HTMLElement;\n}" + } + }, + "CheckboxProps": { + "src/surfaces/checkout/components/Checkbox.ts": { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "name": "CheckboxProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The visual content to use as the control label. Use a string to provide a simple text label displayed to the user.\n\nIf a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.\n\nAdds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Checkbox.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface CheckboxProps extends CheckboxElementProps, CheckboxEvents {\n}" + } + }, + "ChipElementProps": { + "src/surfaces/checkout/components/Chip.ts": { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "name": "ChipElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface ChipElementProps extends Pick {\n}" + } + }, + "ChipElementSlots": { + "src/surfaces/checkout/components/Chip.ts": { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "name": "ChipElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "HTMLElement", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", + "isOptional": true + } + ], + "value": "export interface ChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + } + }, + "ChipProps": { + "src/surfaces/checkout/components/Chip.ts": { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "name": "ChipProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface ChipProps extends ChipElementProps {\n}" + } + }, + "ChipElement": { + "src/surfaces/checkout/components/Chip.ts": { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "name": "ChipElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Chip.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ChipElement extends ChipProps, Omit {\n}" + } + }, + "ChoiceElementProps": { + "src/surfaces/checkout/components/Choice.ts": { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "name": "ChoiceElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "defaultSelected", + "value": "boolean", + "description": "Whether the control is selected by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "boolean", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the control is currently selected.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface ChoiceElementProps extends Pick {\n}" + } + }, + "ChoiceElementSlots": { + "src/surfaces/checkout/components/Choice.ts": { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "name": "ChoiceElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "details", + "value": "HTMLElement", + "description": "Additional text to provide context or guidance for the input.\n\nThis text is displayed along with the input and its label to offer more information or instructions to the user.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "secondaryContent", + "value": "HTMLElement", + "description": "Secondary content for a choice.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "selectedContent", + "value": "HTMLElement", + "description": "Content to display when the option is selected.\n\nThis can be used to provide additional information or options related to the choice.", + "isOptional": true + } + ], + "value": "export interface ChoiceElementSlots {\n /**\n * Additional text to provide context or guidance for the input.\n *\n * This text is displayed along with the input and its label\n * to offer more information or instructions to the user.\n *\n * @implementation this content should be linked to the input with an `aria-describedby` attribute.\n */\n details?: HTMLElement;\n /**\n * Secondary content for a choice.\n */\n secondaryContent?: HTMLElement;\n /**\n * Content to display when the option is selected.\n *\n * This can be used to provide additional information or options related to the choice.\n */\n selectedContent?: HTMLElement;\n}" + } + }, + "ChoiceElement": { + "src/surfaces/checkout/components/Choice.ts": { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "name": "ChoiceElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "defaultSelected", + "value": "boolean", + "description": "Whether the control is selected by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "boolean", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the control is currently selected.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ChoiceElement extends ChoiceElementProps, Omit {\n}" + } + }, + "ChoiceProps": { + "src/surfaces/checkout/components/Choice.ts": { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "name": "ChoiceProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "defaultSelected", + "value": "boolean", + "description": "Whether the control is selected by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "boolean", + "description": "Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the control is currently selected.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Choice.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface ChoiceProps extends ChoiceElementProps {\n}" + } + }, + "ChoiceListElementProps": { + "src/surfaces/checkout/components/ChoiceList.ts": { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "name": "ChoiceListElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple choices can be selected.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "values", + "value": "string[]", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface ChoiceListElementProps extends Pick {\n}" + } + }, + "ChoiceListEvents": { + "src/surfaces/checkout/components/ChoiceList.ts": { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "name": "ChoiceListEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has selected one or more options.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + } + ], + "value": "export interface ChoiceListEvents extends Pick {\n}" + } + }, + "ChoiceListElementEvents": { + "src/surfaces/checkout/components/ChoiceList.ts": { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "name": "ChoiceListElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the choice list value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + } + ], + "value": "export interface ChoiceListElementEvents {\n /**\n * A callback fired when the choice list value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" + } + }, + "ChoiceListElement": { + "src/surfaces/checkout/components/ChoiceList.ts": { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "name": "ChoiceListElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple choices can be selected.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "values", + "value": "string[]", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ChoiceListElement extends ChoiceListElementProps, Omit {\n onchange: ChoiceListEvents['onChange'];\n}" + } + }, + "ChoiceListProps": { + "src/surfaces/checkout/components/ChoiceList.ts": { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "name": "ChoiceListProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.\n\n`disabled` on any child choices is ignored when this is true.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple choices can be selected.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has selected one or more options.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "values", + "value": "string[]", + "description": "An array of `value` attributes for the currently selected options.\n\nThis is a convenience prop for setting the `selected` prop on child options.\n\nForm data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ChoiceList.ts", + "syntaxKind": "PropertySignature", + "name": "variant", + "value": "'auto' | 'list' | 'inline' | 'block' | 'grid'", + "description": "The variant of the choice grid.\n\n- `auto`: The variant is determined by the context.\n- `list`: The choices are displayed in a list.\n- `inline`: The choices are displayed on the inline axis.\n- `block`: The choices are displayed on the block axis.\n- `grid`: The choices are displayed in a grid.\n\nThe selected content slot is supported only in the default (stacked) variant. `inline` and `grid` ignore it.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface ChoiceListProps extends ChoiceListElementProps, ChoiceListEvents {\n}" + } + }, + "ClickableElementProps": { + "src/surfaces/checkout/components/Clickable.ts": { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "name": "ClickableElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the element.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).\n- `strong`: An emphasized background for prominent sections.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the clickable, meaning it cannot be clicked or receive focus.\n\nIn this state, the `click` event will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element.\n\nHowever, items within the clickable can still receive focus and be interacted with.\n\nThis has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Disables the clickable, and indicates to assistive technology that the loading is in progress.\n\nThis also disables the clickable.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n\n- `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.\n- `'_blank'`: Opens the URL in a new tab or window.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button'", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ], + "value": "export interface ClickableElementProps extends Pick {\n background?: Extract;\n border?: BorderShorthand;\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n borderRadius?: MaybeAllValuesShorthandProperty>;\n target?: Extract;\n /**\n * The behavioral type of the clickable component, which determines what action it performs when activated.\n *\n * - `submit`: Submits the nearest containing form.\n * - `button`: Performs no default action, relying on the `click` event handler for behavior.\n *\n * This property is ignored if `href` or `commandFor`/`command` is set.\n *\n * @default 'button'\n */\n type?: Extract;\n}" + } + }, + "ClickableProps": { + "src/surfaces/checkout/components/Clickable.ts": { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "name": "ClickableProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the element.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).\n- `strong`: An emphasized background for prominent sections.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the clickable, meaning it cannot be clicked or receive focus.\n\nIn this state, the `click` event will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element.\n\nHowever, items within the clickable can still receive focus and be interacted with.\n\nThis has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Disables the clickable, and indicates to assistive technology that the loading is in progress.\n\nThis also disables the clickable.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n\n- `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.\n- `'_blank'`: Opens the URL in a new tab or window.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button'", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", + "isOptional": true, + "defaultValue": "'button'" + } + ], + "value": "export interface ClickableProps extends ClickableElementProps, ClickableEvents {\n}" + } + }, + "ClickableEvents": { + "src/surfaces/checkout/components/Clickable.ts": { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "name": "ClickableEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface ClickableEvents extends Pick {\n}" + } + }, + "ClickableElementEvents": { + "src/surfaces/checkout/components/Clickable.ts": { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "name": "ClickableElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the component loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener", + "description": "A callback fired when the component is clicked. This will be called before the action indicated by `type`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the component receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface ClickableElementEvents {\n /**\n * A callback fired when the component loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the component is clicked. This will be called before the action indicated by `type`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n /**\n * A callback fired when the component receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" + } + }, + "ClickableElement": { + "src/surfaces/checkout/components/Clickable.ts": { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "name": "ClickableElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the element.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).\n- `strong`: An emphasized background for prominent sections.\n\n- `'transparent'`: No visible background.\n- `'subdued'`: A subtle, low-emphasis background.\n- `'base'`: The standard background color.\n- `'strong'`: A high-emphasis background for prominence.", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "Applies a border using shorthand syntax to specify width, color, and style in a single property.\n\nAccepts a size value, optionally followed by a color, optionally followed by a style. Omitted values use defaults: color defaults to `base`, style defaults to `auto`.\n\nIndividual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "Controls the roundedness of the element's corners using the design system's radius scale.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- One value: applies to all corners\n- Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively\n- Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively\n- Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively\n\nExamples:\n- `small-100`: All corners have `small-100` radius\n- `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`\n- `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`\n- `small-100 none large-100 base`: Each corner has its specified radius value", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the clickable, meaning it cannot be clicked or receive focus.\n\nIn this state, the `click` event will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element.\n\nHowever, items within the clickable can still receive focus and be interacted with.\n\nThis has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Disables the clickable, and indicates to assistive technology that the loading is in progress.\n\nThis also disables the clickable.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n\n- `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.\n- `'_blank'`: Opens the URL in a new tab or window.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'submit' | 'button'", + "description": "The behavioral type of the clickable component, which determines what action it performs when activated.\n\n- `submit`: Submits the nearest containing form.\n- `button`: Performs no default action, relying on the `click` event handler for behavior.\n\nThis property is ignored if `href` or `commandFor`/`command` is set.", + "isOptional": true, + "defaultValue": "'button'" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Clickable.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ClickableElement extends ClickableElementProps, Omit {\n onblur: ClickableEvents['onBlur'];\n onclick: ClickableEvents['onClick'];\n onfocus: ClickableEvents['onFocus'];\n}" + } + }, + "ClickableChipElementProps": { + "src/surfaces/checkout/components/ClickableChip.ts": { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "name": "ClickableChipElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Determines whether the chip is hidden.\n\nIf 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.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "removable", + "value": "boolean", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface ClickableChipElementProps extends Pick {\n}" + } + }, + "ClickableChipEvents": { + "src/surfaces/checkout/components/ClickableChip.ts": { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "name": "ClickableChipEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the chip is clicked. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onRemove", + "value": "(event: Event) => void", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", + "isOptional": true + } + ], + "value": "export interface ClickableChipEvents extends Pick {\n}" + } + }, + "ClickableChipElementEvents": { + "src/surfaces/checkout/components/ClickableChip.ts": { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "name": "ClickableChipElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener", + "description": "A callback fired after the chip is hidden. The `hidden` property will be `true` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener", + "description": "A callback fired when the chip is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "remove", + "value": "CallbackEventListener", + "description": "A callback fired when the chip is removed.", + "isOptional": true + } + ], + "value": "export interface ClickableChipElementEvents {\n /**\n * A callback fired after the chip is hidden. The `hidden` property will be `true` when this event fires.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback fired when the chip is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n /**\n * A callback fired when the chip is removed.\n */\n remove?: CallbackEventListener;\n}" + } + }, + "ClickableChipElementSlots": { + "src/surfaces/checkout/components/ClickableChip.ts": { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "name": "ClickableChipElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "HTMLElement", + "description": "An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.", + "isOptional": true + } + ], + "value": "export interface ClickableChipElementSlots {\n /**\n * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported.\n */\n graphic?: HTMLElement;\n}" + } + }, + "ClickableChipElement": { + "src/surfaces/checkout/components/ClickableChip.ts": { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "name": "ClickableChipElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Determines whether the chip is hidden.\n\nIf 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.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onafterhide", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onremove", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "removable", + "value": "boolean", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ClickableChipElement extends ClickableChipElementProps, Omit {\n onafterhide: ClickableChipEvents['onAfterHide'];\n onclick: ClickableChipEvents['onClick'];\n onremove: ClickableChipEvents['onRemove'];\n}" + } + }, + "ClickableChipProps": { + "src/surfaces/checkout/components/ClickableChip.ts": { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "name": "ClickableChipProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "Determines whether the chip is hidden.\n\nIf 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.\n\nIf the chip is not `removable`, it can still be hidden by setting this property.\n\nWhen using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the chip has fully hidden after a removal animation.\n\nThe `hidden` property will be `true` when this event fires.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the chip is clicked. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "onRemove", + "value": "(event: Event) => void", + "description": "A callback fired when the chip is removed by the user clicking the remove button.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClickableChip.ts", + "syntaxKind": "PropertySignature", + "name": "removable", + "value": "boolean", + "description": "Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface ClickableChipProps extends ClickableChipElementProps, ClickableChipEvents {\n}" + } + }, + "ClipboardItemElementProps": { + "src/surfaces/checkout/components/ClipboardItem.ts": { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "name": "ClipboardItemElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "text", + "value": "string", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface ClipboardItemElementProps extends Pick {\n}" + } + }, + "ClipboardItemEvents": { + "src/surfaces/checkout/components/ClipboardItem.ts": { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "name": "ClipboardItemEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onCopy", + "value": "(event: ClipboardEvent) => void", + "description": "Callback run when the copy to clipboard succeeds.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onCopyError", + "value": "(event: Event) => void", + "description": "Callback run when the copy to clipboard fails.", + "isOptional": true + } + ], + "value": "export interface ClipboardItemEvents extends Pick {\n}" + } + }, + "ClipboardItemElementEvents": { + "src/surfaces/checkout/components/ClipboardItem.ts": { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "name": "ClipboardItemElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "copy", + "value": "CallbackEventListener", + "description": "A callback fired when the text is successfully copied to the clipboard. Use this to show a confirmation message or update the UI.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "copyerror", + "value": "CallbackEventListener", + "description": "A callback fired when the copy to clipboard fails. Use this to display an error message or provide a fallback action.", + "isOptional": true + } + ], + "value": "export interface ClipboardItemElementEvents {\n /**\n * A callback fired when the text is successfully copied to the clipboard. Use this to show a confirmation message or update the UI.\n */\n copy?: CallbackEventListener;\n /**\n * A callback fired when the copy to clipboard fails. Use this to display an error message or provide a fallback action.\n */\n copyerror?: CallbackEventListener;\n}" + } + }, + "ClipboardItemElement": { + "src/surfaces/checkout/components/ClipboardItem.ts": { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "name": "ClipboardItemElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "(event: ClipboardEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncopyerror", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "text", + "value": "string", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ClipboardItemElement extends ClipboardItemElementProps, Omit {\n oncopy: ClipboardItemEvents['onCopy'];\n oncopyerror: ClipboardItemEvents['onCopyError'];\n}" + } + }, + "ClipboardItemProps": { + "src/surfaces/checkout/components/ClipboardItem.ts": { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "name": "ClipboardItemProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onCopy", + "value": "(event: ClipboardEvent) => void", + "description": "Callback run when the copy to clipboard succeeds.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "onCopyError", + "value": "(event: Event) => void", + "description": "Callback run when the copy to clipboard fails.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ClipboardItem.ts", + "syntaxKind": "PropertySignature", + "name": "text", + "value": "string", + "description": "Plain text to be written to the clipboard.\n\nRich text, HTML, and binary content aren't supported.", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface ClipboardItemProps extends ClipboardItemElementProps, ClipboardItemEvents {\n}" + } + }, + "ConsentCheckboxElementProps": { + "src/surfaces/checkout/components/ConsentCheckbox.ts": { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "name": "ConsentCheckboxElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "policy", + "value": "'sms-marketing'", + "description": "The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface ConsentCheckboxElementProps extends Pick {\n command?: Extract;\n /**\n * The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentCheckboxProps$1['policy'];\n}" + } + }, + "ConsentCheckboxEvents": { + "src/surfaces/checkout/components/ConsentCheckbox.ts": { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "name": "ConsentCheckboxEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed.", + "isOptional": true + } + ], + "value": "export interface ConsentCheckboxEvents extends Pick {\n}" + } + }, + "ConsentCheckboxElementEvents": { + "src/surfaces/checkout/components/ConsentCheckbox.ts": { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "name": "ConsentCheckboxElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the consent checkbox value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + } + ], + "value": "export interface ConsentCheckboxElementEvents {\n /**\n * A callback fired when the consent checkbox value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" + } + }, + "ConsentCheckboxElement": { + "src/surfaces/checkout/components/ConsentCheckbox.ts": { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "name": "ConsentCheckboxElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "policy", + "value": "'sms-marketing'", + "description": "The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ConsentCheckboxElement extends ConsentCheckboxElementProps, Omit {\n onchange: ConsentCheckboxEvents['onChange'];\n}" + } + }, + "ConsentCheckboxProps": { + "src/surfaces/checkout/components/ConsentCheckbox.ts": { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "name": "ConsentCheckboxProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "policy", + "value": "'sms-marketing'", + "description": "The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentCheckbox.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface ConsentCheckboxProps extends ConsentCheckboxElementProps, ConsentCheckboxEvents {\n}" + } + }, + "PhoneFieldElementProps": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "PhoneFieldElementProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'mobile' | ''", + "description": "The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface PhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + } + }, + "AutocompleteSection": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteSection", + "value": "`section-${string}`", + "description": "The “section” scopes the autocomplete data that should be inserted to a specific area of the page.\n\nCommonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page." + } + }, + "AutocompleteGroup": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AutocompleteGroup", + "value": "\"shipping\" | \"billing\"", + "description": "The contact information group the autocomplete data should be sourced from." + } + }, + "PhoneFieldEvents": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "PhoneFieldEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + } + ], + "value": "export interface PhoneFieldEvents extends Pick {\n}" + } + }, + "PhoneFieldElement": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "PhoneFieldElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'mobile' | ''", + "description": "The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface PhoneFieldElement extends PhoneFieldElementProps, Omit {\n onblur: PhoneFieldEvents['onBlur'];\n onchange: PhoneFieldEvents['onChange'];\n onfocus: PhoneFieldEvents['onFocus'];\n oninput: PhoneFieldEvents['onInput'];\n}" + } + }, + "PhoneFieldProps": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "PhoneFieldProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'mobile' | ''", + "description": "The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface PhoneFieldProps extends PhoneFieldElementProps, PhoneFieldEvents {\n}" + } + }, + "ConsentPhoneFieldElementProps": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "ConsentPhoneFieldElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "policy", + "value": "'sms-marketing'", + "description": "The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'mobile' | ''", + "description": "The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface ConsentPhoneFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n /**\n * The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.\n *\n * - `sms-marketing`: Represents the policy for SMS marketing consent.\n */\n policy?: ConsentPhoneFieldProps$1['policy'];\n}" + } + }, + "ConsentPhoneFieldEvents": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "ConsentPhoneFieldEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + } + ], + "value": "export interface ConsentPhoneFieldEvents extends Pick {\n}" + } + }, + "ConsentPhoneFieldElementEvents": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "ConsentPhoneFieldElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the consent phone field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the consent phone field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the consent phone field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the consent phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface ConsentPhoneFieldElementEvents {\n /**\n * A callback fired when the consent phone field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the consent phone field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the consent phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + } + }, + "ConsentPhoneFieldElement": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "ConsentPhoneFieldElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "policy", + "value": "'sms-marketing'", + "description": "The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'mobile' | ''", + "description": "The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface ConsentPhoneFieldElement extends ConsentPhoneFieldElementProps, Omit {\n onblur: ConsentPhoneFieldEvents['onBlur'];\n onchange: ConsentPhoneFieldEvents['onChange'];\n onfocus: ConsentPhoneFieldEvents['onFocus'];\n oninput: ConsentPhoneFieldEvents['onInput'];\n}" + } + }, + "ConsentPhoneFieldElementSlots": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "ConsentPhoneFieldElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface ConsentPhoneFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "ConsentPhoneFieldProps": { + "src/surfaces/checkout/components/ConsentPhoneField.ts": { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "name": "ConsentPhoneFieldProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "policy", + "value": "'sms-marketing'", + "description": "The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.\n\n- `sms-marketing`: Represents the policy for SMS marketing consent.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'mobile' | ''", + "description": "The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type.\n\nStyling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ConsentPhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface ConsentPhoneFieldProps extends ConsentPhoneFieldElementProps, ConsentPhoneFieldEvents {\n}" + } + }, + "DateFieldElementProps": { + "src/surfaces/checkout/components/DateField.ts": { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "name": "DateFieldElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "allow", + "value": "string", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`2024-02--2025` // allow any date from February 2024 to the end of 2025\n`2024-02--` // allow any date from February 2024 to the end of the month\n`2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "allowDays", + "value": "string", + "description": "Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultView", + "value": "string", + "description": "Default month to display in `YYYY-MM` format.\n\nThis value is used until `view` is set, either directly or as a result of user interaction.\n\nDefaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "disallow", + "value": "string", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`--2024-02` // disallow any date before February 2024\n`2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "disallowDays", + "value": "string", + "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allowDays`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "view", + "value": "string", + "description": "Displayed month in `YYYY-MM` format.\n\n`onViewChange` is called when this value changes.\n\nDefaults to `defaultView`.", + "isOptional": true + } + ], + "value": "export interface DateFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + } + }, + "DateFieldEvents": { + "src/surfaces/checkout/components/DateField.ts": { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "name": "DateFieldEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onInvalid", + "value": "(event: Event) => void", + "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nThis callback fires only when the user finishes editing the date, right after the `change` callback. The field isn't validated on every change to the input. Once the user has finished editing the field (typically by blurring it), the field is validated and the callback fires if the value is invalid.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onViewChange", + "value": "(view: string) => void", + "description": "Called whenever the month to display changes.", + "isOptional": true + } + ], + "value": "export interface DateFieldEvents extends Pick {\n}" + } + }, + "DateFieldElementEvents": { + "src/surfaces/checkout/components/DateField.ts": { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "name": "DateFieldElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the date field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the date field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the date field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the date field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "invalid", + "value": "CallbackEventListener", + "description": "A callback fired when the date field value is invalid.\n\nLearn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "viewChange", + "value": "CallbackEventListener", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", + "isOptional": true + } + ], + "value": "export interface DateFieldElementEvents {\n /**\n * A callback fired when the date field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the date field value is invalid.\n *\n * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event).\n */\n invalid?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" + } + }, + "DateFieldElement": { + "src/surfaces/checkout/components/DateField.ts": { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "name": "DateFieldElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "allow", + "value": "string", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`2024-02--2025` // allow any date from February 2024 to the end of 2025\n`2024-02--` // allow any date from February 2024 to the end of the month\n`2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "allowDays", + "value": "string", + "description": "Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultView", + "value": "string", + "description": "Default month to display in `YYYY-MM` format.\n\nThis value is used until `view` is set, either directly or as a result of user interaction.\n\nDefaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "disallow", + "value": "string", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`--2024-02` // disallow any date before February 2024\n`2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "disallowDays", + "value": "string", + "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allowDays`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onviewchange", + "value": "(view: string) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "view", + "value": "string", + "description": "Displayed month in `YYYY-MM` format.\n\n`onViewChange` is called when this value changes.\n\nDefaults to `defaultView`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface DateFieldElement extends DateFieldElementProps, Omit, Omit {\n onblur: DateFieldEvents['onBlur'];\n onchange: DateFieldEvents['onChange'];\n onfocus: DateFieldEvents['onFocus'];\n oninput: DateFieldEvents['onInput'];\n oninvalid: DateFieldEvents['onInvalid'];\n onviewchange: DateFieldEvents['onViewChange'];\n}" + } + }, + "DateFieldProps": { + "src/surfaces/checkout/components/DateField.ts": { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "name": "DateFieldProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "allow", + "value": "string", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`2024-02--2025` // allow any date from February 2024 to the end of 2025\n`2024-02--` // allow any date from February 2024 to the end of the month\n`2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "allowDays", + "value": "string", + "description": "Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultView", + "value": "string", + "description": "Default month to display in `YYYY-MM` format.\n\nThis value is used until `view` is set, either directly or as a result of user interaction.\n\nDefaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "disallow", + "value": "string", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`--2024-02` // disallow any date before February 2024\n`2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "disallowDays", + "value": "string", + "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allowDays`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onInvalid", + "value": "(event: Event) => void", + "description": "Callback when the field has an invalid date. This callback will be called, if the date typed is invalid or disabled.\n\nDates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are:\n- 2021-02-31: February doesn’t have 31 days\n- 2021-02-00: The day can’t be 00\n\nDisallowed dates are considered invalid.\n\nThis callback fires only when the user finishes editing the date, right after the `change` callback. The field isn't validated on every change to the input. Once the user has finished editing the field (typically by blurring it), the field is validated and the callback fires if the value is invalid.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "onViewChange", + "value": "(view: string) => void", + "description": "Called whenever the month to display changes.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DateField.ts", + "syntaxKind": "PropertySignature", + "name": "view", + "value": "string", + "description": "Displayed month in `YYYY-MM` format.\n\n`onViewChange` is called when this value changes.\n\nDefaults to `defaultView`.", + "isOptional": true + } + ], + "value": "export interface DateFieldProps extends DateFieldElementProps, DateFieldEvents {\n}" + } + }, + "DatePickerElementProps": { + "src/surfaces/checkout/components/DatePicker.ts": { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "name": "DatePickerElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "allow", + "value": "string", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`2024-02--2025` // allow any date from February 2024 to the end of 2025\n`2024-02--` // allow any date from February 2024 to the end of the month\n`2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "allowDays", + "value": "string", + "description": "Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "Default selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "isOptional": true, + "defaultValue": "\"\"" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "defaultView", + "value": "string", + "description": "Default month to display in `YYYY-MM` format.\n\nThis value is used until `view` is set, either directly or as a result of user interaction.\n\nDefaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "disallow", + "value": "string", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`--2024-02` // disallow any date before February 2024\n`2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "disallowDays", + "value": "string", + "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allowDays`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'single' | 'multiple' | 'range'", + "description": "The type of selection the date picker allows.\n\n- `single` allows selecting a single date.\n- `multiple` allows selecting multiple non-contiguous dates.\n- `range` allows selecting a single range of dates.", + "isOptional": true, + "defaultValue": "\"single\"" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", + "isOptional": true, + "defaultValue": "\"\"" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "view", + "value": "string", + "description": "Displayed month in `YYYY-MM` format.\n\n`onViewChange` is called when this value changes.\n\nDefaults to `defaultView`.", + "isOptional": true + } + ], + "value": "export interface DatePickerElementProps extends Pick {\n}" + } + }, + "DatePickerEvents": { + "src/surfaces/checkout/components/DatePicker.ts": { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "name": "DatePickerEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "Callback when the `value` is changed. For `type=\"single\"` and `type=\"multiple\"`, this is the same as `onInput`. For `type=\"range\"`, this is only called when the range is completed by selecting the end date of the range.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "Callback when any date is selected. Will fire before `onChange`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onViewChange", + "value": "(view: string) => void", + "description": "Called whenever the month to display changes.", + "isOptional": true + } + ], + "value": "export interface DatePickerEvents extends Pick {\n}" + } + }, + "DatePickerElementEvents": { + "src/surfaces/checkout/components/DatePicker.ts": { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "name": "DatePickerElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the date picker loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the date picker value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the date picker receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the date picker.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "viewChange", + "value": "CallbackEventListener", + "description": "A callback fired when the calendar view changes, such as when navigating between months.", + "isOptional": true + } + ], + "value": "export interface DatePickerElementEvents {\n /**\n * A callback fired when the date picker loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the date picker value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the date picker receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the date picker.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the calendar view changes, such as when navigating between months.\n */\n viewChange?: CallbackEventListener;\n}" + } + }, + "DatePickerElement": { + "src/surfaces/checkout/components/DatePicker.ts": { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "name": "DatePickerElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "allow", + "value": "string", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`2024-02--2025` // allow any date from February 2024 to the end of 2025\n`2024-02--` // allow any date from February 2024 to the end of the month\n`2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "allowDays", + "value": "string", + "description": "Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "Default selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "isOptional": true, + "defaultValue": "\"\"" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "defaultView", + "value": "string", + "description": "Default month to display in `YYYY-MM` format.\n\nThis value is used until `view` is set, either directly or as a result of user interaction.\n\nDefaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "disallow", + "value": "string", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`--2024-02` // disallow any date before February 2024\n`2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "disallowDays", + "value": "string", + "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allowDays`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onviewchange", + "value": "(view: string) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'single' | 'multiple' | 'range'", + "description": "The type of selection the date picker allows.\n\n- `single` allows selecting a single date.\n- `multiple` allows selecting multiple non-contiguous dates.\n- `range` allows selecting a single range of dates.", + "isOptional": true, + "defaultValue": "\"single\"" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", + "isOptional": true, + "defaultValue": "\"\"" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "view", + "value": "string", + "description": "Displayed month in `YYYY-MM` format.\n\n`onViewChange` is called when this value changes.\n\nDefaults to `defaultView`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface DatePickerElement extends DatePickerElementProps, Omit, Omit {\n onblur: DatePickerEvents['onBlur'];\n onchange: DatePickerEvents['onChange'];\n onfocus: DatePickerEvents['onFocus'];\n oninput: DatePickerEvents['onInput'];\n onviewchange: DatePickerEvents['onViewChange'];\n}" + } + }, + "DatePickerProps": { + "src/surfaces/checkout/components/DatePicker.ts": { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "name": "DatePickerProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "allow", + "value": "string", + "description": "Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.\n\nThe default `''` allows all dates.\n\n- Dates in `YYYY-MM-DD` format allow a single date.\n- Dates in `YYYY-MM` format allow a whole month.\n- Dates in `YYYY` format allow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of allowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`2024-02--2025` // allow any date from February 2024 to the end of 2025\n`2024-02--` // allow any date from February 2024 to the end of the month\n`2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "allowDays", + "value": "string", + "description": "Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on the result of `allow` and `disallow`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "Default selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.", + "isOptional": true, + "defaultValue": "\"\"" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "defaultView", + "value": "string", + "description": "Default month to display in `YYYY-MM` format.\n\nThis value is used until `view` is set, either directly or as a result of user interaction.\n\nDefaults to the current month in the user's locale.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "disallow", + "value": "string", + "description": "Dates that cannot be selected. These subtract from `allow`.\n\nA comma-separated list of dates, date ranges. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allow`.\n\n- Dates in `YYYY-MM-DD` format disallow a single date.\n- Dates in `YYYY-MM` format disallow a whole month.\n- Dates in `YYYY` format disallow a whole year.\n- Ranges are expressed as `start--end`. - Ranges are inclusive.\n - If either `start` or `end` is omitted, the range is unbounded in that direction.\n - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value.\n So `2024--` is equivalent to `2024-01-01--`.\n - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value.\n So `--2024` is equivalent to `--2024-12-31`.\n - Whitespace is allowed either side of `--`.\n\nComma-separated list of disallowed dates in `YYYY-MM-DD` format.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "`--2024-02` // disallow any date before February 2024\n`2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "disallowDays", + "value": "string", + "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`.\n\nA comma-separated list of days. Whitespace is allowed after commas.\n\nThe default `''` has no effect on `allowDays`.\n\nDays are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`.", + "isOptional": true, + "defaultValue": "\"\"", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`.", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "Callback when the `value` is changed. For `type=\"single\"` and `type=\"multiple\"`, this is the same as `onInput`. For `type=\"range\"`, this is only called when the range is completed by selecting the end date of the range.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "Callback when any date is selected. Will fire before `onChange`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "onViewChange", + "value": "(view: string) => void", + "description": "Called whenever the month to display changes.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'single' | 'multiple' | 'range'", + "description": "The type of selection the date picker allows.\n\n- `single` allows selecting a single date.\n- `multiple` allows selecting multiple non-contiguous dates.\n- `range` allows selecting a single range of dates.", + "isOptional": true, + "defaultValue": "\"single\"" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "Current selected value.\n\nThe default means no date is selected.\n\nIf the provided value is invalid, no date is selected.\n\nOtherwise:\n\n- If `type=\"single\"`, this is a date in `YYYY-MM-DD` format.\n- If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format.\n- If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive.\n\nSingle dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported.", + "isOptional": true, + "defaultValue": "\"\"" + }, + { + "filePath": "src/surfaces/checkout/components/DatePicker.ts", + "syntaxKind": "PropertySignature", + "name": "view", + "value": "string", + "description": "Displayed month in `YYYY-MM` format.\n\n`onViewChange` is called when this value changes.\n\nDefaults to `defaultView`.", + "isOptional": true + } + ], + "value": "export interface DatePickerProps extends DatePickerElementProps, DatePickerEvents {\n}" + } + }, + "DetailsElementProps": { + "src/surfaces/checkout/components/Details.ts": { + "filePath": "src/surfaces/checkout/components/Details.ts", + "name": "DetailsElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "defaultOpen", + "value": "boolean", + "description": "Whether the element should be open when it first renders. Use this for uncontrolled behavior where the component manages its own open state after the initial render.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "open", + "value": "boolean", + "description": "Whether the element is currently open and showing its content. Use this for controlled behavior where you manage the open state yourself.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "toggleTransition", + "value": "'none' | 'auto'", + "description": "Sets the animation transition between the open and closed states.\n\n- `none`: Disables all transition animations.\n- `auto`: Uses the default transition animation.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface DetailsElementProps extends Pick {\n}" + } + }, + "DetailsEvents": { + "src/surfaces/checkout/components/Details.ts": { + "filePath": "src/surfaces/checkout/components/Details.ts", + "name": "DetailsEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and the [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + } + ], + "value": "export interface DetailsEvents extends Pick {\n}" + } + }, + "DetailsElementEvents": { + "src/surfaces/checkout/components/Details.ts": { + "filePath": "src/surfaces/checkout/components/Details.ts", + "name": "DetailsElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "aftertoggle", + "value": "CallbackEventListener", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "toggle", + "value": "CallbackEventListener", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and the [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + } + ], + "value": "export interface DetailsElementEvents {\n /**\n * A callback fired immediately when the element state changes, before any animations.\n *\n * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and the [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).\n */\n toggle?: CallbackEventListener;\n /**\n * A callback fired when the element state changes, after any toggle animations have finished.\n *\n * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the\n * `newState` property will be set to `open`.\n * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the\n * `newState` will be `closed`.\n *\n * Learn more about the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties.\n */\n aftertoggle?: CallbackEventListener;\n}" + } + }, + "DetailsElement": { + "src/surfaces/checkout/components/Details.ts": { + "filePath": "src/surfaces/checkout/components/Details.ts", + "name": "DetailsElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onaftertoggle", + "value": "(event: ToggleEvent$1) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "(event: ToggleEvent$1) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface DetailsElement extends Omit {\n ontoggle: DetailsEvents['onToggle'];\n onaftertoggle: DetailsEvents['onAfterToggle'];\n}" + } + }, + "DetailsProps": { + "src/surfaces/checkout/components/Details.ts": { + "filePath": "src/surfaces/checkout/components/Details.ts", + "name": "DetailsProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "defaultOpen", + "value": "boolean", + "description": "Whether the element should be open when it first renders. Use this for uncontrolled behavior where the component manages its own open state after the initial render.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired when the element state changes, after any toggle animations have finished.\n\n- If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "onToggle", + "value": "(event: ToggleEvent$1) => void", + "description": "A callback fired immediately when the element state changes, before any animations.\n\n- If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the `newState` property will be set to `open`.\n- If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the `newState` will be `closed`.\n\nLearn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and the [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "open", + "value": "boolean", + "description": "Whether the element is currently open and showing its content. Use this for controlled behavior where you manage the open state yourself.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Details.ts", + "syntaxKind": "PropertySignature", + "name": "toggleTransition", + "value": "'none' | 'auto'", + "description": "Sets the animation transition between the open and closed states.\n\n- `none`: Disables all transition animations.\n- `auto`: Uses the default transition animation.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface DetailsProps extends DetailsElementProps, DetailsEvents {\n}" + } + }, + "DividerElementProps": { + "src/surfaces/checkout/components/Divider.ts": { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "name": "DividerElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "'inline' | 'block'", + "description": "The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `inline`: A horizontal divider that separates content stacked vertically.\n- `block`: A vertical divider that separates content arranged horizontally. Requires a parent with a defined height to render visibly.", + "isOptional": true, + "defaultValue": "'inline'" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface DividerElementProps extends Pick {\n}" + } + }, + "DividerElement": { + "src/surfaces/checkout/components/Divider.ts": { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "name": "DividerElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "'inline' | 'block'", + "description": "The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `inline`: A horizontal divider that separates content stacked vertically.\n- `block`: A vertical divider that separates content arranged horizontally. Requires a parent with a defined height to render visibly.", + "isOptional": true, + "defaultValue": "'inline'" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface DividerElement extends DividerElementProps, Omit {\n}" + } + }, + "DividerProps": { + "src/surfaces/checkout/components/Divider.ts": { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "name": "DividerProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "'inline' | 'block'", + "description": "The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `inline`: A horizontal divider that separates content stacked vertically.\n- `block`: A vertical divider that separates content arranged horizontally. Requires a parent with a defined height to render visibly.", + "isOptional": true, + "defaultValue": "'inline'" + }, + { + "filePath": "src/surfaces/checkout/components/Divider.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface DividerProps extends DividerElementProps {\n}" + } + }, + "DropZoneElementProps": { + "src/surfaces/checkout/components/DropZone.ts": { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "name": "DropZoneElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "accept", + "value": "string", + "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:\n- A file extension starting with a period (\".\") character (such as .jpg, .pdf, .doc)\n- A valid MIME type string with no extensions\n\nIf omitted, all file types are accepted.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple files can be selected or dropped at once.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "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.", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface DropZoneElementProps extends Pick {\n}" + } + }, + "DropZoneEvents": { + "src/surfaces/checkout/components/DropZone.ts": { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "name": "DropZoneEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished selecting one or more files.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onDropRejected", + "value": "(event: Event) => void", + "description": "Callback fired when rejected files are dropped. Files are rejected based on the `accept` prop and are not added to `files`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes to the file selection.", + "isOptional": true + } + ], + "value": "export interface DropZoneEvents extends Pick {\n}" + } + }, + "DropZoneElementEvents": { + "src/surfaces/checkout/components/DropZone.ts": { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "name": "DropZoneElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the drop zone value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "droprejected", + "value": "CallbackEventListener", + "description": "A callback fired when files are rejected based on the `accept` prop.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the drop zone.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface DropZoneElementEvents {\n /**\n * A callback fired when files are rejected based on the `accept` prop.\n */\n droprejected?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the drop zone.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n /**\n * A callback fired when the drop zone value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" + } + }, + "DropZoneElement": { + "src/surfaces/checkout/components/DropZone.ts": { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "name": "DropZoneElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "accept", + "value": "string", + "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:\n- A file extension starting with a period (\".\") character (such as .jpg, .pdf, .doc)\n- A valid MIME type string with no extensions\n\nIf omitted, all file types are accepted.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple files can be selected or dropped at once.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondroprejected", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface DropZoneElement extends DropZoneElementProps, Omit {\n ondroprejected: DropZoneEvents['onDropRejected'];\n oninput: DropZoneEvents['onInput'];\n onchange: DropZoneEvents['onChange'];\n}" + } + }, + "DropZoneProps": { + "src/surfaces/checkout/components/DropZone.ts": { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "name": "DropZoneProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "accept", + "value": "string", + "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:\n- A file extension starting with a period (\".\") character (such as .jpg, .pdf, .doc)\n- A valid MIME type string with no extensions\n\nIf omitted, all file types are accepted.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "multiple", + "value": "boolean", + "description": "Whether multiple files can be selected or dropped at once.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has finished selecting one or more files.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onDropRejected", + "value": "(event: Event) => void", + "description": "Callback fired when rejected files are dropped. Files are rejected based on the `accept` prop and are not added to `files`.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes to the file selection.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/DropZone.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "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.", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface DropZoneProps extends DropZoneElementProps, DropZoneEvents {\n}" + } + }, + "EmailFieldElementProps": { + "src/surfaces/checkout/components/EmailField.ts": { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "name": "EmailFieldElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface EmailFieldElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + } + }, + "EmailFieldEvents": { + "src/surfaces/checkout/components/EmailField.ts": { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "name": "EmailFieldEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + } + ], + "value": "export interface EmailFieldEvents extends Pick {\n}" + } + }, + "EmailFieldElementEvents": { + "src/surfaces/checkout/components/EmailField.ts": { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "name": "EmailFieldElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the email field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the email field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the email field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the email field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface EmailFieldElementEvents {\n /**\n * A callback fired when the email field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the email field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the email field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the email field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + } + }, + "EmailFieldElementSlots": { + "src/surfaces/checkout/components/EmailField.ts": { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "name": "EmailFieldElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface EmailFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "EmailFieldElement": { + "src/surfaces/checkout/components/EmailField.ts": { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "name": "EmailFieldElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface EmailFieldElement extends EmailFieldElementProps, Omit {\n onblur: EmailFieldEvents['onBlur'];\n onchange: EmailFieldEvents['onChange'];\n onfocus: EmailFieldEvents['onFocus'];\n oninput: EmailFieldEvents['onInput'];\n}" + } + }, + "EmailFieldProps": { + "src/surfaces/checkout/components/EmailField.ts": { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "name": "EmailFieldProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/EmailField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface EmailFieldProps extends EmailFieldElementProps, EmailFieldEvents {\n}" + } + }, + "FormElementProps": { + "src/surfaces/checkout/components/Form.ts": { + "filePath": "src/surfaces/checkout/components/Form.ts", + "name": "FormElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the form is able to be submitted.\n\nWhen set to `true`, this will also disable the implicit submit behavior of the form.", + "isOptional": true, + "deprecationMessage": "Prevent default within the onSubmit callback using a local state instead. Deprecated in v1.6.0", + "isPrivate": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface FormElementProps extends Pick {\n}" + } + }, + "FormEvents": { + "src/surfaces/checkout/components/Form.ts": { + "filePath": "src/surfaces/checkout/components/Form.ts", + "name": "FormEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onSubmit", + "value": "() => void", + "description": "A callback that is run when the form is submitted.", + "isOptional": true + } + ], + "value": "export interface FormEvents extends Pick {\n /**\n * A callback that is run when the form is submitted.\n */\n onSubmit?: () => void;\n}" + } + }, + "FormElementEvents": { + "src/surfaces/checkout/components/Form.ts": { + "filePath": "src/surfaces/checkout/components/Form.ts", + "name": "FormElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "submit", + "value": "CallbackEventListener", + "description": "A callback fired when the form is submitted.", + "isOptional": true + } + ], + "value": "export interface FormElementEvents {\n /**\n * A callback fired when the form is submitted.\n */\n submit?: CallbackEventListener;\n}" + } + }, + "FormElement": { + "src/surfaces/checkout/components/Form.ts": { + "filePath": "src/surfaces/checkout/components/Form.ts", + "name": "FormElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the form is able to be submitted.\n\nWhen set to `true`, this will also disable the implicit submit behavior of the form.", + "isOptional": true, + "deprecationMessage": "Prevent default within the onSubmit callback using a local state instead. Deprecated in v1.6.0", + "isPrivate": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "() => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface FormElement extends FormElementProps, Omit {\n onsubmit: FormEvents['onSubmit'];\n}" + } + }, + "FormProps": { + "src/surfaces/checkout/components/Form.ts": { + "filePath": "src/surfaces/checkout/components/Form.ts", + "name": "FormProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the form is able to be submitted.\n\nWhen set to `true`, this will also disable the implicit submit behavior of the form.", + "isOptional": true, + "deprecationMessage": "Prevent default within the onSubmit callback using a local state instead. Deprecated in v1.6.0", + "isPrivate": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Form.ts", + "syntaxKind": "PropertySignature", + "name": "onSubmit", + "value": "() => void", + "description": "A callback that is run when the form is submitted.", + "isOptional": true + } + ], + "value": "export interface FormProps extends FormElementProps, FormEvents {\n}" + } + }, + "ReducedAlignContentKeyword": { + "src/surfaces/checkout/components/Grid.ts": { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReducedAlignContentKeyword", + "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", + "description": "The subset of `align-content` values available for the grid component.\n\n- `center`: Packs rows toward the center of the grid.\n- `start`: Packs rows toward the start of the block axis.\n- `end`: Packs rows toward the end of the block axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes rows evenly with no space at the edges.\n- `space-around`: Distributes rows evenly with equal space around each.\n- `space-evenly`: Distributes rows with equal space between and at the edges.\n- `stretch`: Stretches rows to fill the available space.", + "isPublicDocs": true + } + }, + "ReducedAlignItemsKeyword": { + "src/surfaces/checkout/components/Grid.ts": { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReducedAlignItemsKeyword", + "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", + "description": "The subset of `align-items` values available for the grid component.\n\n- `center`: Centers items along the block axis.\n- `start`: Aligns items to the start of the block axis.\n- `end`: Aligns items to the end of the block axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the block axis.", + "isPublicDocs": true + } + }, + "ReducedJustifyContentKeyword": { + "src/surfaces/checkout/components/Grid.ts": { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReducedJustifyContentKeyword", + "value": "'center' | 'start' | 'end' | 'normal' | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'", + "description": "The subset of `justify-content` values available for the grid component.\n\n- `center`: Packs columns toward the center of the grid.\n- `start`: Packs columns toward the start of the inline axis.\n- `end`: Packs columns toward the end of the inline axis.\n- `normal`: Default browser behavior.\n- `space-between`: Distributes columns evenly with no space at the edges.\n- `space-around`: Distributes columns evenly with equal space around each.\n- `space-evenly`: Distributes columns with equal space between and at the edges.\n- `stretch`: Stretches columns to fill the available space.", + "isPublicDocs": true + } + }, + "ReducedJustifyItemsKeyword": { + "src/surfaces/checkout/components/Grid.ts": { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ReducedJustifyItemsKeyword", + "value": "'center' | 'start' | 'end' | 'normal' | 'baseline' | 'stretch'", + "description": "The subset of `justify-items` values available for the grid component.\n\n- `center`: Centers items along the inline axis.\n- `start`: Aligns items to the start of the inline axis.\n- `end`: Aligns items to the end of the inline axis.\n- `normal`: Default browser behavior.\n- `baseline`: Aligns items along their text baseline.\n- `stretch`: Stretches items to fill the cell along the inline axis.", + "isPublicDocs": true + } + }, + "GridElementProps": { + "src/surfaces/checkout/components/Grid.ts": { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "name": "GridElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive", + "description": "Controls how the grid's rows are distributed along the block (column) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive", + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "'' | 'base'", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateColumns", + "value": "MaybeResponsive", + "description": "Defines the number and size of columns in the grid. Accepts any valid CSS [`grid-template-columns`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) value, such as `\"1fr 2fr\"` or `\"repeat(3, 1fr)\"`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateRows", + "value": "MaybeResponsive", + "description": "Defines the number and size of rows in the grid. Accepts any valid CSS [`grid-template-rows`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) value, such as `\"auto 1fr\"` or `\"repeat(2, 100px)\"`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive", + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "justifyItems", + "value": "MaybeResponsive", + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "placeContent", + "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "placeItems", + "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface GridElementProps extends Pick {\n /**\n * Controls how the grid's rows are distributed along the block (column) axis when there is extra space. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n alignContent?: MaybeResponsive;\n /**\n * Aligns grid items along the block (column) axis. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n alignItems?: MaybeResponsive;\n /**\n * The background color of the grid.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the grid's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n justifyContent?: MaybeResponsive;\n /**\n * Aligns grid items along the inline (row) axis. Set to an empty string to use the default.\n *\n * @default '' - meaning no override\n */\n justifyItems?: MaybeResponsive;\n /**\n * A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.\n *\n * @default 'normal normal'\n */\n placeContent?: MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>;\n /**\n * A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.\n *\n * @default 'normal normal'\n */\n placeItems?: MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>;\n}" + } + }, + "GridProps": { + "src/surfaces/checkout/components/Grid.ts": { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "name": "GridProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive", + "description": "Controls how the grid's rows are distributed along the block (column) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive", + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "'' | 'base'", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateColumns", + "value": "MaybeResponsive", + "description": "Defines the number and size of columns in the grid. Accepts any valid CSS [`grid-template-columns`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) value, such as `\"1fr 2fr\"` or `\"repeat(3, 1fr)\"`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateRows", + "value": "MaybeResponsive", + "description": "Defines the number and size of rows in the grid. Accepts any valid CSS [`grid-template-rows`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) value, such as `\"auto 1fr\"` or `\"repeat(2, 100px)\"`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive", + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "justifyItems", + "value": "MaybeResponsive", + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "placeContent", + "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "placeItems", + "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface GridProps extends GridElementProps {\n}" + } + }, + "SpacingKeyword": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "SpacingKeyword", + "value": "SizeKeyword | \"none\"", + "description": "" + } + }, + "GridElement": { + "src/surfaces/checkout/components/Grid.ts": { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "name": "GridElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive", + "description": "Controls how the grid's rows are distributed along the block (column) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive", + "description": "Aligns grid items along the block (column) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the grid.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "'' | 'base'", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the grid's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateColumns", + "value": "MaybeResponsive", + "description": "Defines the number and size of columns in the grid. Accepts any valid CSS [`grid-template-columns`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) value, such as `\"1fr 2fr\"` or `\"repeat(3, 1fr)\"`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "gridTemplateRows", + "value": "MaybeResponsive", + "description": "Defines the number and size of rows in the grid. Accepts any valid CSS [`grid-template-rows`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) value, such as `\"auto 1fr\"` or `\"repeat(2, 100px)\"`.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive", + "description": "Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "justifyItems", + "value": "MaybeResponsive", + "description": "Aligns grid items along the inline (row) axis. Set to an empty string to use the default.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "placeContent", + "value": "MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>", + "description": "A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "placeItems", + "value": "MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>", + "description": "A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once.", + "isOptional": true, + "defaultValue": "'normal normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Grid.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface GridElement extends GridElementProps, Omit {\n}" + } + }, + "GridItemElementProps": { + "src/surfaces/checkout/components/GridItem.ts": { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "name": "GridItemElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "'' | 'base'", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "gridColumn", + "value": "`span ${number}` | \"auto\"", + "description": "The number of columns this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of columns. Learn more about [`grid-column`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "gridRow", + "value": "`span ${number}` | \"auto\"", + "description": "The number of rows this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of rows. Learn more about [`grid-row`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface GridItemElementProps extends Pick {\n /**\n * The background color of the grid item.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the grid item's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" + } + }, + "GridItemProps": { + "src/surfaces/checkout/components/GridItem.ts": { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "name": "GridItemProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "'' | 'base'", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "gridColumn", + "value": "`span ${number}` | \"auto\"", + "description": "The number of columns this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of columns. Learn more about [`grid-column`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "gridRow", + "value": "`span ${number}` | \"auto\"", + "description": "The number of rows this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of rows. Learn more about [`grid-row`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface GridItemProps extends GridItemElementProps {\n}" + } + }, + "GridItemElement": { + "src/surfaces/checkout/components/GridItem.ts": { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "name": "GridItemElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the grid item.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "'' | 'base'", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the grid item's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "gridColumn", + "value": "`span ${number}` | \"auto\"", + "description": "The number of columns this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of columns. Learn more about [`grid-column`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "gridRow", + "value": "`span ${number}` | \"auto\"", + "description": "The number of rows this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of rows. Learn more about [`grid-row`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/GridItem.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface GridItemElement extends GridItemElementProps, Omit {\n}" + } + }, + "HeadingElementProps": { + "src/surfaces/checkout/components/Heading.ts": { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "name": "HeadingElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "'heading' | 'none' | 'presentation'", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `presentation`: Removes semantic meaning, making the element purely decorative and ignored by screen readers.\n- `none`: Completely hides the element and its content from assistive technologies.", + "isOptional": true, + "defaultValue": "'heading'" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface HeadingElementProps extends Pick {\n}" + } + }, + "HeadingElement": { + "src/surfaces/checkout/components/Heading.ts": { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "name": "HeadingElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "'heading' | 'none' | 'presentation'", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `presentation`: Removes semantic meaning, making the element purely decorative and ignored by screen readers.\n- `none`: Completely hides the element and its content from assistive technologies.", + "isOptional": true, + "defaultValue": "'heading'" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface HeadingElement extends HeadingElementProps, Omit {\n}" + } + }, + "HeadingProps": { + "src/surfaces/checkout/components/Heading.ts": { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "name": "HeadingProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "'heading' | 'none' | 'presentation'", + "description": "The semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `presentation`: Removes semantic meaning, making the element purely decorative and ignored by screen readers.\n- `none`: Completely hides the element and its content from assistive technologies.", + "isOptional": true, + "defaultValue": "'heading'" + }, + { + "filePath": "src/surfaces/checkout/components/Heading.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface HeadingProps extends HeadingElementProps {\n}" + } + }, + "IconElementProps": { + "src/surfaces/checkout/components/Icon.ts": { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "name": "IconElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'large' | 'base' | 'small-200' | 'small-100' | 'large-100'", + "description": "The size of the icon.\n\n- `'base'`: Default size that works well for most use cases.\n- `'small'`: Small icon for inline use within text or compact UI elements.\n- `'small-200'`: Extra small icon for the most compact contexts.\n- `'small-100'`: Small icon suitable for tight or dense layouts.\n- `'large'`: Large icon for emphasis or prominent display.\n- `'large-100'`: Extra large icon for maximum visual impact.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the icon.\n\n- `'info'`: Informational content or helpful tips.\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'success'`: Positive outcomes or successful states.\n- `'warning'`: Important warnings about potential issues.\n- `'critical'`: Urgent problems or destructive actions.\n- `'custom'`: Inherits a custom color from its parent element's CSS.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'' | ReducedIconTypes", + "description": "The type of icon that will be displayed. You can specify an icon name from the available icon set, or use an empty string to show no icon.", + "isOptional": true + } + ], + "value": "export interface IconElementProps extends Pick {\n /**\n * The semantic meaning and color treatment of the icon.\n *\n * - `'info'`: Informational content or helpful tips.\n * - `'auto'`: Automatically determined based on context.\n * - `'neutral'`: General information without specific intent.\n * - `'success'`: Positive outcomes or successful states.\n * - `'warning'`: Important warnings about potential issues.\n * - `'critical'`: Urgent problems or destructive actions.\n * - `'custom'`: Inherits a custom color from its parent element's CSS.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * The size of the icon.\n *\n * - `'base'`: Default size that works well for most use cases.\n * - `'small'`: Small icon for inline use within text or compact UI elements.\n * - `'small-200'`: Extra small icon for the most compact contexts.\n * - `'small-100'`: Small icon suitable for tight or dense layouts.\n * - `'large'`: Large icon for emphasis or prominent display.\n * - `'large-100'`: Extra large icon for maximum visual impact.\n *\n * @default 'base'\n */\n size?: Extract;\n /**\n * The type of icon that will be displayed. You can specify an icon name from the available icon set, or use an empty string to show no icon.\n */\n type?: '' | ReducedIconTypes;\n}" + } + }, + "IconElement": { + "src/surfaces/checkout/components/Icon.ts": { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "name": "IconElement", + "description": "The HTML element interface for the `s-icon` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'large' | 'base' | 'small-200' | 'small-100' | 'large-100'", + "description": "The size of the icon.\n\n- `'base'`: Default size that works well for most use cases.\n- `'small'`: Small icon for inline use within text or compact UI elements.\n- `'small-200'`: Extra small icon for the most compact contexts.\n- `'small-100'`: Small icon suitable for tight or dense layouts.\n- `'large'`: Large icon for emphasis or prominent display.\n- `'large-100'`: Extra large icon for maximum visual impact.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the icon.\n\n- `'info'`: Informational content or helpful tips.\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'success'`: Positive outcomes or successful states.\n- `'warning'`: Important warnings about potential issues.\n- `'critical'`: Urgent problems or destructive actions.\n- `'custom'`: Inherits a custom color from its parent element's CSS.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'' | ReducedIconTypes", + "description": "The type of icon that will be displayed. You can specify an icon name from the available icon set, or use an empty string to show no icon.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface IconElement extends IconElementProps, Omit {\n}" + } + }, + "IconProps": { + "src/surfaces/checkout/components/Icon.ts": { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "name": "IconProps", + "description": "The properties for the icon component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'large' | 'base' | 'small-200' | 'small-100' | 'large-100'", + "description": "The size of the icon.\n\n- `'base'`: Default size that works well for most use cases.\n- `'small'`: Small icon for inline use within text or compact UI elements.\n- `'small-200'`: Extra small icon for the most compact contexts.\n- `'small-100'`: Small icon suitable for tight or dense layouts.\n- `'large'`: Large icon for emphasis or prominent display.\n- `'large-100'`: Extra large icon for maximum visual impact.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the icon.\n\n- `'info'`: Informational content or helpful tips.\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: General information without specific intent.\n- `'success'`: Positive outcomes or successful states.\n- `'warning'`: Important warnings about potential issues.\n- `'critical'`: Urgent problems or destructive actions.\n- `'custom'`: Inherits a custom color from its parent element's CSS.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Icon.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'' | ReducedIconTypes", + "description": "The type of icon that will be displayed. You can specify an icon name from the available icon set, or use an empty string to show no icon.", + "isOptional": true + } + ], + "value": "export interface IconProps extends IconElementProps {\n}" + } + }, + "ImageElementProps": { + "src/surfaces/checkout/components/Image.ts": { + "filePath": "src/surfaces/checkout/components/Image.ts", + "name": "ImageElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "'img' | 'none' | 'presentation'", + "description": "Sets the semantic meaning of the image content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `'img'`: Identifies the element as an image that conveys meaningful information to users.\n- `'none'`: Completely hides the element and its content from assistive technologies.\n- `'presentation'`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.", + "isOptional": true, + "defaultValue": "'img'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "aspectRatio", + "value": "`${number}${optionalSpace}/${optionalSpace}${number}` | `${number}`", + "description": "The aspect ratio of the image.\n\nThe rendering of the image will depend on the `inlineSize` value:\n\n- `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space.\n- `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored.\n\nLearn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).", + "isOptional": true, + "defaultValue": "'1/1'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border around the image. Accepts a size keyword alone (for example, `'base'`), a size and color (for example, `'base base'`), or a size, color, and style (for example, `'base base solid'`). Use `'none'` to remove the border.", + "isOptional": true, + "defaultValue": "'none' - equivalent to `none base auto`.", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The radius of the border corners around the image. You can use a single value to apply the same radius to all corners, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual corners.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The width of the border around the image. You can use a single value to apply the same width to all sides, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual sides. When set, this overrides the width value specified in the `border` shorthand.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'fill' | 'auto'", + "description": "The inline width (horizontal size) of the image.\n\n- `'fill'`: The image takes up 100% of the available inline space.\n- `'auto'`: The image is displayed at its natural size.\n\nLearn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).", + "isOptional": true, + "defaultValue": "'fill'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "'eager' | 'lazy'", + "description": "Determines the loading behavior of the image:\n- `'eager'`: Immediately loads the image, irrespective of its position within the visible viewport.\n- `'lazy'`: Delays loading the image until it approaches a specified distance from the viewport.\n\nLearn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).", + "isOptional": true, + "defaultValue": "'eager'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "objectFit", + "value": "'contain' | 'cover'", + "description": "How the image should be resized to fit its container. The image is positioned in the center of the container. Learn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\n\n- `'contain'`: Fits the entire image within the container, preserving aspect ratio. May leave empty space.\n- `'cover'`: Fills the container while preserving aspect ratio, cropping the image if needed.", + "isOptional": true, + "defaultValue": "'contain'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered. Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property.", + "isOptional": true + } + ], + "value": "export interface ImageElementProps extends Pick {\n /**\n * A shorthand for setting the border around the image. Accepts a size keyword alone (for example, `'base'`), a size and color (for example, `'base base'`), or a size, color, and style (for example, `'base base solid'`). Use `'none'` to remove the border.\n */\n border?: BorderShorthand;\n /**\n * The width of the border around the image. You can use a single value to apply the same width to all sides, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual sides. When set, this overrides the width value specified in the `border` shorthand.\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The radius of the border corners around the image. You can use a single value to apply the same radius to all corners, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual corners.\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n}" + } + }, + "ImageProps": { + "src/surfaces/checkout/components/Image.ts": { + "filePath": "src/surfaces/checkout/components/Image.ts", + "name": "ImageProps", + "description": "The properties for the image component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "'img' | 'none' | 'presentation'", + "description": "Sets the semantic meaning of the image content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `'img'`: Identifies the element as an image that conveys meaningful information to users.\n- `'none'`: Completely hides the element and its content from assistive technologies.\n- `'presentation'`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.", + "isOptional": true, + "defaultValue": "'img'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "aspectRatio", + "value": "`${number}${optionalSpace}/${optionalSpace}${number}` | `${number}`", + "description": "The aspect ratio of the image.\n\nThe rendering of the image will depend on the `inlineSize` value:\n\n- `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space.\n- `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored.\n\nLearn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).", + "isOptional": true, + "defaultValue": "'1/1'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border around the image. Accepts a size keyword alone (for example, `'base'`), a size and color (for example, `'base base'`), or a size, color, and style (for example, `'base base solid'`). Use `'none'` to remove the border.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The radius of the border corners around the image. You can use a single value to apply the same radius to all corners, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual corners.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The width of the border around the image. You can use a single value to apply the same width to all sides, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual sides. When set, this overrides the width value specified in the `border` shorthand.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'fill' | 'auto'", + "description": "The inline width (horizontal size) of the image.\n\n- `'fill'`: The image takes up 100% of the available inline space.\n- `'auto'`: The image is displayed at its natural size.\n\nLearn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).", + "isOptional": true, + "defaultValue": "'fill'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "'eager' | 'lazy'", + "description": "Determines the loading behavior of the image:\n- `'eager'`: Immediately loads the image, irrespective of its position within the visible viewport.\n- `'lazy'`: Delays loading the image until it approaches a specified distance from the viewport.\n\nLearn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).", + "isOptional": true, + "defaultValue": "'eager'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "objectFit", + "value": "'contain' | 'cover'", + "description": "How the image should be resized to fit its container. The image is positioned in the center of the container. Learn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\n\n- `'contain'`: Fits the entire image within the container, preserving aspect ratio. May leave empty space.\n- `'cover'`: Fills the container while preserving aspect ratio, cropping the image if needed.", + "isOptional": true, + "defaultValue": "'contain'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered. Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property.", + "isOptional": true + } + ], + "value": "export interface ImageProps extends ImageElementProps {\n}" + } + }, + "ImageElement": { + "src/surfaces/checkout/components/Image.ts": { + "filePath": "src/surfaces/checkout/components/Image.ts", + "name": "ImageElement", + "description": "The HTML element interface for the `s-image` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "'img' | 'none' | 'presentation'", + "description": "Sets the semantic meaning of the image content. When set, the role will be used by assistive technologies to help users navigate the page.\n\n- `'img'`: Identifies the element as an image that conveys meaningful information to users.\n- `'none'`: Completely hides the element and its content from assistive technologies.\n- `'presentation'`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.", + "isOptional": true, + "defaultValue": "'img'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "aspectRatio", + "value": "`${number}${optionalSpace}/${optionalSpace}${number}` | `${number}`", + "description": "The aspect ratio of the image.\n\nThe rendering of the image will depend on the `inlineSize` value:\n\n- `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space.\n- `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored.\n\nLearn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).", + "isOptional": true, + "defaultValue": "'1/1'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border around the image. Accepts a size keyword alone (for example, `'base'`), a size and color (for example, `'base base'`), or a size, color, and style (for example, `'base base solid'`). Use `'none'` to remove the border.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The radius of the border corners around the image. You can use a single value to apply the same radius to all corners, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual corners.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The width of the border around the image. You can use a single value to apply the same width to all sides, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual sides. When set, this overrides the width value specified in the `border` shorthand.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'fill' | 'auto'", + "description": "The inline width (horizontal size) of the image.\n\n- `'fill'`: The image takes up 100% of the available inline space.\n- `'auto'`: The image is displayed at its natural size.\n\nLearn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).", + "isOptional": true, + "defaultValue": "'fill'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "'eager' | 'lazy'", + "description": "Determines the loading behavior of the image:\n- `'eager'`: Immediately loads the image, irrespective of its position within the visible viewport.\n- `'lazy'`: Delays loading the image until it approaches a specified distance from the viewport.\n\nLearn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).", + "isOptional": true, + "defaultValue": "'eager'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "objectFit", + "value": "'contain' | 'cover'", + "description": "How the image should be resized to fit its container. The image is positioned in the center of the container. Learn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).\n\n- `'contain'`: Fits the entire image within the container, preserving aspect ratio. May leave empty space.\n- `'cover'`: Fills the container while preserving aspect ratio, cropping the image if needed.", + "isOptional": true, + "defaultValue": "'contain'" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered. Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Image.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ImageElement extends ImageElementProps, Omit {\n}" + } + }, + "LinkElementProps": { + "src/surfaces/checkout/components/Link.ts": { + "filePath": "src/surfaces/checkout/components/Link.ts", + "name": "LinkElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the link for users of assistive technologies such as screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the link's text content. Use this when the link text is in a different language than the rest of the page.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n\n- `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.\n- `'_blank'`: Opens the URL in a new tab or window.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral'", + "description": "The semantic meaning and color treatment of the link.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: Removes the default link color, inheriting the surrounding text style.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface LinkElementProps extends Pick {\n target?: Extract;\n tone?: Extract;\n}" + } + }, + "LinkEvents": { + "src/surfaces/checkout/components/Link.ts": { + "filePath": "src/surfaces/checkout/components/Link.ts", + "name": "LinkEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + } + ], + "value": "export interface LinkEvents extends Pick {\n}" + } + }, + "LinkElementEvents": { + "src/surfaces/checkout/components/Link.ts": { + "filePath": "src/surfaces/checkout/components/Link.ts", + "name": "LinkElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener", + "description": "A callback fired when the link is clicked, before navigating to the location specified by `href`.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + } + ], + "value": "export interface LinkElementEvents {\n /**\n * A callback fired when the link is clicked, before navigating to the location specified by `href`.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n}" + } + }, + "LinkElement": { + "src/surfaces/checkout/components/Link.ts": { + "filePath": "src/surfaces/checkout/components/Link.ts", + "name": "LinkElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the link for users of assistive technologies such as screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the link's text content. Use this when the link text is in a different language than the rest of the page.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n\n- `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.\n- `'_blank'`: Opens the URL in a new tab or window.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral'", + "description": "The semantic meaning and color treatment of the link.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: Removes the default link color, inheriting the surrounding text style.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface LinkElement extends LinkElementProps, Omit {\n onclick: LinkEvents['onClick'];\n}" + } + }, + "LinkProps": { + "src/surfaces/checkout/components/Link.ts": { + "filePath": "src/surfaces/checkout/components/Link.ts", + "name": "LinkProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the link for users of assistive technologies such as screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle' | '--copy'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "href", + "value": "string", + "description": "The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "interestFor", + "value": "string", + "description": "The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the link's text content. Use this when the link text is in a different language than the rest of the page.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "'auto' | '_blank'", + "description": "Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).\n\n- `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.\n- `'_blank'`: Opens the URL in a new tab or window.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Link.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'neutral'", + "description": "The semantic meaning and color treatment of the link.\n\n- `'auto'`: Automatically determined based on context.\n- `'neutral'`: Removes the default link color, inheriting the surrounding text style.", + "isOptional": true, + "defaultValue": "'auto'" + } + ], + "value": "export interface LinkProps extends LinkElementProps, LinkEvents {\n}" + } + }, + "ListItemElementProps": { + "src/surfaces/checkout/components/ListItem.ts": { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "name": "ListItemElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface ListItemElementProps extends Pick {\n}" + } + }, + "ListItemElement": { + "src/surfaces/checkout/components/ListItem.ts": { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "name": "ListItemElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ListItemElement extends ListItemElementProps, Omit {\n}" + } + }, + "ListItemProps": { + "src/surfaces/checkout/components/ListItem.ts": { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "name": "ListItemProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ListItem.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface ListItemProps extends ListItemElementProps {\n}" + } + }, + "MapElementProps": { + "src/surfaces/checkout/components/Map.ts": { + "filePath": "src/surfaces/checkout/components/Map.ts", + "name": "MapElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or contents of the map for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the map displays.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "apiKey", + "value": "string", + "description": "A valid API key for the map service provider. This key is required to load and render the map tiles. Obtain a key from a supported provider such as [Google Maps Platform](https://developers.google.com/maps/documentation/javascript/get-api-key).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "latitude", + "value": "number", + "description": "The latitude of the map's center point, in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "longitude", + "value": "number", + "description": "The longitude of the map's center point, in degrees. Valid values range from -180 (west) to 180 (east).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "maxZoom", + "value": "number", + "description": "The maximum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming in beyond a useful level of detail.", + "isOptional": true, + "defaultValue": "18" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "minZoom", + "value": "number", + "description": "The minimum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming out beyond a useful level of context.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "zoom", + "value": "number", + "description": "The initial zoom level of the map. Valid values are numbers from 0 (fully zoomed out, world view) to 18 (fully zoomed in, street level).", + "isOptional": true, + "defaultValue": "4" + } + ], + "value": "export interface MapElementProps extends Pick {\n}" + } + }, + "MapEvents": { + "src/surfaces/checkout/components/Map.ts": { + "filePath": "src/surfaces/checkout/components/Map.ts", + "name": "MapEvents", + "description": "The event handlers for the map component.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onBoundsChange", + "value": "(event: MapBoundsChangeEvent) => void", + "description": "A callback fired when the visible map boundaries change, such as after a pan or zoom completes.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: MapClickEvent) => void", + "description": "A callback fired when the user clicks on the map. Provides the geographic location of the click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onDblClick", + "value": "(event: MapDblClickEvent) => void", + "description": "A callback fired when the user double-clicks on the map. Provides the geographic location of the double-click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onViewChange", + "value": "(event: MapViewChangeEvent) => void", + "description": "A callback fired when the map view changes, such as when the user pans or zooms. Provides the new center location and zoom level.", + "isOptional": true + } + ], + "value": "export interface MapEvents extends Pick {\n}" + } + }, + "MapBoundsChangeEvent": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "name": "MapBoundsChangeEvent", + "description": "The event data for map bounds changes.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "bounds", + "value": "Bounds", + "description": "The geographic boundaries of the visible map area after the change.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + } + ], + "value": "export interface MapBoundsChangeEvent extends Event {\n\t/**\n\t * The geographic boundaries of the visible map area after the change.\n\t */\n\tbounds?: Bounds;\n}" + } + }, + "Bounds": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "name": "Bounds", + "description": "The geographic boundaries of a visible map area.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "northEast", + "value": "Location$1", + "description": "The north-east corner of the bounded area.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "southWest", + "value": "Location$1", + "description": "The south-west corner of the bounded area.", + "isOptional": true + } + ], + "value": "export interface Bounds {\n\t/**\n\t * The north-east corner of the bounded area.\n\t */\n\tnorthEast?: Location$1;\n\t/**\n\t * The south-west corner of the bounded area.\n\t */\n\tsouthWest?: Location$1;\n}" + } + }, + "MapClickEvent": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "name": "MapClickEvent", + "description": "The event data for map click events.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "location", + "value": "Location$1", + "description": "The geographic location of the click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + } + ], + "value": "export interface MapClickEvent extends Event {\n\t/**\n\t * The geographic location of the click.\n\t */\n\tlocation?: Location$1;\n}" + } + }, + "MapDblClickEvent": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "name": "MapDblClickEvent", + "description": "The event data for map double-click events.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "AT_TARGET", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "bubbles", + "value": "boolean", + "description": "The **`bubbles`** read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "BUBBLING_PHASE", + "value": "3", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelable", + "value": "boolean", + "description": "The **`cancelable`** read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "cancelBubble", + "value": "boolean", + "description": "The **`cancelBubble`** property of the Event interface is deprecated.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "CAPTURING_PHASE", + "value": "1", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "composed", + "value": "boolean", + "description": "The read-only **`composed`** property of the or not the event will propagate across the shadow DOM boundary into the standard DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "composedPath", + "value": "() => EventTarget[]", + "description": "The **`composedPath()`** method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "currentTarget", + "value": "EventTarget | null", + "description": "The **`currentTarget`** read-only property of the Event interface identifies the element to which the event handler has been attached.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPrevented", + "value": "boolean", + "description": "The **`defaultPrevented`** read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "eventPhase", + "value": "number", + "description": "The **`eventPhase`** read-only property of the being evaluated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "initEvent", + "value": "(type: string, bubbles?: boolean, cancelable?: boolean) => void", + "description": "The **`Event.initEvent()`** method is used to initialize the value of an event created using Document.createEvent().", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "isTrusted", + "value": "boolean", + "description": "The **`isTrusted`** read-only property of the when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and `false` when the event was dispatched via The only exception is the `click` event, which initializes the `isTrusted` property to `false` in user agents.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "location", + "value": "Location$1", + "description": "The geographic location of the double-click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "NONE", + "value": "0", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "preventDefault", + "value": "() => void", + "description": "The **`preventDefault()`** method of the Event interface tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "returnValue", + "value": "boolean", + "description": "The Event property **`returnValue`** indicates whether the default action for this event has been prevented or not.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "srcElement", + "value": "EventTarget | null", + "description": "The deprecated **`Event.srcElement`** is an alias for the Event.target property.", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopImmediatePropagation", + "value": "() => void", + "description": "The **`stopImmediatePropagation()`** method of the If several listeners are attached to the same element for the same event type, they are called in the order in which they were added.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "MethodSignature", + "name": "stopPropagation", + "value": "() => void", + "description": "The **`stopPropagation()`** method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "target", + "value": "EventTarget | null", + "description": "The read-only **`target`** property of the dispatched.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "timeStamp", + "value": "DOMHighResTimeStamp", + "description": "The **`timeStamp`** read-only property of the Event interface returns the time (in milliseconds) at which the event was created.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)" + }, + { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "string", + "description": "The **`type`** read-only property of the Event interface returns a string containing the event's type.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)" + } + ], + "value": "export interface MapDblClickEvent extends Event {\n\t/**\n\t * The geographic location of the double-click.\n\t */\n\tlocation?: Location$1;\n}" + } + }, + "MapViewChangeEvent": { + "src/surfaces/checkout/components/Map.ts": { + "filePath": "src/surfaces/checkout/components/Map.ts", + "name": "MapViewChangeEvent", + "description": "The event data provided when the map view changes, such as after the user pans or zooms. Contains the new center location and zoom level.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "location", + "value": "MapLocation", + "description": "The geographic location on the map where the interaction occurred, as a latitude/longitude coordinate pair.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "zoom", + "value": "number", + "description": "The current zoom level of the map after the view change, as a number from 0 (world view) to 18 (street level).", + "isOptional": true + } + ], + "value": "export interface MapViewChangeEvent extends MapLocationEvent {\n /**\n * The current zoom level of the map after the view change, as a number from 0 (world view) to 18 (street level).\n */\n zoom?: number;\n}" + } + }, + "MapLocation": { + "src/surfaces/checkout/components/Map.ts": { + "filePath": "src/surfaces/checkout/components/Map.ts", + "name": "MapLocation", + "description": "A geographic coordinate pair representing a location on the map, defined by latitude and longitude values.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "latitude", + "value": "number", + "description": "The latitude of the location in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "longitude", + "value": "number", + "description": "The longitude of the location in degrees. Valid values range from -180 (west) to 180 (east).", + "isOptional": true + } + ], + "value": "export interface MapLocation {\n /**\n * The latitude of the location in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).\n */\n latitude?: number;\n /**\n * The longitude of the location in degrees. Valid values range from -180 (west) to 180 (east).\n */\n longitude?: number;\n}" + } + }, + "MapElementEvents": { + "src/surfaces/checkout/components/Map.ts": { + "filePath": "src/surfaces/checkout/components/Map.ts", + "name": "MapElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "boundschange", + "value": "CallbackEventListener", + "description": "A callback fired when the visible map boundaries change, such as after a pan or zoom completes.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener", + "description": "A callback fired when the user clicks on the map. Provides the geographic location of the click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "dblclick", + "value": "CallbackEventListener", + "description": "A callback fired when the user double-clicks on the map. Provides the geographic location of the double-click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "viewchange", + "value": "CallbackEventListener", + "description": "A callback fired when the map view changes, such as when the user pans or zooms. Provides the new center location and zoom level.", + "isOptional": true + } + ], + "value": "export interface MapElementEvents {\n /**\n * A callback fired when the visible map boundaries change, such as after a pan or zoom completes.\n */\n boundschange?: CallbackEventListener;\n /**\n * A callback fired when the user clicks on the map. Provides the geographic location of the click.\n */\n click?: CallbackEventListener;\n /**\n * A callback fired when the user double-clicks on the map. Provides the geographic location of the double-click.\n */\n dblclick?: CallbackEventListener;\n /**\n * A callback fired when the map view changes, such as when the user pans or zooms. Provides the new center location and zoom level.\n */\n viewchange?: CallbackEventListener;\n}" + } + }, + "MapBoundsEvent": { + "src/surfaces/checkout/components/Map.ts": { + "filePath": "src/surfaces/checkout/components/Map.ts", + "name": "MapBoundsEvent", + "description": "The event data provided when the visible map boundaries change, such as after a pan or zoom completes. Contains the new geographic bounds of the visible area.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "bounds", + "value": "{ northEast?: MapLocation; southWest?: MapLocation; }", + "description": "The geographic boundaries of the currently visible map area, defined by its north-east and south-west corners.", + "isOptional": true + } + ], + "value": "export interface MapBoundsEvent {\n /**\n * The geographic boundaries of the currently visible map area, defined by its north-east and south-west corners.\n */\n bounds?: {\n /**\n * The north-east corner of the visible map area, representing the top-right of the visible region.\n */\n northEast?: MapLocation;\n /**\n * The south-west corner of the visible map area, representing the bottom-left of the visible region.\n */\n southWest?: MapLocation;\n };\n}" + } + }, + "MapLocationEvent": { + "src/surfaces/checkout/components/Map.ts": { + "filePath": "src/surfaces/checkout/components/Map.ts", + "name": "MapLocationEvent", + "description": "The event data provided when a map interaction occurs at a specific geographic location, such as a click or double-click.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "location", + "value": "MapLocation", + "description": "The geographic location on the map where the interaction occurred, as a latitude/longitude coordinate pair.", + "isOptional": true + } + ], + "value": "export interface MapLocationEvent {\n /**\n * The geographic location on the map where the interaction occurred, as a latitude/longitude coordinate pair.\n */\n location?: MapLocation;\n}" + } + }, + "MapElement": { + "src/surfaces/checkout/components/Map.ts": { + "filePath": "src/surfaces/checkout/components/Map.ts", + "name": "MapElement", + "description": "The HTML element interface for the `s-map` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or contents of the map for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the map displays.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "apiKey", + "value": "string", + "description": "A valid API key for the map service provider. This key is required to load and render the map tiles. Obtain a key from a supported provider such as [Google Maps Platform](https://developers.google.com/maps/documentation/javascript/get-api-key).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "latitude", + "value": "number", + "description": "The latitude of the map's center point, in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "longitude", + "value": "number", + "description": "The longitude of the map's center point, in degrees. Valid values range from -180 (west) to 180 (east).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "maxZoom", + "value": "number", + "description": "The maximum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming in beyond a useful level of detail.", + "isOptional": true, + "defaultValue": "18" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "minZoom", + "value": "number", + "description": "The minimum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming out beyond a useful level of context.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onboundschange", + "value": "(event: MapBoundsChangeEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "(event: MapClickEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "(event: MapDblClickEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onviewchange", + "value": "(event: MapViewChangeEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "zoom", + "value": "number", + "description": "The initial zoom level of the map. Valid values are numbers from 0 (fully zoomed out, world view) to 18 (fully zoomed in, street level).", + "isOptional": true, + "defaultValue": "4" + } + ], + "value": "export interface MapElement extends MapElementProps, Omit {\n onboundschange: MapEvents['onBoundsChange'];\n onclick: MapEvents['onClick'];\n ondblclick: MapEvents['onDblClick'];\n onviewchange: MapEvents['onViewChange'];\n}" + } + }, + "MapProps": { + "src/surfaces/checkout/components/Map.ts": { + "filePath": "src/surfaces/checkout/components/Map.ts", + "name": "MapProps", + "description": "The properties for the map component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or contents of the map for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the map displays.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "apiKey", + "value": "string", + "description": "A valid API key for the map service provider. This key is required to load and render the map tiles. Obtain a key from a supported provider such as [Google Maps Platform](https://developers.google.com/maps/documentation/javascript/get-api-key).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "latitude", + "value": "number", + "description": "The latitude of the map's center point, in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "longitude", + "value": "number", + "description": "The longitude of the map's center point, in degrees. Valid values range from -180 (west) to 180 (east).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "maxZoom", + "value": "number", + "description": "The maximum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming in beyond a useful level of detail.", + "isOptional": true, + "defaultValue": "18" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "minZoom", + "value": "number", + "description": "The minimum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming out beyond a useful level of context.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onBoundsChange", + "value": "(event: MapBoundsChangeEvent) => void", + "description": "A callback fired when the visible map boundaries change, such as after a pan or zoom completes.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: MapClickEvent) => void", + "description": "A callback fired when the user clicks on the map. Provides the geographic location of the click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onDblClick", + "value": "(event: MapDblClickEvent) => void", + "description": "A callback fired when the user double-clicks on the map. Provides the geographic location of the double-click.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "onViewChange", + "value": "(event: MapViewChangeEvent) => void", + "description": "A callback fired when the map view changes, such as when the user pans or zooms. Provides the new center location and zoom level.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Map.ts", + "syntaxKind": "PropertySignature", + "name": "zoom", + "value": "number", + "description": "The initial zoom level of the map. Valid values are numbers from 0 (fully zoomed out, world view) to 18 (fully zoomed in, street level).", + "isOptional": true, + "defaultValue": "4" + } + ], + "value": "export interface MapProps extends MapElementProps, MapEvents {\n}" + } + }, + "MapMarkerElementProps": { + "src/surfaces/checkout/components/MapMarker.ts": { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "name": "MapMarkerElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or location of the marker for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the marker represents.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "clusterable", + "value": "boolean", + "description": "Whether the marker can be grouped into clusters when the map is zoomed out. Clustering helps reduce visual clutter when many markers are close together at low zoom levels.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "latitude", + "value": "number", + "description": "The latitude of the marker’s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "longitude", + "value": "number", + "description": "The longitude of the marker’s position in degrees. Valid values range from -180 (west) to 180 (east).", + "isOptional": true, + "defaultValue": "0" + } + ], + "value": "export interface MapMarkerElementProps extends Pick {\n /**\n * Sets the action the `commandFor` target should take when this component is activated. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n *\n * - `--auto`: a default action for the target component.\n * - `--show`: shows the target component.\n * - `--hide`: hides the target component.\n * - `--toggle`: toggles the target component.\n *\n * @default '--auto'\n */\n command?: Extract;\n /**\n * The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n */\n commandFor?: MapMarkerProps$1['commandFor'];\n}" + } + }, + "MapMarkerEvents": { + "src/surfaces/checkout/components/MapMarker.ts": { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "name": "MapMarkerEvents", + "description": "The event handlers for the map marker component.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.", + "isOptional": true + } + ], + "value": "export interface MapMarkerEvents extends Pick {\n}" + } + }, + "MapMarkerElementEvents": { + "src/surfaces/checkout/components/MapMarker.ts": { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "name": "MapMarkerElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener", + "description": "A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.", + "isOptional": true + } + ], + "value": "export interface MapMarkerElementEvents {\n /**\n * A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.\n */\n click?: CallbackEventListener;\n}" + } + }, + "MapMarkerElementSlots": { + "src/surfaces/checkout/components/MapMarker.ts": { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "name": "MapMarkerElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "graphic", + "value": "HTMLElement", + "description": "A custom graphic element to use as the marker. If not provided, the map provider’s default marker pin is displayed.", + "isOptional": true + } + ], + "value": "export interface MapMarkerElementSlots {\n /**\n * A custom graphic element to use as the marker. If not provided, the map provider’s default marker pin is displayed.\n */\n graphic?: HTMLElement;\n}" + } + }, + "MapMarkerElement": { + "src/surfaces/checkout/components/MapMarker.ts": { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "name": "MapMarkerElement", + "description": "The HTML element interface for the `s-map-marker` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or location of the marker for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the marker represents.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "clusterable", + "value": "boolean", + "description": "Whether the marker can be grouped into clusters when the map is zoomed out. Clustering helps reduce visual clutter when many markers are close together at low zoom levels.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "latitude", + "value": "number", + "description": "The latitude of the marker’s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "longitude", + "value": "number", + "description": "The longitude of the marker’s position in degrees. Valid values range from -180 (west) to 180 (east).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface MapMarkerElement extends MapMarkerElementProps, Omit {\n onclick: MapMarkerEvents['onClick'];\n}" + } + }, + "MapMarkerProps": { + "src/surfaces/checkout/components/MapMarker.ts": { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "name": "MapMarkerProps", + "description": "The properties for the map marker component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or location of the marker for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the marker represents.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "clusterable", + "value": "boolean", + "description": "Whether the marker can be grouped into clusters when the map is zoomed out. Clustering helps reduce visual clutter when many markers are close together at low zoom levels.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).\n\n- `--auto`: a default action for the target component.\n- `--show`: shows the target component.\n- `--hide`: hides the target component.\n- `--toggle`: toggles the target component.", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "latitude", + "value": "number", + "description": "The latitude of the marker’s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "longitude", + "value": "number", + "description": "The longitude of the marker’s position in degrees. Valid values range from -180 (west) to 180 (east).", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/MapMarker.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.", + "isOptional": true + } + ], + "value": "export interface MapMarkerProps extends MapMarkerElementProps, MapMarkerEvents {\n}" + } + }, + "ModalElementProps": { + "src/surfaces/checkout/components/Modal.ts": { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "name": "ModalElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose of the modal, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "Adjust the padding around the modal content.\n\n- `base`: Applies padding that is appropriate for the element.\n- `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.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100' | 'max'", + "description": "The size of the modal.\n\n- `'base'`: The default size, suitable for most use cases.\n- `'small'`: A compact modal for simple confirmations or short messages.\n- `'small-100'`: The smallest modal size.\n- `'large'`: A large modal for complex content or forms.\n- `'large-100'`: The largest fixed-size modal, providing maximum room for content.\n- `'max'`: Expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.", + "isOptional": true, + "defaultValue": "'base'" + } + ], + "value": "export interface ModalElementProps extends Pick {\n /**\n * The size of the modal.\n *\n * - `'base'`: The default size, suitable for most use cases.\n * - `'small'`: A compact modal for simple confirmations or short messages.\n * - `'small-100'`: The smallest modal size.\n * - `'large'`: A large modal for complex content or forms.\n * - `'large-100'`: The largest fixed-size modal, providing maximum room for content.\n * - `'max'`: Expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.\n *\n * @default 'base'\n */\n size?: Extract;\n}" + } + }, + "ModalElementSlots": { + "src/surfaces/checkout/components/Modal.ts": { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "name": "ModalElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action button displayed in the modal footer, representing the primary action users should take. Only accepts a single button component.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Additional action buttons displayed in the modal footer, providing alternative or supporting actions.", + "isOptional": true + } + ], + "value": "export interface ModalElementSlots {\n /**\n * The main action button displayed in the modal footer, representing the primary action users should take. Only accepts a single button component.\n */\n 'primary-action'?: HTMLElement;\n /**\n * Additional action buttons displayed in the modal footer, providing alternative or supporting actions.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "ModalElementMethods": { + "src/surfaces/checkout/components/Modal.ts": { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "name": "ModalElementMethods", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay and run any associated hide animations." + } + ], + "value": "export interface ModalElementMethods extends Pick {\n}" + } + }, + "ModalElementEvents": { + "src/surfaces/checkout/components/Modal.ts": { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "name": "ModalElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener", + "description": "A callback fired when the modal is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "aftershow", + "value": "CallbackEventListener", + "description": "A callback fired when the modal is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "CallbackEventListener", + "description": "A callback fired immediately after the modal is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "CallbackEventListener", + "description": "A callback fired immediately after the modal is shown.", + "isOptional": true + } + ], + "value": "export interface ModalElementEvents {\n /**\n * A callback fired when the modal is hidden, after any hide animations have completed.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback fired when the modal is shown, after any show animations have completed.\n */\n aftershow?: CallbackEventListener;\n /**\n * A callback fired immediately after the modal is hidden.\n */\n hide?: CallbackEventListener;\n /**\n * A callback fired immediately after the modal is shown.\n */\n show?: CallbackEventListener;\n}" + } + }, + "ModalElement": { + "src/surfaces/checkout/components/Modal.ts": { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "name": "ModalElement", + "description": "The HTML element interface for the `s-modal` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose of the modal, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay and run any associated hide animations." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onafterhide", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onaftershow", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onhide", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onshow", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "Adjust the padding around the modal content.\n\n- `base`: Applies padding that is appropriate for the element.\n- `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.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100' | 'max'", + "description": "The size of the modal.\n\n- `'base'`: The default size, suitable for most use cases.\n- `'small'`: A compact modal for simple confirmations or short messages.\n- `'small-100'`: The smallest modal size.\n- `'large'`: A large modal for complex content or forms.\n- `'large-100'`: The largest fixed-size modal, providing maximum room for content.\n- `'max'`: Expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ModalElement extends ModalElementProps, ModalElementMethods, Omit {\n onafterhide: ModalEvents['onAfterHide'];\n onaftershow: ModalEvents['onAfterShow'];\n onhide: ModalEvents['onHide'];\n onshow: ModalEvents['onShow'];\n}" + } + }, + "ModalProps": { + "src/surfaces/checkout/components/Modal.ts": { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "name": "ModalProps", + "description": "The properties for the modal component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose of the modal, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the modal.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterShow", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "Adjust the padding around the modal content.\n\n- `base`: Applies padding that is appropriate for the element.\n- `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.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Modal.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100' | 'max'", + "description": "The size of the modal.\n\n- `'base'`: The default size, suitable for most use cases.\n- `'small'`: A compact modal for simple confirmations or short messages.\n- `'small-100'`: The smallest modal size.\n- `'large'`: A large modal for complex content or forms.\n- `'large-100'`: The largest fixed-size modal, providing maximum room for content.\n- `'max'`: Expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.", + "isOptional": true, + "defaultValue": "'base'" + } + ], + "value": "export interface ModalProps extends ModalElementProps, ModalEvents {\n}" + } + }, + "MoneyFieldElementProps": { + "src/surfaces/checkout/components/MoneyField.ts": { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "name": "MoneyFieldElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface MoneyFieldElementProps extends Pick {\n}" + } + }, + "MoneyFieldEvents": { + "src/surfaces/checkout/components/MoneyField.ts": { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "name": "MoneyFieldEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + } + ], + "value": "export interface MoneyFieldEvents extends Pick {\n}" + } + }, + "MoneyFieldElementEvents": { + "src/surfaces/checkout/components/MoneyField.ts": { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "name": "MoneyFieldElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the money field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the money field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the money field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the money field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface MoneyFieldElementEvents {\n /**\n * A callback fired when the money field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the money field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the money field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the money field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + } + }, + "MoneyFieldElement": { + "src/surfaces/checkout/components/MoneyField.ts": { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "name": "MoneyFieldElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface MoneyFieldElement extends MoneyFieldElementProps {\n onblur: MoneyFieldEvents['onBlur'];\n onchange: MoneyFieldEvents['onChange'];\n onfocus: MoneyFieldEvents['onFocus'];\n oninput: MoneyFieldEvents['onInput'];\n}" + } + }, + "MoneyFieldProps": { + "src/surfaces/checkout/components/MoneyField.ts": { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "name": "MoneyFieldProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/checkout/components/MoneyField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface MoneyFieldProps extends MoneyFieldElementProps, MoneyFieldEvents {\n}" + } + }, + "NumberFieldElementProps": { + "src/surfaces/checkout/components/NumberField.ts": { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "name": "NumberFieldElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "controls", + "value": "'auto' | 'stepper' | 'none'", + "description": "Sets the type of controls displayed in the field.\n\n- `'auto'`: The presence of the controls depends on the surface and context.\n- `'stepper'`: Displays buttons to increase or decrease the value by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value are enabled.\n- `'none'`: No controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconProps['type']", + "description": "The type of icon to be displayed in the field.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "'decimal' | 'numeric'", + "description": "Sets the virtual keyboard layout for the field.\n\n- `'decimal'`: A numeric keyboard with a decimal point, suitable for decimal numbers.\n- `'numeric'`: A numeric keyboard without a decimal point, suitable for integers.\n\nLearn more about the [inputMode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).", + "isOptional": true, + "defaultValue": "'decimal'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "string", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface NumberFieldElementProps extends Pick {\n icon?: IconProps['type'];\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + } + }, + "NumberFieldEvents": { + "src/surfaces/checkout/components/NumberField.ts": { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "name": "NumberFieldEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + } + ], + "value": "export interface NumberFieldEvents extends Pick {\n}" + } + }, + "NumberFieldElementEvents": { + "src/surfaces/checkout/components/NumberField.ts": { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "name": "NumberFieldElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the number field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the number field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the number field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the number field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface NumberFieldElementEvents {\n /**\n * A callback fired when the number field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the number field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the number field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the number field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + } + }, + "NumberFieldElementSlots": { + "src/surfaces/checkout/components/NumberField.ts": { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "name": "NumberFieldElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface NumberFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "NumberFieldElement": { + "src/surfaces/checkout/components/NumberField.ts": { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "name": "NumberFieldElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "controls", + "value": "'auto' | 'stepper' | 'none'", + "description": "Sets the type of controls displayed in the field.\n\n- `'auto'`: The presence of the controls depends on the surface and context.\n- `'stepper'`: Displays buttons to increase or decrease the value by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value are enabled.\n- `'none'`: No controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconProps['type']", + "description": "The type of icon to be displayed in the field.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "'decimal' | 'numeric'", + "description": "Sets the virtual keyboard layout for the field.\n\n- `'decimal'`: A numeric keyboard with a decimal point, suitable for decimal numbers.\n- `'numeric'`: A numeric keyboard without a decimal point, suitable for integers.\n\nLearn more about the [inputMode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).", + "isOptional": true, + "defaultValue": "'decimal'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "string", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface NumberFieldElement extends NumberFieldElementProps, Omit {\n onblur: NumberFieldEvents['onBlur'];\n onchange: NumberFieldEvents['onChange'];\n onfocus: NumberFieldEvents['onFocus'];\n oninput: NumberFieldEvents['onInput'];\n}" + } + }, + "NumberFieldProps": { + "src/surfaces/checkout/components/NumberField.ts": { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "name": "NumberFieldProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "controls", + "value": "'auto' | 'stepper' | 'none'", + "description": "Sets the type of controls displayed in the field.\n\n- `'auto'`: The presence of the controls depends on the surface and context.\n- `'stepper'`: Displays buttons to increase or decrease the value by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value are enabled.\n- `'none'`: No controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconProps['type']", + "description": "The type of icon to be displayed in the field.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "'decimal' | 'numeric'", + "description": "Sets the virtual keyboard layout for the field.\n\n- `'decimal'`: A numeric keyboard with a decimal point, suitable for decimal numbers.\n- `'numeric'`: A numeric keyboard without a decimal point, suitable for integers.\n\nLearn more about the [inputMode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).", + "isOptional": true, + "defaultValue": "'decimal'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "min", + "value": "number", + "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.\n\nNote: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.", + "isOptional": true, + "defaultValue": "-Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "step", + "value": "number", + "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.", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "string", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/NumberField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface NumberFieldProps extends NumberFieldElementProps, NumberFieldEvents {\n}" + } + }, + "OptionElementProps": { + "src/surfaces/checkout/components/Option.ts": { + "filePath": "src/surfaces/checkout/components/Option.ts", + "name": "OptionElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "defaultSelected", + "value": "boolean", + "description": "Whether the control is selected by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the control is currently selected.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface OptionElementProps extends Pick {\n}" + } + }, + "OptionElement": { + "src/surfaces/checkout/components/Option.ts": { + "filePath": "src/surfaces/checkout/components/Option.ts", + "name": "OptionElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "defaultSelected", + "value": "boolean", + "description": "Whether the control is selected by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the control is currently selected.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface OptionElement extends OptionElementProps, Omit {\n}" + } + }, + "OptionProps": { + "src/surfaces/checkout/components/Option.ts": { + "filePath": "src/surfaces/checkout/components/Option.ts", + "name": "OptionProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "defaultSelected", + "value": "boolean", + "description": "Whether the control is selected by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "selected", + "value": "boolean", + "description": "Whether the control is currently selected.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Option.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface OptionProps extends OptionElementProps {\n}" + } + }, + "OrderedListElementProps": { + "src/surfaces/checkout/components/OrderedList.ts": { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "name": "OrderedListElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface OrderedListElementProps extends OrderedListProps$1 {\n}" + } + }, + "OrderedListElement": { + "src/surfaces/checkout/components/OrderedList.ts": { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "name": "OrderedListElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface OrderedListElement extends OrderedListElementProps, Omit {\n}" + } + }, + "OrderedListProps": { + "src/surfaces/checkout/components/OrderedList.ts": { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "name": "OrderedListProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/OrderedList.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface OrderedListProps extends OrderedListElementProps {\n}" + } + }, + "ParagraphElementProps": { + "src/surfaces/checkout/components/Paragraph.ts": { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "name": "ParagraphElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "'base' | 'subdued'", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Higher-contrast color for text that needs more emphasis than `base`.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "'ltr' | 'rtl' | 'auto' | ''", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `caution`: Advisory notices that need attention.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `accent`: Highlighted or promotional content.\n- `custom`: Custom styling controlled by your theme.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "ParagraphType", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "isOptional": true, + "defaultValue": "'paragraph'" + } + ], + "value": "export interface ParagraphElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * Sets the alignment of the text.\n * @see https://developer.mozilla.org/en-US/docs/Web/CSS/text-align\n *\n * @default 'auto'\n */\n textAlign?: 'start' | 'end' | 'center' | 'auto';\n}" + } + }, + "ParagraphType": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "ParagraphType", + "value": "\"paragraph\" | \"small\"", + "description": "" + } + }, + "ParagraphElement": { + "src/surfaces/checkout/components/Paragraph.ts": { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "name": "ParagraphElement", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "'base' | 'subdued'", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Higher-contrast color for text that needs more emphasis than `base`.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "'ltr' | 'rtl' | 'auto' | ''", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `caution`: Advisory notices that need attention.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `accent`: Highlighted or promotional content.\n- `custom`: Custom styling controlled by your theme.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "ParagraphType", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "isOptional": true, + "defaultValue": "'paragraph'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ParagraphElement extends ParagraphElementProps, Omit {\n}" + } + }, + "ParagraphProps": { + "src/surfaces/checkout/components/Paragraph.ts": { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "name": "ParagraphProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "'base' | 'subdued'", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Higher-contrast color for text that needs more emphasis than `base`.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "'ltr' | 'rtl' | 'auto' | ''", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "textAlign", + "value": "'start' | 'end' | 'center' | 'auto'", + "description": "Sets the alignment of the text.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `caution`: Advisory notices that need attention.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `accent`: Highlighted or promotional content.\n- `custom`: Custom styling controlled by your theme.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Paragraph.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "ParagraphType", + "description": "The semantic type and styling treatment for the paragraph content.\n\nOther presentation properties on `s-paragraph` override the default styling.", + "isOptional": true, + "defaultValue": "'paragraph'" + } + ], + "value": "export interface ParagraphProps extends ParagraphElementProps {\n}" + } + }, + "PasswordFieldElementProps": { + "src/surfaces/checkout/components/PasswordField.ts": { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "name": "PasswordFieldElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface PasswordFieldElementProps extends Pick {\n}" + } + }, + "PasswordFieldEvents": { + "src/surfaces/checkout/components/PasswordField.ts": { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "name": "PasswordFieldEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + } + ], + "value": "export interface PasswordFieldEvents extends Pick {\n}" + } + }, + "PasswordFieldElementEvents": { + "src/surfaces/checkout/components/PasswordField.ts": { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "name": "PasswordFieldElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the password field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the password field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the password field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the password field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface PasswordFieldElementEvents {\n /**\n * A callback fired when the password field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the password field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the password field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the password field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + } + }, + "PasswordFieldElementSlots": { + "src/surfaces/checkout/components/PasswordField.ts": { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "name": "PasswordFieldElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface PasswordFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "PasswordFieldElement": { + "src/surfaces/checkout/components/PasswordField.ts": { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "name": "PasswordFieldElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface PasswordFieldElement extends PasswordFieldProps, Omit {\n onblur: PasswordFieldEvents['onBlur'];\n onchange: PasswordFieldEvents['onChange'];\n onfocus: PasswordFieldEvents['onFocus'];\n oninput: PasswordFieldEvents['onInput'];\n}" + } + }, + "PasswordFieldProps": { + "src/surfaces/checkout/components/PasswordField.ts": { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "name": "PasswordFieldProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PasswordField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface PasswordFieldProps extends PasswordFieldElementProps, PasswordFieldEvents {\n}" + } + }, + "PaymentIconElementProps": { + "src/surfaces/checkout/components/PaymentIcon.ts": { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "name": "PaymentIconElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the payment icon for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about which payment method the icon represents.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "PaymentIconName | AnyString", + "description": "The payment method to display. Specify a payment method name from the available set (for example, `'visa'`, `'mastercard'`, or `'paypal'`), or use an empty string to show no icon.", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface PaymentIconElementProps extends PaymentIconProps$1 {\n}" + } + }, + "PaymentIconName": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "PaymentIconName", + "value": "\"abn\" | \"acima-leasing\" | \"acuotaz\" | \"ada\" | \"addi\" | \"adyen\" | \"aeropay\" | \"affin-bank\" | \"affirm\" | \"aftee\" | \"afterpay-paynl-version\" | \"afterpay\" | \"airtel-money\" | \"airteltigo-mobile-money\" | \"aktia\" | \"akulaku-paylater\" | \"akulaku\" | \"alandsbanken\" | \"alfamart\" | \"alfamidi\" | \"alipay-hk\" | \"alipay-paynl-version\" | \"alipay\" | \"alliance-bank\" | \"alma\" | \"aman\" | \"amazon\" | \"ambank\" | \"american-express\" | \"amex\" | \"ansa-stored-value\" | \"ansa\" | \"anyday\" | \"apecoin\" | \"aplazo\" | \"apple-pay\" | \"aqsat\" | \"arbitrum\" | \"arhaus\" | \"arvato\" | \"ashley-plcc\" | \"ask\" | \"astrapay\" | \"atm-bersama\" | \"atobaraidotcom\" | \"atome\" | \"atone\" | \"atrato\" | \"au-kantan-kessai\" | \"au-pay\" | \"authorize-net\" | \"avalanche\" | \"axs\" | \"bancnet\" | \"banco-azteca\" | \"bancomat\" | \"bancontact\" | \"bangkok-bank\" | \"bank-islam\" | \"bank-muamalat\" | \"bank-rakyat\" | \"barclays\" | \"base\" | \"bbva-cie\" | \"bc-card\" | \"bca-klikpay\" | \"bca\" | \"bdo\" | \"belfius\" | \"benefit\" | \"best-buy-card\" | \"biercheque-paynl-version\" | \"bigc\" | \"billease\" | \"biller-paynl-version\" | \"billie\" | \"billink-method\" | \"billink\" | \"bitcoin-cash\" | \"bitcoin\" | \"bizum\" | \"blik\" | \"bnbchain\" | \"bni\" | \"bnp\" | \"bogus-app-coin\" | \"bogus\" | \"boleto\" | \"boodil\" | \"boost\" | \"bpi\" | \"braintree\" | \"bread-pay\" | \"bread\" | \"bri-direct-debit\" | \"bri\" | \"brimo\" | \"bsi\" | \"bsn\" | \"bss\" | \"busd\" | \"careem-pay\" | \"cartes-bancaires\" | \"cash-app-pay\" | \"cash\" | \"cashew\" | \"cashinvoice-latin-america\" | \"catch-payments\" | \"cebuana\" | \"cembrapay\" | \"centi\" | \"cetelem\" | \"checkout-finance\" | \"chinabank\" | \"cimb-clicks\" | \"cimb\" | \"circle-k\" | \"citadele\" | \"citi-pay\" | \"clave-telered\" | \"clearpay\" | \"clerq\" | \"cleverpay\" | \"clip\" | \"cliq\" | \"codensa\" | \"coinsph\" | \"collector-bank\" | \"coop\" | \"coppel-pay\" | \"credit-agricole\" | \"credit-key\" | \"creditclick-paynl-version\" | \"credix\" | \"cuotas\" | \"d-barai\" | \"dai\" | \"daily-yamazaki\" | \"dan-dan\" | \"dana\" | \"danamon-online\" | \"dankort\" | \"danske-bank\" | \"dappmx\" | \"dash\" | \"daviplata\" | \"de-cadeaukaart\" | \"depay\" | \"deutsche-bank\" | \"dinacard\" | \"diners-club\" | \"direct-bank-transfer-latin-america\" | \"directa24\" | \"directpay\" | \"discover\" | \"divido\" | \"dnb\" | \"docomo-barai\" | \"dogecoin\" | \"dropp\" | \"duitnow\" | \"duologi\" | \"dwolla\" | \"easywallet\" | \"ebucks\" | \"echelon-financing\" | \"ecpay\" | \"edenred\" | \"efecty\" | \"eft-secure\" | \"eftpos-au\" | \"eghl\" | \"elo\" | \"elv\" | \"empty\" | \"enets\" | \"eos\" | \"epayments\" | \"epospay\" | \"eps\" | \"erste\" | \"escrowcom\" | \"esr-paymentslip-switzerland\" | \"ethereum\" | \"etihad-guest-pay\" | \"etika\" | \"ewallet-indonesia\" | \"ewallet-philippines\" | \"ewallet-southkorea\" | \"facebook-pay\" | \"fairstone-payments\" | \"fam\" | \"familymart\" | \"fantom\" | \"farmlands\" | \"fashion-giftcard-paynlversion\" | \"fashioncheque\" | \"favepay\" | \"fawry\" | \"finloup\" | \"fintecture\" | \"fintoc\" | \"flexiti\" | \"float-payments\" | \"flying-blue-plus\" | \"forbrugsforeningen\" | \"forsa\" | \"fortiva\" | \"fps\" | \"fpx\" | \"freecharge\" | \"freedompay\" | \"futurepay-mytab\" | \"gcash\" | \"generalfinancing\" | \"generic\" | \"genoapay\" | \"gezondheidsbon-paynl-version\" | \"giftcard\" | \"giropay\" | \"givacard\" | \"glbe-paypal\" | \"glbe-plus\" | \"gmo-atokara\" | \"gmo-bank-transfer\" | \"gmo-postpay\" | \"gmo-virtualaccount\" | \"gnosis\" | \"google-pay\" | \"google-wallet\" | \"gopay\" | \"grabpay\" | \"grailpay\" | \"gusd\" | \"hana-card\" | \"handelsbanken\" | \"happy-pay\" | \"hello-clever\" | \"heylight\" | \"hitrustpay-transfer\" | \"home-credit\" | \"hong-leong-bank\" | \"hong-leong-connect\" | \"hsbc\" | \"huis-tuin-cadeau\" | \"humm\" | \"hyper\" | \"hypercard\" | \"hypercash\" | \"hyundai-card\" | \"ibexpay\" | \"ideal\" | \"in3-via-ideal\" | \"in3\" | \"inbank\" | \"indomaret\" | \"ing-homepay\" | \"interac\" | \"ivy\" | \"iwocapay-pay-later\" | \"jcb\" | \"jenius\" | \"jko\" | \"jousto\" | \"kakao-pay\" | \"kakebaraidotcom\" | \"kasikornbank\" | \"kasssh\" | \"katapult\" | \"kb-card\" | \"kbc-cbc\" | \"kcp-credit-card\" | \"kfast\" | \"khqr\" | \"klarna-pay-later\" | \"klarna-pay-now\" | \"klarna-slice-it\" | \"klarna\" | \"knaken-settle\" | \"knet\" | \"koalafi\" | \"koin\" | \"krediidipank\" | \"kredivo\" | \"krungsri\" | \"krungthai-bank\" | \"kueski-pay\" | \"kunst-en-cultuur-cadeaukaart\" | \"kuwait-finance-house\" | \"land-bank\" | \"laser\" | \"latitude-creditline-au\" | \"latitude-gem-au\" | \"latitude-gem-nz\" | \"latitude-go-au\" | \"latitudepay\" | \"lawson\" | \"laybuy-heart\" | \"laybuy\" | \"lbc\" | \"lhv\" | \"line-pay\" | \"linkaja\" | \"linkpay\" | \"litecoin\" | \"lku\" | \"lloyds\" | \"lotte-card\" | \"lpb\" | \"luminor\" | \"lunch-check\" | \"lydia\" | \"mach\" | \"mada\" | \"maestro\" | \"mandiri\" | \"mash\" | \"master\" | \"mastercard\" | \"masterpass\" | \"maxima\" | \"maya-bank\" | \"maya\" | \"maybank-qrpay\" | \"maybank\" | \"maybankm2u\" | \"mb-way\" | \"mb\" | \"mcash\" | \"medicinos-bankas\" | \"meeza\" | \"mercado-credito\" | \"mercado-pago\" | \"merpay\" | \"meta-pay\" | \"metro-bank\" | \"military-starcard\" | \"minicuotas\" | \"ministop\" | \"mobicred\" | \"mobikwik\" | \"mobilepay\" | \"mode\" | \"mokka\" | \"momopay\" | \"mondido\" | \"monero\" | \"monzo\" | \"mpesa\" | \"mtn-mobile-money\" | \"multisafepay\" | \"mybank\" | \"myfatoorah\" | \"n26\" | \"naps\" | \"nationale-bioscoopbon\" | \"nationale-entertainmentcard\" | \"natwest\" | \"naver-pay\" | \"nelo\" | \"nequi\" | \"netbanking\" | \"neteller\" | \"nh-card\" | \"nordea\" | \"notyd\" | \"novuna\" | \"npatobarai\" | \"npkakebarai\" | \"oca\" | \"ocbc-bank\" | \"octo-clicks\" | \"octopus\" | \"offline-bank-transfer-latin-america\" | \"ola-money\" | \"omannet\" | \"omasp\" | \"oney\" | \"online-banking\" | \"online-banktransfer\" | \"op\" | \"opay\" | \"openpay\" | \"optimism\" | \"orange-mobile-money\" | \"overstock-citicobrand\" | \"overstock-citiplcc\" | \"ovo\" | \"oxxo\" | \"ozow\" | \"pagoefectivo\" | \"paid\" | \"paidy\" | \"palawa\" | \"palawan\" | \"pastpay\" | \"pay-after-delivery-instalments\" | \"pay-by-bank-us\" | \"pay-by-bank\" | \"pay-easy\" | \"pay-pay\" | \"paybylink\" | \"paycash\" | \"payco\" | \"payconiq\" | \"payd\" | \"payfast-instant-eft\" | \"payflex\" | \"payid\" | \"payitmonthly\" | \"payjustnow\" | \"paymark-online-eftpos\" | \"paymaya\" | \"payme\" | \"paynow-mbank\" | \"paynow\" | \"payoo-qr\" | \"payoo\" | \"paypal\" | \"payplan\" | \"paypo\" | \"payrexx-bank-transfer\" | \"payright\" | \"paysafecard-paynl-version\" | \"paysafecard\" | \"paysafecash\" | \"paysera\" | \"paysquad\" | \"paytm\" | \"payto\" | \"paytomorrow\" | \"payu\" | \"payzapp\" | \"pei\" | \"perlasfinance\" | \"permata\" | \"pf-pay\" | \"pivo\" | \"pix\" | \"podium-cadeaukaart\" | \"pointspay\" | \"poli\" | \"polygon\" | \"poppankki\" | \"postfinance-card\" | \"postfinance-efinance\" | \"postpay\" | \"powered-by-ansa-stored-value\" | \"powered-by-ansa\" | \"powerpay\" | \"pps\" | \"prepaysolutions\" | \"progressive-leasing\" | \"przelew24\" | \"przelewy24-paynl-version\" | \"przelewy24\" | \"pse\" | \"public-bank\" | \"publicbank-pbe\" | \"qasitli\" | \"qliro\" | \"qr-promptpay\" | \"qris\" | \"qrph\" | \"rabbit-line-pay\" | \"rabobank\" | \"rakuten-pay\" | \"rapid-transfer\" | \"ratepay\" | \"raty-pekao\" | \"rcbc\" | \"rcs\" | \"reka\" | \"resolve-pay\" | \"revolut\" | \"rhb-bank\" | \"rhb-now\" | \"rietumu\" | \"riverty-paynl-version\" | \"riverty\" | \"rupay\" | \"saastopankki\" | \"sadad\" | \"sam\" | \"samsung-card\" | \"samsung-pay\" | \"santander\" | \"satisfi\" | \"satispay\" | \"sbpl\" | \"scalapay\" | \"scream-truck-wallet\" | \"scream-truck\" | \"seb\" | \"seicomart\" | \"sepa-bank-transfer\" | \"sepa-direct-debit\" | \"sequra\" | \"seven-eleven\" | \"sezzle\" | \"shib\" | \"shinhan-card\" | \"shop-pay\" | \"shopeepay\" | \"shopify-pay\" | \"siam-commercial\" | \"siauliu-bankas\" | \"siirto\" | \"sika-fsa\" | \"sika-hsa\" | \"sika\" | \"simpl\" | \"simple-pay\" | \"sinpe-movil\" | \"sistecredito\" | \"skeps\" | \"skrill-digital-wallet\" | \"slice-fnbo\" | \"smartpay\" | \"snap-checkout\" | \"snapmint\" | \"societe-generale\" | \"sofort\" | \"softbank\" | \"solana-pay-helio\" | \"solana-pay\" | \"solana\" | \"souhoola\" | \"spankki\" | \"sparkasse\" | \"spei\" | \"splitit\" | \"spotii\" | \"spraypay\" | \"standard-chartered\" | \"stc-pay\" | \"stoov\" | \"store-credit\" | \"stripe\" | \"sunkus\" | \"super-payments\" | \"svea-b2b-faktura\" | \"svea-b2b-invoice\" | \"svea-checkout\" | \"svea-credit-account\" | \"svea-delbetalning\" | \"svea-faktura\" | \"svea-invoice\" | \"svea-lasku\" | \"svea-ostukonto\" | \"svea-part-payment\" | \"svea-yrityslasku\" | \"sveaeramaksu\" | \"swedbank\" | \"swiftpay\" | \"swish\" | \"swissbilling\" | \"sympl\" | \"synchrony-pay\" | \"synchrony\" | \"tabby\" | \"tabit\" | \"taly\" | \"tamara\" | \"tandympayment\" | \"tasa-cero\" | \"tbi-bank\" | \"tcf\" | \"tendopay\" | \"tensile\" | \"tesco-lotus\" | \"thanachart-bank\" | \"timepayment\" | \"tiptop\" | \"todopay\" | \"toss\" | \"touch-n-go\" | \"tpay\" | \"trevipay\" | \"truelayer\" | \"truemoney-pay\" | \"trustly\" | \"twig-pay\" | \"twint\" | \"twoinvoice\" | \"uae-visa\" | \"uangme\" | \"ubp\" | \"underpay\" | \"unionpay\" | \"unipay\" | \"uob-ez-pay\" | \"uob-thai\" | \"uob\" | \"upi\" | \"urbo\" | \"urpay\" | \"usdc\" | \"usdp\" | \"v-pay\" | \"valu\" | \"venmo\" | \"ventipay\" | \"venus-plcc\" | \"viabill\" | \"vipps\" | \"visa-electron\" | \"visa\" | \"volksbank\" | \"volt\" | \"vvv-cadeaukaart-paynl-version\" | \"vvv-giftcard\" | \"waave-pay-by-bank\" | \"wallet\" | \"walley\" | \"wbtc\" | \"webshop-giftcard\" | \"wechat-pay\" | \"wechat-paynl-version\" | \"wegetfinancing\" | \"whish-checkout\" | \"whish-pay\" | \"wise\" | \"wissel\" | \"world-chain\" | \"xrp\" | \"yape\" | \"yappy\" | \"ymobile\" | \"younited-pay\" | \"zalopay\" | \"zapper\" | \"zingala\" | \"zinia\" | \"zip\" | \"zoodpay\" | \"zulily-credit-card\" | \"zustaina\"", + "description": "" + } + }, + "AnyString": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "AnyString", + "value": "string & {}", + "description": "Prevents widening string literal types in a union to `string`." + } + }, + "PaymentIconElement": { + "src/surfaces/checkout/components/PaymentIcon.ts": { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "name": "PaymentIconElement", + "description": "The HTML element interface for the `s-payment-icon` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the payment icon for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about which payment method the icon represents.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "PaymentIconName | AnyString", + "description": "The payment method to display. Specify a payment method name from the available set (for example, `'visa'`, `'mastercard'`, or `'paypal'`), or use an empty string to show no icon.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface PaymentIconElement extends PaymentIconElementProps, Omit {\n}" + } + }, + "PaymentIconProps": { + "src/surfaces/checkout/components/PaymentIcon.ts": { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "name": "PaymentIconProps", + "description": "The properties for the payment icon component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the payment icon for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about which payment method the icon represents.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PaymentIcon.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "PaymentIconName | AnyString", + "description": "The payment method to display. Specify a payment method name from the available set (for example, `'visa'`, `'mastercard'`, or `'paypal'`), or use an empty string to show no icon.", + "isOptional": true, + "defaultValue": "''" + } + ], + "value": "export interface PaymentIconProps extends PaymentIconElementProps {\n}" + } + }, + "PhoneFieldElementEvents": { + "src/surfaces/checkout/components/PhoneField.ts": { + "filePath": "src/surfaces/checkout/components/PhoneField.ts", + "name": "PhoneFieldElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/PhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the phone field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the phone field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the phone field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the phone field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface PhoneFieldElementEvents {\n /**\n * A callback fired when the phone field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the phone field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the phone field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the phone field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + } + }, + "PhoneFieldElementSlots": { + "src/surfaces/checkout/components/PhoneField.ts": { + "filePath": "src/surfaces/checkout/components/PhoneField.ts", + "name": "PhoneFieldElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/PhoneField.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface PhoneFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "PopoverElementProps": { + "src/surfaces/checkout/components/Popover.ts": { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "name": "PopoverElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The block size of the popover (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The inline size of the popover (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum block size of the popover. Constrains the popover's height to prevent it from exceeding this value. Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum inline size of the popover. Constrains the popover's width to prevent it from exceeding this value. Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum block size of the popover. Ensures the popover maintains at least this height. Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum inline size of the popover. Ensures the popover maintains at least this width. Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + } + ], + "value": "export interface PopoverElementProps extends Pick {\n /**\n * The block size of the popover (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n *\n * @default 'auto'\n */\n blockSize?: SizeUnitsOrAuto;\n /**\n * The inline size of the popover (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n *\n * @default 'auto'\n */\n inlineSize?: SizeUnitsOrAuto;\n /**\n * The maximum block size of the popover. Constrains the popover's height to prevent it from exceeding this value. Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).\n *\n * @default 'none'\n */\n maxBlockSize?: SizeUnitsOrNone;\n /**\n * The maximum inline size of the popover. Constrains the popover's width to prevent it from exceeding this value. Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).\n *\n * @default 'none'\n */\n maxInlineSize?: SizeUnitsOrNone;\n /**\n * The minimum block size of the popover. Ensures the popover maintains at least this height. Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).\n *\n * @default '0'\n */\n minBlockSize?: SizeUnits;\n /**\n * The minimum inline size of the popover. Ensures the popover maintains at least this width. Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).\n *\n * @default '0'\n */\n minInlineSize?: SizeUnits;\n}" + } + }, + "PopoverEvents": { + "src/surfaces/checkout/components/Popover.ts": { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "name": "PopoverEvents", + "description": "The event callbacks for monitoring popover visibility changes.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + } + ], + "value": "export interface PopoverEvents extends Pick {\n}" + } + }, + "PopoverElementEvents": { + "src/surfaces/checkout/components/Popover.ts": { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "name": "PopoverElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "CallbackEventListener", + "description": "A callback fired immediately after the popover is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "CallbackEventListener", + "description": "A callback fired immediately after the popover is shown.", + "isOptional": true + } + ], + "value": "export interface PopoverElementEvents {\n /**\n * A callback fired immediately after the popover is hidden.\n */\n hide?: CallbackEventListener;\n /**\n * A callback fired immediately after the popover is shown.\n */\n show?: CallbackEventListener;\n}" + } + }, + "PopoverElement": { + "src/surfaces/checkout/components/Popover.ts": { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "name": "PopoverElement", + "description": "The HTML element interface for the `s-popover` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The block size of the popover (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The inline size of the popover (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum block size of the popover. Constrains the popover's height to prevent it from exceeding this value. Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum inline size of the popover. Constrains the popover's width to prevent it from exceeding this value. Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum block size of the popover. Ensures the popover maintains at least this height. Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum inline size of the popover. Ensures the popover maintains at least this width. Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onhide", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onshow", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface PopoverElement extends Omit, Omit {\n onhide: PopoverProps['onHide'];\n onshow: PopoverProps['onShow'];\n}" + } + }, + "PopoverProps": { + "src/surfaces/checkout/components/Popover.ts": { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "name": "PopoverProps", + "description": "The properties for the popover component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "SizeUnitsOrAuto", + "description": "The block size of the popover (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "SizeUnitsOrAuto", + "description": "The inline size of the popover (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "SizeUnitsOrNone", + "description": "The maximum block size of the popover. Constrains the popover's height to prevent it from exceeding this value. Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "SizeUnitsOrNone", + "description": "The maximum inline size of the popover. Constrains the popover's width to prevent it from exceeding this value. Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "SizeUnits", + "description": "The minimum block size of the popover. Ensures the popover maintains at least this height. Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "SizeUnits", + "description": "The minimum inline size of the popover. Ensures the popover maintains at least this width. Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Popover.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + } + ], + "value": "export interface PopoverProps extends PopoverElementProps, PopoverEvents {\n}" + } + }, + "PressButtonElementProps": { + "src/surfaces/checkout/components/PressButton.ts": { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "name": "PressButtonElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPressed", + "value": "boolean", + "description": "Whether the button is pressed by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The inline width of the button component.\n\n- `'auto'`: The size depends on the surface and context.\n- `'fill'`: The button takes up 100% of the available inline size.\n- `'fit-content'`: The button takes up the minimum inline size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed. This also disables the button.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "Whether the button is pressed.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PressButtonElementProps extends Pick {\n}" + } + }, + "PressButtonEvents": { + "src/surfaces/checkout/components/PressButton.ts": { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "name": "PressButtonEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface PressButtonEvents extends Pick {\n}" + } + }, + "PressButtonElementEvents": { + "src/surfaces/checkout/components/PressButton.ts": { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "name": "PressButtonElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the button loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "click", + "value": "CallbackEventListener", + "description": "A callback fired when the button is clicked.\n\nLearn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the button receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface PressButtonElementEvents {\n /**\n * A callback fired when the button is clicked.\n *\n * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).\n */\n click?: CallbackEventListener;\n /**\n * A callback fired when the button loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the button receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" + } + }, + "PressButtonElement": { + "src/surfaces/checkout/components/PressButton.ts": { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "name": "PressButtonElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPressed", + "value": "boolean", + "description": "Whether the button is pressed by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The inline width of the button component.\n\n- `'auto'`: The size depends on the surface and context.\n- `'fill'`: The button takes up 100% of the available inline size.\n- `'fit-content'`: The button takes up the minimum inline size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed. This also disables the button.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "Whether the button is pressed.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface PressButtonElement extends PressButtonElementProps, Omit {\n onblur: PressButtonEvents['onBlur'];\n onclick: PressButtonEvents['onClick'];\n onfocus: PressButtonEvents['onFocus'];\n}" + } + }, + "PressButtonProps": { + "src/surfaces/checkout/components/PressButton.ts": { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "name": "PressButtonProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "defaultPressed", + "value": "boolean", + "description": "Whether the button is pressed by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the button is disabled, preventing it from being clicked or receiving focus.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "'auto' | 'fill' | 'fit-content'", + "description": "The inline width of the button component.\n\n- `'auto'`: The size depends on the surface and context.\n- `'fill'`: The button takes up 100% of the available inline size.\n- `'fit-content'`: The button takes up the minimum inline size required to fit its content.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "loading", + "value": "boolean", + "description": "Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed. This also disables the button.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onClick", + "value": "(event: Event) => void", + "description": "A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/PressButton.ts", + "syntaxKind": "PropertySignature", + "name": "pressed", + "value": "boolean", + "description": "Whether the button is pressed.", + "isOptional": true, + "defaultValue": "false" + } + ], + "value": "export interface PressButtonProps extends PressButtonElementProps, PressButtonEvents {\n}" + } + }, + "ProductThumbnailElementProps": { + "src/surfaces/checkout/components/ProductThumbnail.ts": { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "name": "ProductThumbnailElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'base' | 'small-100'", + "description": "The size of the product thumbnail image.\n\n- `'base'`: Default size that works well in most contexts.\n- `'small'`: Small thumbnail, good for secondary contexts or tight layouts.\n- `'small-100'`: Extra small thumbnail for compact displays or dense lists.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered. Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "totalItems", + "value": "number", + "description": "The total number of items that the product thumbnail represents. When this value exceeds 1, the component displays a badge showing the count, useful for representing bundled products or quantities.", + "isOptional": true + } + ], + "value": "export interface ProductThumbnailElementProps extends Pick {\n /**\n * The size of the product thumbnail image.\n *\n * - `'base'`: Default size that works well in most contexts.\n * - `'small'`: Small thumbnail, good for secondary contexts or tight layouts.\n * - `'small-100'`: Extra small thumbnail for compact displays or dense lists.\n *\n * @default 'base'\n */\n size?: Extract;\n}" + } + }, + "ProductThumbnailElement": { + "src/surfaces/checkout/components/ProductThumbnail.ts": { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "name": "ProductThumbnailElement", + "description": "The HTML element interface for the `s-product-thumbnail` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'base' | 'small-100'", + "description": "The size of the product thumbnail image.\n\n- `'base'`: Default size that works well in most contexts.\n- `'small'`: Small thumbnail, good for secondary contexts or tight layouts.\n- `'small-100'`: Extra small thumbnail for compact displays or dense lists.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered. Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "totalItems", + "value": "number", + "description": "The total number of items that the product thumbnail represents. When this value exceeds 1, the component displays a badge showing the count, useful for representing bundled products or quantities.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ProductThumbnailElement extends ProductThumbnailElementProps, Omit {\n}" + } + }, + "ProductThumbnailProps": { + "src/surfaces/checkout/components/ProductThumbnail.ts": { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "name": "ProductThumbnailProps", + "description": "The properties for the product thumbnail component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "alt", + "value": "string", + "description": "Alternative text that describes the image for accessibility.\n\nProvides a text description of the image for users with assistive technology and serves as a fallback when the image fails to load. A well-written description enables people with visual impairments to understand non-text content.\n\nWhen a screen reader encounters an image, it reads this description aloud. When an image fails to load, this text displays on screen, helping all users understand what content was intended.\n\nLearn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'base' | 'small-100'", + "description": "The size of the product thumbnail image.\n\n- `'base'`: Default size that works well in most contexts.\n- `'small'`: Small thumbnail, good for secondary contexts or tight layouts.\n- `'small-100'`: Extra small thumbnail for compact displays or dense lists.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "sizes", + "value": "string", + "description": "A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "src", + "value": "string", + "description": "The image source (either a remote URL or a local file resource).\n\nWhen the image is loading or no `src` is provided, a placeholder is rendered. Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "srcSet", + "value": "string", + "description": "A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ProductThumbnail.ts", + "syntaxKind": "PropertySignature", + "name": "totalItems", + "value": "number", + "description": "The total number of items that the product thumbnail represents. When this value exceeds 1, the component displays a badge showing the count, useful for representing bundled products or quantities.", + "isOptional": true + } + ], + "value": "export interface ProductThumbnailProps extends ProductThumbnailElementProps {\n}" + } + }, + "ProgressElementProps": { + "src/surfaces/checkout/components/Progress.ts": { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "name": "ProgressElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes what is progressing. Use this to provide context about the ongoing task, such as \"Loading order details\" or \"Uploading file\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'critical'", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "number", + "description": "How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", + "isOptional": true + } + ], + "value": "export interface ProgressElementProps extends Pick {\n /**\n * A label announced by assistive technologies that describes what is progressing. Use this to provide context about the ongoing task, such as \"Loading order details\" or \"Uploading file\".\n */\n accessibilityLabel?: ProgressProps$1['accessibilityLabel'];\n /**\n * The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n *\n * Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).\n *\n * @default 1\n */\n max?: ProgressProps$1['max'];\n /**\n * The semantic meaning and color treatment of the progress indicator.\n *\n * - `auto`: Automatically determined based on context.\n * - `critical`: Indicates an urgent or error state requiring immediate attention.\n *\n * @default 'auto'\n */\n tone?: Extract;\n /**\n * How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.\n *\n * Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).\n */\n value?: ProgressProps$1['value'];\n}" + } + }, + "ProgressElement": { + "src/surfaces/checkout/components/Progress.ts": { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "name": "ProgressElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes what is progressing. Use this to provide context about the ongoing task, such as \"Loading order details\" or \"Uploading file\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'critical'", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "number", + "description": "How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ProgressElement extends ProgressElementProps, Omit {\n}" + } + }, + "ProgressProps": { + "src/surfaces/checkout/components/Progress.ts": { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "name": "ProgressProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes what is progressing. Use this to provide context about the ongoing task, such as \"Loading order details\" or \"Uploading file\".", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "max", + "value": "number", + "description": "The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.\n\nLearn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).", + "isOptional": true, + "defaultValue": "1" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'auto' | 'critical'", + "description": "The semantic meaning and color treatment of the progress indicator.\n\n- `auto`: Automatically determined based on context.\n- `critical`: Indicates an urgent or error state requiring immediate attention.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Progress.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "number", + "description": "How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.\n\nLearn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).", + "isOptional": true + } + ], + "value": "export interface ProgressProps extends ProgressElementProps {\n}" + } + }, + "QRCodeElementProps": { + "src/surfaces/checkout/components/QRCode.ts": { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "name": "QRCodeElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or contents of the QR code for accessibility. When set, it will be announced to users using assistive technologies such as screen readers.", + "isOptional": true, + "defaultValue": "'QR code' (translated to the user's locale)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "'base' | 'none'", + "description": "Whether to display a border around the QR code.\n\n- `'base'`: Applies a standard border to frame the QR code.\n- `'none'`: Removes the border for seamless integration with the surrounding layout.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content — typically by opening a URL in a browser or prompting an action based on the content type.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "logo", + "value": "string", + "description": "The URL of an image to display in the center of the QR code, typically used for branding. The image should be small enough not to interfere with the QR code's scannability.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onError", + "value": "(event: Event) => void", + "description": "A callback fired when the conversion of `content` to a QR code fails. This can happen when the content is too long or contains unsupported characters.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'base' | 'fill'", + "description": "The displayed size of the QR code.\n\n- `'base'`: The QR code is displayed at its default fixed size.\n- `'fill'`: The QR code takes up 100% of the available inline size, useful for responsive layouts.", + "isOptional": true, + "defaultValue": "'base'" + } + ], + "value": "export interface QRCodeElementProps extends QRCodeProps$1 {\n}" + } + }, + "QRCodeEvents": { + "src/surfaces/checkout/components/QRCode.ts": { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "name": "QRCodeEvents", + "description": "The event handlers for the QR code component.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onError", + "value": "(event: Event) => void", + "description": "A callback fired when the conversion of `content` to a QR code fails. This can happen when the content is too long or contains unsupported characters.", + "isOptional": true + } + ], + "value": "export interface QRCodeEvents extends Pick {\n}" + } + }, + "QRCodeElementEvents": { + "src/surfaces/checkout/components/QRCode.ts": { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "name": "QRCodeElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "CallbackEventListener", + "description": "A callback that's fired when the conversion of `content` to a QR code fails.", + "isOptional": true + } + ], + "value": "export interface QRCodeElementEvents {\n /**\n * A callback that's fired when the conversion of `content` to a QR code fails.\n */\n error?: CallbackEventListener;\n}" + } + }, + "QRCodelement": { + "src/surfaces/checkout/components/QRCode.ts": { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "name": "QRCodelement", + "description": "The HTML element interface for the `s-qr-code` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or contents of the QR code for accessibility. When set, it will be announced to users using assistive technologies such as screen readers.", + "isOptional": true, + "defaultValue": "'QR code' (translated to the user's locale)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "'base' | 'none'", + "description": "Whether to display a border around the QR code.\n\n- `'base'`: Applies a standard border to frame the QR code.\n- `'none'`: Removes the border for seamless integration with the surrounding layout.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content — typically by opening a URL in a browser or prompting an action based on the content type.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "logo", + "value": "string", + "description": "The URL of an image to display in the center of the QR code, typically used for branding. The image should be small enough not to interfere with the QR code's scannability.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onError", + "value": "(event: Event) => void", + "description": "A callback fired when the conversion of `content` to a QR code fails. This can happen when the content is too long or contains unsupported characters.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'base' | 'fill'", + "description": "The displayed size of the QR code.\n\n- `'base'`: The QR code is displayed at its default fixed size.\n- `'fill'`: The QR code takes up 100% of the available inline size, useful for responsive layouts.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface QRCodelement extends QRCodeElementProps, Omit {\n onerror: QRCodeEvents['onError'];\n}" + } + }, + "QRCodeProps": { + "src/surfaces/checkout/components/QRCode.ts": { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "name": "QRCodeProps", + "description": "The properties for the QR code component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose or contents of the QR code for accessibility. When set, it will be announced to users using assistive technologies such as screen readers.", + "isOptional": true, + "defaultValue": "'QR code' (translated to the user's locale)" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "'base' | 'none'", + "description": "Whether to display a border around the QR code.\n\n- `'base'`: Applies a standard border to frame the QR code.\n- `'none'`: Removes the border for seamless integration with the surrounding layout.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content — typically by opening a URL in a browser or prompting an action based on the content type.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "logo", + "value": "string", + "description": "The URL of an image to display in the center of the QR code, typically used for branding. The image should be small enough not to interfere with the QR code's scannability.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "onError", + "value": "(event: Event) => void", + "description": "A callback fired when the conversion of `content` to a QR code fails. This can happen when the content is too long or contains unsupported characters.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QRCode.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'base' | 'fill'", + "description": "The displayed size of the QR code.\n\n- `'base'`: The QR code is displayed at its default fixed size.\n- `'fill'`: The QR code takes up 100% of the available inline size, useful for responsive layouts.", + "isOptional": true, + "defaultValue": "'base'" + } + ], + "value": "export interface QRCodeProps extends QRCodeElementProps, QRCodeEvents {\n}" + } + }, + "QueryContainerElementProps": { + "src/surfaces/checkout/components/QueryContainer.ts": { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "name": "QueryContainerElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "containerName", + "value": "string", + "description": "A custom name for the container, used in [container queries](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name) to target this container specifically. The value is added alongside the default name `s-default`.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface QueryContainerElementProps extends Pick {\n}" + } + }, + "QueryContainerElement": { + "src/surfaces/checkout/components/QueryContainer.ts": { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "name": "QueryContainerElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "containerName", + "value": "string", + "description": "A custom name for the container, used in [container queries](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name) to target this container specifically. The value is added alongside the default name `s-default`.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface QueryContainerElement extends QueryContainerElementProps, Omit {\n}" + } + }, + "QueryContainerProps": { + "src/surfaces/checkout/components/QueryContainer.ts": { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "name": "QueryContainerProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "containerName", + "value": "string", + "description": "A custom name for the container, used in [container queries](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name) to target this container specifically. The value is added alongside the default name `s-default`.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/QueryContainer.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface QueryContainerProps extends QueryContainerElementProps {\n}" + } + }, + "ScrollBoxElementProps": { + "src/surfaces/checkout/components/ScrollBox.ts": { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "name": "ScrollBoxElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "'' | 'base'", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`", + "description": "The overflow behavior of the scroll box, controlling whether content that exceeds the container is scrollable or clipped. Learn more about [`overflow`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).\n\n- `hidden`: Content is clipped and the element is not scrollable in that axis.\n- `auto`: Content is clipped and becomes scrollable in that axis.\n\nSupports 1-to-2-value syntax using flow-relative axes. Two values are ordered as `block inline` (for example, `hidden auto` clips vertically and scrolls horizontally).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface ScrollBoxElementProps extends Pick {\n /**\n * The background color of the scroll box.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The color of the border using the design system's color scale. Overrides the color value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderColor?: ReducedColorKeyword | '';\n /**\n * The roundedness of the scroll box's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n}" + } + }, + "ScrollBoxProps": { + "src/surfaces/checkout/components/ScrollBox.ts": { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "name": "ScrollBoxProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "'' | 'base'", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`", + "description": "The overflow behavior of the scroll box, controlling whether content that exceeds the container is scrollable or clipped. Learn more about [`overflow`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).\n\n- `hidden`: Content is clipped and the element is not scrollable in that axis.\n- `auto`: Content is clipped and becomes scrollable in that axis.\n\nSupports 1-to-2-value syntax using flow-relative axes. Two values are ordered as `block inline` (for example, `hidden auto` clips vertically and scrolls horizontally).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface ScrollBoxProps extends ScrollBoxElementProps {\n}" + } + }, + "OverflowKeyword": { + "src/surfaces/checkout/components/components.ts": { + "filePath": "src/surfaces/checkout/components/components.ts", + "syntaxKind": "TypeAliasDeclaration", + "name": "OverflowKeyword", + "value": "\"auto\" | \"hidden\"", + "description": "" + } + }, + "ScrollBoxElement": { + "src/surfaces/checkout/components/ScrollBox.ts": { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "name": "ScrollBoxElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "AccessibilityRole", + "description": "The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the scroll box.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderColor", + "value": "'' | 'base'", + "description": "The color of the border using the design system's color scale. Overrides the color value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the scroll box's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`", + "description": "The overflow behavior of the scroll box, controlling whether content that exceeds the container is scrollable or clipped. Learn more about [`overflow`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).\n\n- `hidden`: Content is clipped and the element is not scrollable in that axis.\n- `auto`: Content is clipped and becomes scrollable in that axis.\n\nSupports 1-to-2-value syntax using flow-relative axes. Two values are ordered as `block inline` (for example, `hidden auto` clips vertically and scrolls horizontally).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/ScrollBox.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface ScrollBoxElement extends ScrollBoxElementProps, Omit {\n}" + } + }, + "SectionElementProps": { + "src/surfaces/checkout/components/Section.ts": { + "filePath": "src/surfaces/checkout/components/Section.ts", + "name": "SectionElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose of the section. When no `heading` property is provided, you **must** set `accessibilityLabel` so screen readers can identify the section.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the section to summarize its content.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "The padding applied to all edges of the section.\n\n- `base`: Applies context-appropriate padding. In some contexts this may result in no visible padding.\n- `none`: Removes all padding, allowing child elements to span the full width of the section. Use a Box with `base` padding to restore spacing for individual content areas.", + "isOptional": true, + "defaultValue": "'base'" + } + ], + "value": "export interface SectionElementProps extends Pick {\n}" + } + }, + "SectionElement": { + "src/surfaces/checkout/components/Section.ts": { + "filePath": "src/surfaces/checkout/components/Section.ts", + "name": "SectionElement", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose of the section. When no `heading` property is provided, you **must** set `accessibilityLabel` so screen readers can identify the section.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the section to summarize its content.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "The padding applied to all edges of the section.\n\n- `base`: Applies context-appropriate padding. In some contexts this may result in no visible padding.\n- `none`: Removes all padding, allowing child elements to span the full width of the section. Use a Box with `base` padding to restore spacing for individual content areas.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface SectionElement extends SectionElementProps, Omit {\n}" + } + }, + "SectionProps": { + "src/surfaces/checkout/components/Section.ts": { + "filePath": "src/surfaces/checkout/components/Section.ts", + "name": "SectionProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose of the section. When no `heading` property is provided, you **must** set `accessibilityLabel` so screen readers can identify the section.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "The heading text displayed at the top of the section to summarize its content.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Section.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "'base' | 'none'", + "description": "The padding applied to all edges of the section.\n\n- `base`: Applies context-appropriate padding. In some contexts this may result in no visible padding.\n- `none`: Removes all padding, allowing child elements to span the full width of the section. Use a Box with `base` padding to restore spacing for individual content areas.", + "isOptional": true, + "defaultValue": "'base'" + } + ], + "value": "export interface SectionProps extends SectionElementProps {\n}" + } + }, + "SelectElementProps": { + "src/surfaces/checkout/components/Select.ts": { + "filePath": "src/surfaces/checkout/components/Select.ts", + "name": "SelectElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface SelectElementProps extends Pick {\n}" + } + }, + "SelectEvents": { + "src/surfaces/checkout/components/Select.ts": { + "filePath": "src/surfaces/checkout/components/Select.ts", + "name": "SelectEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface SelectEvents extends Pick {\n}" + } + }, + "SelectElementEvents": { + "src/surfaces/checkout/components/Select.ts": { + "filePath": "src/surfaces/checkout/components/Select.ts", + "name": "SelectElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the select loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the select value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the select receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + } + ], + "value": "export interface SelectElementEvents {\n /**\n * A callback fired when the select loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the select value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the select receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n}" + } + }, + "SelectElement": { + "src/surfaces/checkout/components/Select.ts": { + "filePath": "src/surfaces/checkout/components/Select.ts", + "name": "SelectElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface SelectElement extends SelectElementProps, Omit {\n onblur: SelectEvents['onBlur'];\n onchange: SelectEvents['onChange'];\n onfocus: SelectEvents['onFocus'];\n}" + } + }, + "SelectProps": { + "src/surfaces/checkout/components/Select.ts": { + "filePath": "src/surfaces/checkout/components/Select.ts", + "name": "SelectProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Select.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface SelectProps extends SelectElementProps, SelectEvents {\n}" + } + }, + "SheetElementProps": { + "src/surfaces/checkout/components/Sheet.ts": { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "name": "SheetElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose of the sheet, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the sheet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "defaultOpen", + "value": "boolean", + "description": "Whether the sheet should be open when it first renders. Use sparingly — only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the sheet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface SheetElementProps extends Pick {\n /**\n * A label that describes the purpose of the sheet, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the sheet.\n */\n accessibilityLabel?: string;\n}" + } + }, + "SheetEvents": { + "src/surfaces/checkout/components/Sheet.ts": { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "name": "SheetEvents", + "description": "The event callbacks for monitoring sheet visibility changes.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterShow", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + } + ], + "value": "export interface SheetEvents extends Pick {\n}" + } + }, + "SheetElementEvents": { + "src/surfaces/checkout/components/Sheet.ts": { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "name": "SheetElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "CallbackEventListener", + "description": "A callback fired when the sheet is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "aftershow", + "value": "CallbackEventListener", + "description": "A callback fired when the sheet is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "hide", + "value": "CallbackEventListener", + "description": "A callback fired immediately after the sheet is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "show", + "value": "CallbackEventListener", + "description": "A callback fired immediately after the sheet is shown.", + "isOptional": true + } + ], + "value": "export interface SheetElementEvents {\n /**\n * A callback fired when the sheet is hidden, after any hide animations have completed.\n */\n afterhide?: CallbackEventListener;\n /**\n * A callback fired when the sheet is shown, after any show animations have completed.\n */\n aftershow?: CallbackEventListener;\n /**\n * A callback fired immediately after the sheet is hidden.\n */\n hide?: CallbackEventListener;\n /**\n * A callback fired immediately after the sheet is shown.\n */\n show?: CallbackEventListener;\n}" + } + }, + "SheetElementSlots": { + "src/surfaces/checkout/components/Sheet.ts": { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "name": "SheetElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "primary-action", + "value": "HTMLElement", + "description": "The main action button displayed in the sheet footer, representing the primary action users should take. Only accepts a single button component.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "secondary-actions", + "value": "HTMLElement", + "description": "Additional action buttons displayed in the sheet footer, providing alternative or supporting actions.", + "isOptional": true + } + ], + "value": "export interface SheetElementSlots {\n /**\n * The main action button displayed in the sheet footer, representing the primary action users should take. Only accepts a single button component.\n */\n 'primary-action'?: HTMLElement;\n /**\n * Additional action buttons displayed in the sheet footer, providing alternative or supporting actions.\n */\n 'secondary-actions'?: HTMLElement;\n}" + } + }, + "SheetElementMethods": { + "src/surfaces/checkout/components/Sheet.ts": { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "name": "SheetElementMethods", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay and run any associated hide animations." + } + ], + "value": "export interface SheetElementMethods extends Pick {\n}" + } + }, + "SheetElement": { + "src/surfaces/checkout/components/Sheet.ts": { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "name": "SheetElement", + "description": "The HTML element interface for the `s-sheet` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose of the sheet, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the sheet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "afterhide", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "aftershow", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "defaultOpen", + "value": "boolean", + "description": "Whether the sheet should be open when it first renders. Use sparingly — only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the sheet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "hideOverlay", + "value": "() => void", + "description": "A method to programmatically hide the overlay and run any associated hide animations." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onafterhide", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onaftershow", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onhide", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onshow", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface SheetElement extends SheetElementProps, SheetElementMethods, Omit {\n afterhide: SheetEvents['onAfterHide'];\n aftershow: SheetEvents['onAfterShow'];\n onhide: SheetEvents['onHide'];\n onshow: SheetEvents['onShow'];\n onafterhide: SheetEvents['onAfterHide'];\n onaftershow: SheetEvents['onAfterShow'];\n}" + } + }, + "SheetProps": { + "src/surfaces/checkout/components/Sheet.ts": { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "name": "SheetProps", + "description": "The properties for the sheet component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose of the sheet, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the sheet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "defaultOpen", + "value": "boolean", + "description": "Whether the sheet should be open when it first renders. Use sparingly — only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "heading", + "value": "string", + "description": "A title that describes the content of the sheet.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterHide", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is hidden, after any hide animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onAfterShow", + "value": "(event: Event) => void", + "description": "A callback fired when the overlay is shown, after any show animations have completed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onHide", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is hidden.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Sheet.ts", + "syntaxKind": "PropertySignature", + "name": "onShow", + "value": "(event: Event) => void", + "description": "A callback fired immediately after the overlay is shown.", + "isOptional": true + } + ], + "value": "export interface SheetProps extends SheetElementProps, SheetEvents {\n}" + } + }, + "SkeletonParagraphElementProps": { + "src/surfaces/checkout/components/SkeletonParagraph.ts": { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "name": "SkeletonParagraphElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The content to be used as a base for the skeleton. This content will be hidden when the skeleton is visible.\n\nThis can be useful when the skeleton is representing a known piece of content which is part of a larger element that has not yet fully loaded.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface SkeletonParagraphElementProps extends SkeletonParagraphProps$1 {\n}" + } + }, + "SkeletonParagraphElement": { + "src/surfaces/checkout/components/SkeletonParagraph.ts": { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "name": "SkeletonParagraphElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The content to be used as a base for the skeleton. This content will be hidden when the skeleton is visible.\n\nThis can be useful when the skeleton is representing a known piece of content which is part of a larger element that has not yet fully loaded.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface SkeletonParagraphElement extends SkeletonParagraphElementProps, Omit {\n}" + } + }, + "SkeletonParagraphProps": { + "src/surfaces/checkout/components/SkeletonParagraph.ts": { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "name": "SkeletonParagraphProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "content", + "value": "string", + "description": "The content to be used as a base for the skeleton. This content will be hidden when the skeleton is visible.\n\nThis can be useful when the skeleton is representing a known piece of content which is part of a larger element that has not yet fully loaded.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/SkeletonParagraph.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface SkeletonParagraphProps extends SkeletonParagraphElementProps {\n}" + } + }, + "SpinnerElementProps": { + "src/surfaces/checkout/components/Spinner.ts": { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "name": "SpinnerElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100'", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", + "isOptional": true, + "defaultValue": "'base'" + } + ], + "value": "export interface SpinnerElementProps extends SpinnerProps$1 {\n /**\n * A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.\n */\n accessibilityLabel?: SpinnerProps$1['accessibilityLabel'];\n /**\n * The size of the spinner icon.\n *\n * - `base`: The default size, suitable for most use cases.\n * - `small`: A compact size for secondary loading states.\n * - `small-100`: The smallest size for tight spaces or inline indicators.\n * - `large`: A larger size for more prominent loading states.\n * - `large-100`: The largest size for full-page or section-level loading indicators.\n *\n * @default 'base'\n */\n size?: Extract;\n}" + } + }, + "SpinnerElement": { + "src/surfaces/checkout/components/Spinner.ts": { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "name": "SpinnerElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100'", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface SpinnerElement extends SpinnerElementProps, Omit {\n}" + } + }, + "SpinnerProps": { + "src/surfaces/checkout/components/Spinner.ts": { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "name": "SpinnerProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Spinner.ts", + "syntaxKind": "PropertySignature", + "name": "size", + "value": "'small' | 'large' | 'base' | 'small-100' | 'large-100'", + "description": "The size of the spinner icon.\n\n- `base`: The default size, suitable for most use cases.\n- `small`: A compact size for secondary loading states.\n- `small-100`: The smallest size for tight spaces or inline indicators.\n- `large`: A larger size for more prominent loading states.\n- `large-100`: The largest size for full-page or section-level loading indicators.", + "isOptional": true, + "defaultValue": "'base'" + } + ], + "value": "export interface SpinnerProps extends SpinnerElementProps {\n}" + } + }, + "StackElementProps": { + "src/surfaces/checkout/components/Stack.ts": { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "name": "StackElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive>", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive>", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'", + "examples": [ + { + "title": "Example", + "description": "", + "tabs": [ + { + "code": "// The following are equivalent:\n\n", + "title": "Example" + } + ] + } + ] + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "MaybeResponsive<\"block\" | \"inline\">", + "description": "The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `block`: Children are stacked vertically (in horizontal writing modes). Content does not wrap.\n- `inline`: Children are arranged horizontally (in horizontal writing modes). Content wraps when it overflows.", + "isOptional": true, + "defaultValue": "'block'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive>", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface StackElementProps extends Pick {\n /**\n * The semantic meaning of the stack's content, used by assistive technologies.\n *\n * - `aside`: Supporting content related to the main content.\n * - `footer`: Information such as copyright, navigation links, and privacy statements.\n * - `header`: A page or section header.\n * - `main`: The primary content of the page.\n * - `section`: A generic section that should have a heading or `accessibilityLabel`.\n * - `status`: A live region with advisory information that is not urgent.\n * - `none`: Strips semantic meaning while keeping visual styling.\n * - `navigation`: A major group of navigation links.\n * - `ordered-list`: A list of ordered items.\n * - `list-item`: An item inside a list.\n * - `list-item-separator`: A divider between list items.\n * - `unordered-list`: A list of unordered items.\n * - `separator`: A divider that separates sections of content.\n * - `alert`: Important, usually time-sensitive information.\n * - `generic`: A nameless container with no semantic meaning (renders a `
`).\n *\n * @default 'generic'\n */\n accessibilityRole?: Extract;\n /**\n * The background color of the stack.\n *\n * - `base`: The standard background color for general content areas.\n * - `subdued`: A muted background for secondary or supporting content.\n * - `transparent`: No background color (the default).\n *\n * @default 'transparent'\n */\n background?: Extract;\n /**\n * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.\n *\n * @default 'none'\n */\n border?: BorderShorthand;\n /**\n * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.\n *\n * @default '' - meaning no override\n */\n borderWidth?: MaybeAllValuesShorthandProperty | '';\n /**\n * The roundedness of the stack's corners.\n *\n * - `none`: Sharp corners with no rounding.\n * - `small-100` / `small`: Subtle rounding for compact elements.\n * - `base`: Standard rounding for most use cases.\n * - `large` / `large-100`: More pronounced rounding for prominent containers.\n * - `max`: Maximum rounding, creating a pill or circular shape.\n *\n * Supports 1-to-4-value shorthand syntax for specifying different radii per corner.\n *\n * @default 'none'\n */\n borderRadius?: MaybeAllValuesShorthandProperty>;\n /**\n * Controls how lines of content are distributed along the cross axis when there is extra space.\n *\n * - `normal`: Default browser behavior.\n * - `space-between`: Distributes lines evenly with no space at the edges.\n * - `space-around`: Distributes lines evenly with equal space around each.\n * - `space-evenly`: Distributes lines with equal space between and at the edges.\n * - `stretch`: Stretches lines to fill the available space.\n * - `center`: Packs lines toward the center.\n * - `start`: Packs lines toward the start of the cross axis.\n * - `end`: Packs lines toward the end of the cross axis.\n *\n * @default 'normal'\n */\n alignContent?: MaybeResponsive>;\n /**\n * Controls how child elements are aligned along the cross axis.\n *\n * - `normal`: Default browser behavior.\n * - `stretch`: Stretches children to fill the cross axis.\n * - `center`: Centers children along the cross axis.\n * - `start`: Aligns children to the start of the cross axis.\n * - `end`: Aligns children to the end of the cross axis.\n *\n * @default 'normal'\n */\n alignItems?: MaybeResponsive>;\n /**\n * Controls how child elements are distributed along the main axis.\n *\n * - `normal`: Default browser behavior.\n * - `space-between`: Distributes children evenly with no space at the edges.\n * - `space-around`: Distributes children evenly with equal space around each.\n * - `space-evenly`: Distributes children with equal space between and at the edges.\n * - `stretch`: Stretches children to fill the available space.\n * - `center`: Packs children toward the center.\n * - `start`: Packs children toward the start of the main axis.\n * - `end`: Packs children toward the end of the main axis.\n *\n * @default 'normal'\n */\n justifyContent?: MaybeResponsive>;\n}" + } + }, + "StackProps": { + "src/surfaces/checkout/components/Stack.ts": { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "name": "StackProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive>", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive>", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "MaybeResponsive<\"block\" | \"inline\">", + "description": "The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `block`: Children are stacked vertically (in horizontal writing modes). Content does not wrap.\n- `inline`: Children are arranged horizontally (in horizontal writing modes). Content wraps when it overflows.", + "isOptional": true, + "defaultValue": "'block'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive>", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + } + ], + "value": "export interface StackProps extends StackElementProps {\n}" + } + }, + "StackElement": { + "src/surfaces/checkout/components/Stack.ts": { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "name": "StackElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "string", + "description": "A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityRole", + "value": "'aside' | 'footer' | 'header' | 'main' | 'section' | 'status' | 'none' | 'navigation' | 'ordered-list' | 'list-item' | 'list-item-separator' | 'unordered-list' | 'separator' | 'alert' | 'generic'", + "description": "The semantic meaning of the stack's content, used by assistive technologies.\n\n- `aside`: Supporting content related to the main content.\n- `footer`: Information such as copyright, navigation links, and privacy statements.\n- `header`: A page or section header.\n- `main`: The primary content of the page.\n- `section`: A generic section that should have a heading or `accessibilityLabel`.\n- `status`: A live region with advisory information that is not urgent.\n- `none`: Strips semantic meaning while keeping visual styling.\n- `navigation`: A major group of navigation links.\n- `ordered-list`: A list of ordered items.\n- `list-item`: An item inside a list.\n- `list-item-separator`: A divider between list items.\n- `unordered-list`: A list of unordered items.\n- `separator`: A divider that separates sections of content.\n- `alert`: Important, usually time-sensitive information.\n- `generic`: A nameless container with no semantic meaning (renders a `
`).", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "alignContent", + "value": "MaybeResponsive>", + "description": "Controls how lines of content are distributed along the cross axis when there is extra space.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes lines evenly with no space at the edges.\n- `space-around`: Distributes lines evenly with equal space around each.\n- `space-evenly`: Distributes lines with equal space between and at the edges.\n- `stretch`: Stretches lines to fill the available space.\n- `center`: Packs lines toward the center.\n- `start`: Packs lines toward the start of the cross axis.\n- `end`: Packs lines toward the end of the cross axis.", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "alignItems", + "value": "MaybeResponsive>", + "description": "Controls how child elements are aligned along the cross axis.\n\n- `normal`: Default browser behavior.\n- `stretch`: Stretches children to fill the cross axis.\n- `center`: Centers children along the cross axis.\n- `start`: Aligns children to the start of the cross axis.\n- `end`: Aligns children to the end of the cross axis.", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "background", + "value": "'base' | 'subdued' | 'transparent'", + "description": "The background color of the stack.\n\n- `base`: The standard background color for general content areas.\n- `subdued`: A muted background for secondary or supporting content.\n- `transparent`: No background color (the default).", + "isOptional": true, + "defaultValue": "'transparent'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "blockSize", + "value": "MaybeResponsive", + "description": "The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "border", + "value": "BorderShorthand", + "description": "A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "borderRadius", + "value": "MaybeAllValuesShorthandProperty>", + "description": "The roundedness of the stack's corners.\n\n- `none`: Sharp corners with no rounding.\n- `small-100` / `small`: Subtle rounding for compact elements.\n- `base`: Standard rounding for most use cases.\n- `large` / `large-100`: More pronounced rounding for prominent containers.\n- `max`: Maximum rounding, creating a pill or circular shape.\n\nSupports 1-to-4-value shorthand syntax for specifying different radii per corner.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "borderStyle", + "value": "MaybeAllValuesShorthandProperty | \"\"", + "description": "Controls the visual style of the border on all sides, such as solid, dashed, or dotted.\n\nWhen set, this overrides the style value specified in the `border` property.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side:\n- One value: applies to all sides\n- Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively\n- Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively\n- Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "borderWidth", + "value": "MaybeAllValuesShorthandProperty | ''", + "description": "The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "columnGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "direction", + "value": "MaybeResponsive<\"block\" | \"inline\">", + "description": "The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).\n\n- `block`: Children are stacked vertically (in horizontal writing modes). Content does not wrap.\n- `inline`: Children are arranged horizontally (in horizontal writing modes). Content wraps when it overflows.", + "isOptional": true, + "defaultValue": "'block'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "gap", + "value": "MaybeResponsive>", + "description": "The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "inlineSize", + "value": "MaybeResponsive", + "description": "The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).\n\n- `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.\n- `auto`: Automatically sizes based on content and layout constraints.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "justifyContent", + "value": "MaybeResponsive>", + "description": "Controls how child elements are distributed along the main axis.\n\n- `normal`: Default browser behavior.\n- `space-between`: Distributes children evenly with no space at the edges.\n- `space-around`: Distributes children evenly with equal space around each.\n- `space-evenly`: Distributes children with equal space between and at the edges.\n- `stretch`: Stretches children to fill the available space.\n- `center`: Packs children toward the center.\n- `start`: Packs children toward the start of the main axis.\n- `end`: Packs children toward the end of the main axis.", + "isOptional": true, + "defaultValue": "'normal'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "maxBlockSize", + "value": "MaybeResponsive", + "description": "The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "maxInlineSize", + "value": "MaybeResponsive", + "description": "The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "minBlockSize", + "value": "MaybeResponsive", + "description": "The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "minInlineSize", + "value": "MaybeResponsive", + "description": "The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).", + "isOptional": true, + "defaultValue": "'0'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "overflow", + "value": "'hidden' | 'visible'", + "description": "The overflow behavior of the element.\n\n- `visible`: Content that extends beyond the container is visible.\n- `hidden`: Content that extends beyond the container is clipped and not scrollable.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "padding", + "value": "MaybeResponsive>", + "description": "The padding applied to all edges of the component.\n\nSupports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:\n- 1 value applies to all sides\n- 2 values apply to block (top/bottom) and inline (left/right)\n- 3 values apply to block-start (top), inline (left/right), and block-end (bottom)\n- 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)\n\n**Examples:** `base`, `large none`, `base large-100 base small`\n\nUse `auto` to inherit padding from the nearest container with removed padding.", + "isOptional": true, + "defaultValue": "'none'" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlock", + "value": "MaybeResponsive | \"\">", + "description": "The block-direction padding (top and bottom in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for block-start and block-end.\n\n**Example:** `large none` applies `large` to the top and `none` to the bottom.\n\nOverrides the block value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockEnd", + "value": "MaybeResponsive", + "description": "The block-end padding (bottom in horizontal writing modes).\n\nOverrides the block-end value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingBlockStart", + "value": "MaybeResponsive", + "description": "The block-start padding (top in horizontal writing modes).\n\nOverrides the block-start value from `paddingBlock`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInline", + "value": "MaybeResponsive | \"\">", + "description": "The inline-direction padding (left and right in horizontal writing modes).\n\nAccepts a single value for both sides or two space-separated values for inline-start and inline-end.\n\n**Example:** `large none` applies `large` to the left and `none` to the right.\n\nOverrides the inline value from `padding`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineEnd", + "value": "MaybeResponsive", + "description": "The inline-end padding (right in LTR writing modes, left in RTL).\n\nOverrides the inline-end value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "paddingInlineStart", + "value": "MaybeResponsive", + "description": "The inline-start padding (left in LTR writing modes, right in RTL).\n\nOverrides the inline-start value from `paddingInline`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "rowGap", + "value": "MaybeResponsive", + "description": "The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.", + "isOptional": true, + "defaultValue": "'' - meaning no override" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Stack.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface StackElement extends StackElementProps, Omit {\n}" + } + }, + "SummaryElementProps": { + "src/surfaces/checkout/components/Summary.ts": { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "name": "SummaryElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface SummaryElementProps extends Pick {\n}" + } + }, + "SummaryElement": { + "src/surfaces/checkout/components/Summary.ts": { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "name": "SummaryElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface SummaryElement extends SummaryElementProps, Omit {\n}" + } + }, + "SummaryProps": { + "src/surfaces/checkout/components/Summary.ts": { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "name": "SummaryProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Summary.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface SummaryProps extends SummaryElementProps {\n}" + } + }, + "SwitchElementProps": { + "src/surfaces/checkout/components/Switch.ts": { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "name": "SwitchElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface SwitchElementProps extends Pick {\n command?: Extract;\n}" + } + }, + "SwitchEvents": { + "src/surfaces/checkout/components/Switch.ts": { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "name": "SwitchEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed.", + "isOptional": true + } + ], + "value": "export interface SwitchEvents extends Pick {\n}" + } + }, + "SwitchElementEvents": { + "src/surfaces/checkout/components/Switch.ts": { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "name": "SwitchElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the switch value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + } + ], + "value": "export interface SwitchElementEvents {\n /**\n * A callback fired when the switch value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n}" + } + }, + "SwitchElement": { + "src/surfaces/checkout/components/Switch.ts": { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "name": "SwitchElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface SwitchElement extends SwitchElementProps, Omit {\n onchange: SwitchEvents['onChange'];\n}" + } + }, + "SwitchProps": { + "src/surfaces/checkout/components/Switch.ts": { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "name": "SwitchProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityLabel", + "value": "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.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "checked", + "value": "boolean", + "description": "Whether the control is currently checked.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "command", + "value": "'--auto' | '--show' | '--hide' | '--toggle'", + "description": "Sets the action the `commandFor` target should take when this component is activated. Available options:\n\n- `'--auto'`: Performs the default action appropriate for the target component.\n- `'--show'`: Displays the target component if it's currently hidden.\n- `'--hide'`: Conceals the target component from view.\n- `'--toggle'`: Alternates the target component between visible and hidden states.\n- `'--copy'`: Copies the target clipboard item.\n\nThe supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command).", + "isOptional": true, + "defaultValue": "'--auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "commandFor", + "value": "string", + "description": "The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).\n\nWhen both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "defaultChecked", + "value": "boolean", + "description": "Whether the control is checked by default.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the control is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback that is run whenever the control is changed.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Switch.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The value used in form data when the control is checked.", + "isOptional": true + } + ], + "value": "export interface SwitchProps extends SwitchElementProps, SwitchEvents {\n}" + } + }, + "TextElementProps": { + "src/surfaces/checkout/components/Text.ts": { + "filePath": "src/surfaces/checkout/components/Text.ts", + "name": "TextElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "'base' | 'subdued'", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Higher-contrast color for text that needs more emphasis than `base`.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "'ltr' | 'rtl' | 'auto' | ''", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `caution`: Advisory notices that need attention.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `accent`: Highlighted or promotional content.\n- `custom`: Custom styling controlled by your theme.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'small' | 'address' | 'mark' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant. One such use-case is discounted prices.\n- `mark`: A semantic type that indicates the text is marked or highlighted and relevant to the user's current action.\n- `emphasis`: A semantic type that indicates emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text.\n- `offset`: A semantic type that indicates an offset from the normal prose of the text.\n- `small`: A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `generic`: No additional semantics or styling is applied.", + "isOptional": true, + "defaultValue": "'generic'" + } + ], + "value": "export interface TextElementProps extends Pick {\n color?: Extract;\n tone?: Extract;\n /**\n * The semantic type and styling treatment for the text content.\n *\n * Other presentation properties on `s-text` override the default styling.\n *\n * - `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n * - `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant. One such use-case is discounted prices.\n * - `mark`: A semantic type that indicates the text is marked or highlighted and relevant to the user's current action.\n * - `emphasis`: A semantic type that indicates emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text.\n * - `offset`: A semantic type that indicates an offset from the normal prose of the text.\n * - `small`: A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand.\n * - `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n * - `generic`: No additional semantics or styling is applied.\n *\n * @default 'generic'\n */\n type?: Extract;\n}" + } + }, + "TextElement": { + "src/surfaces/checkout/components/Text.ts": { + "filePath": "src/surfaces/checkout/components/Text.ts", + "name": "TextElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "'base' | 'subdued'", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Higher-contrast color for text that needs more emphasis than `base`.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "'ltr' | 'rtl' | 'auto' | ''", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `caution`: Advisory notices that need attention.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `accent`: Highlighted or promotional content.\n- `custom`: Custom styling controlled by your theme.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'small' | 'address' | 'mark' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant. One such use-case is discounted prices.\n- `mark`: A semantic type that indicates the text is marked or highlighted and relevant to the user's current action.\n- `emphasis`: A semantic type that indicates emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text.\n- `offset`: A semantic type that indicates an offset from the normal prose of the text.\n- `small`: A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `generic`: No additional semantics or styling is applied.", + "isOptional": true, + "defaultValue": "'generic'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface TextElement extends TextElementProps, Omit {\n}" + } + }, + "TextProps": { + "src/surfaces/checkout/components/Text.ts": { + "filePath": "src/surfaces/checkout/components/Text.ts", + "name": "TextProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "accessibilityVisibility", + "value": "'visible' | 'hidden' | 'exclusive'", + "description": "Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.\n\n- `visible`: The element is visible to all users (both sighted users and screen readers).\n- `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.\n- `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "color", + "value": "'base' | 'subdued'", + "description": "The color emphasis level that controls visual intensity.\n\n- `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.\n- `base`: Primary color for body text, standard UI elements, and general content with good readability.\n- `strong`: Higher-contrast color for text that needs more emphasis than `base`.", + "isOptional": true, + "defaultValue": "'base'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "'ltr' | 'rtl' | 'auto' | ''", + "description": "Indicates the directionality of the element’s text.\n\n- `ltr`: The languages written from left to right (such as English).\n- `rtl`: The languages written from right to left (such as Arabic).\n- `auto`: The user agent determines the direction based on the content.\n- `\"\"`: The direction is inherited from parent elements (equivalent to not setting the attribute).\n\nLearn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "display", + "value": "MaybeResponsive<\"auto\" | \"none\">", + "description": "Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).\n\n- `auto`: The component’s initial value. The actual value depends on the component and context.\n- `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.\n\nLearn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.\n\nThe value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).\n\nIt is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "tone", + "value": "'custom' | 'success' | 'info' | 'auto' | 'neutral' | 'warning' | 'critical'", + "description": "The semantic meaning and color treatment of the component.\n\n- `auto`: Automatically determined based on context.\n- `neutral`: General information without specific intent.\n- `info`: Informational content or helpful tips.\n- `success`: Positive outcomes or successful states.\n- `caution`: Advisory notices that need attention.\n- `warning`: Important warnings about potential issues.\n- `critical`: Urgent problems or destructive actions.\n- `accent`: Highlighted or promotional content.\n- `custom`: Custom styling controlled by your theme.", + "isOptional": true, + "defaultValue": "'auto'" + }, + { + "filePath": "src/surfaces/checkout/components/Text.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'small' | 'address' | 'mark' | 'strong' | 'generic' | 'redundant' | 'emphasis' | 'offset'", + "description": "The semantic type and styling treatment for the text content.\n\nOther presentation properties on `s-text` override the default styling.\n\n- `address`: A semantic type that indicates the text is contact information. Typically used for addresses.\n- `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant. One such use-case is discounted prices.\n- `mark`: A semantic type that indicates the text is marked or highlighted and relevant to the user's current action.\n- `emphasis`: A semantic type that indicates emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text.\n- `offset`: A semantic type that indicates an offset from the normal prose of the text.\n- `small`: A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand.\n- `strong`: A semantic type that indicates strong importance, seriousness, or urgency.\n- `generic`: No additional semantics or styling is applied.", + "isOptional": true, + "defaultValue": "'generic'" + } + ], + "value": "export interface TextProps extends TextElementProps {\n}" + } + }, + "TextAreaElementProps": { + "src/surfaces/checkout/components/TextArea.ts": { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "name": "TextAreaElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "rows", + "value": "number", + "description": "A number of visible text lines.", + "isOptional": true, + "defaultValue": "2" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface TextAreaElementProps extends Pick {\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + } + }, + "TextAreaEvents": { + "src/surfaces/checkout/components/TextArea.ts": { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "name": "TextAreaEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + } + ], + "value": "export interface TextAreaEvents extends Pick {\n}" + } + }, + "TextAreaElementEvents": { + "src/surfaces/checkout/components/TextArea.ts": { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "name": "TextAreaElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the text area loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the text area value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the text area receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the text area.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface TextAreaElementEvents {\n /**\n * A callback fired when the text area loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the text area value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the text area receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text area.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + } + }, + "TextAreaElement": { + "src/surfaces/checkout/components/TextArea.ts": { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "name": "TextAreaElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "rows", + "value": "number", + "description": "A number of visible text lines.", + "isOptional": true, + "defaultValue": "2" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface TextAreaElement extends TextAreaElementProps, Omit {\n onblur: TextAreaEvents['onBlur'];\n onchange: TextAreaEvents['onChange'];\n onfocus: TextAreaEvents['onFocus'];\n oninput: TextAreaEvents['onInput'];\n}" + } + }, + "TextAreaProps": { + "src/surfaces/checkout/components/TextArea.ts": { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "name": "TextAreaProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "rows", + "value": "number", + "description": "A number of visible text lines.", + "isOptional": true, + "defaultValue": "2" + }, + { + "filePath": "src/surfaces/checkout/components/TextArea.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface TextAreaProps extends TextAreaElementProps, TextAreaEvents {\n}" + } + }, + "TextFieldElementProps": { + "src/surfaces/checkout/components/TextField.ts": { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "name": "TextFieldElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconProps['type']", + "description": "The type of icon to be displayed in the field.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "string", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface TextFieldElementProps extends Pick {\n icon?: IconProps['type'];\n /**\n * @deprecated Use `label` instead.\n * @private\n */\n placeholder?: string;\n}" + } + }, + "TextFieldEvents": { + "src/surfaces/checkout/components/TextField.ts": { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "name": "TextFieldEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + } + ], + "value": "export interface TextFieldEvents extends Pick {\n}" + } + }, + "TextFieldElementEvents": { + "src/surfaces/checkout/components/TextField.ts": { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "name": "TextFieldElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the text field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the text field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the text field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the text field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface TextFieldElementEvents {\n /**\n * A callback fired when the text field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the text field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the text field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the text field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + } + }, + "TextFieldElementSlots": { + "src/surfaces/checkout/components/TextField.ts": { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "name": "TextFieldElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface TextFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "TextFieldElement": { + "src/surfaces/checkout/components/TextField.ts": { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "name": "TextFieldElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconProps['type']", + "description": "The type of icon to be displayed in the field.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "string", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface TextFieldElement extends TextFieldElementProps, Omit {\n onblur: TextFieldEvents['onBlur'];\n onchange: TextFieldEvents['onChange'];\n onfocus: TextFieldEvents['onFocus'];\n oninput: TextFieldEvents['onInput'];\n}" + } + }, + "TextFieldProps": { + "src/surfaces/checkout/components/TextField.ts": { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "name": "TextFieldProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "icon", + "value": "IconProps['type']", + "description": "The type of icon to be displayed in the field.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "placeholder", + "value": "string", + "description": "", + "isOptional": true, + "deprecationMessage": "Use `label` instead.", + "isPrivate": true + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string", + "description": "A value to be displayed immediately before the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"https://\" or \"+353\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "suffix", + "value": "string", + "description": "A value to be displayed immediately after the editable portion of the field.\n\nThis is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\".\n\nThis can't be edited by the user, and it isn't included in the value of the field.\n\nIt 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.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/TextField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface TextFieldProps extends TextFieldElementProps, TextFieldEvents {\n}" + } + }, + "TimeElementProps": { + "src/surfaces/checkout/components/Time.ts": { + "filePath": "src/surfaces/checkout/components/Time.ts", + "name": "TimeElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "dateTime", + "value": "string", + "description": "The machine-readable date and/or time value for the element. Use this to provide a datetime string that browsers, search engines, and assistive technologies can parse for improved semantics and functionality.\n\nThe value must be a [valid datetime string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values), such as `2024-01-15`, `14:30`, or `2024-01-15T14:30:00`.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface TimeElementProps extends Pick {\n}" + } + }, + "TimeElement": { + "src/surfaces/checkout/components/Time.ts": { + "filePath": "src/surfaces/checkout/components/Time.ts", + "name": "TimeElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "dateTime", + "value": "string", + "description": "The machine-readable date and/or time value for the element. Use this to provide a datetime string that browsers, search engines, and assistive technologies can parse for improved semantics and functionality.\n\nThe value must be a [valid datetime string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values), such as `2024-01-15`, `14:30`, or `2024-01-15T14:30:00`.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface TimeElement extends TimeElementProps, Omit {\n}" + } + }, + "TimeProps": { + "src/surfaces/checkout/components/Time.ts": { + "filePath": "src/surfaces/checkout/components/Time.ts", + "name": "TimeProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "dateTime", + "value": "string", + "description": "The machine-readable date and/or time value for the element. Use this to provide a datetime string that browsers, search engines, and assistive technologies can parse for improved semantics and functionality.\n\nThe value must be a [valid datetime string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values), such as `2024-01-15`, `14:30`, or `2024-01-15T14:30:00`.", + "isOptional": true, + "defaultValue": "''" + }, + { + "filePath": "src/surfaces/checkout/components/Time.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface TimeProps extends TimeElementProps {\n}" + } + }, + "TooltipElementProps": { + "src/surfaces/checkout/components/Tooltip.ts": { + "filePath": "src/surfaces/checkout/components/Tooltip.ts", + "name": "TooltipElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/Tooltip.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface TooltipElementProps extends Pick {\n}" + } + }, + "TooltipElement": { + "src/surfaces/checkout/components/Tooltip.ts": { + "filePath": "src/surfaces/checkout/components/Tooltip.ts", + "name": "TooltipElement", + "description": "The HTML element interface for the `s-tooltip` custom element.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Tooltip.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface TooltipElement extends TooltipElementProps {\n}" + } + }, + "TooltipProps": { + "src/surfaces/checkout/components/Tooltip.ts": { + "filePath": "src/surfaces/checkout/components/Tooltip.ts", + "name": "TooltipProps", + "description": "The properties for the tooltip component when it's used in JSX.", + "members": [ + { + "filePath": "src/surfaces/checkout/components/Tooltip.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface TooltipProps extends TooltipElementProps {\n}" + } + }, + "UnorderedListElementProps": { + "src/surfaces/checkout/components/UnorderedList.ts": { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "name": "UnorderedListElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface UnorderedListElementProps extends UnorderedListProps$1 {\n}" + } + }, + "UnorderedListElement": { + "src/surfaces/checkout/components/UnorderedList.ts": { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "name": "UnorderedListElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "((this: GlobalEventHandlers, ev: FocusEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "prefix", + "value": "string | null", + "description": "The **`Element.prefix`** read-only property returns the namespace prefix of the specified element, or `null` if no prefix is specified.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface UnorderedListElement extends UnorderedListElementProps, Omit {\n}" + } + }, + "UnorderedListProps": { + "src/surfaces/checkout/components/UnorderedList.ts": { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "name": "UnorderedListProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/UnorderedList.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + } + ], + "value": "export interface UnorderedListProps extends UnorderedListElementProps {\n}" + } + }, + "URLFieldElementProps": { + "src/surfaces/checkout/components/UrlField.ts": { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "name": "URLFieldElementProps", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface URLFieldElementProps extends Pick {\n}" + } + }, + "UrlFieldEvents": { + "src/surfaces/checkout/components/UrlField.ts": { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "name": "UrlFieldEvents", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + } + ], + "value": "export interface UrlFieldEvents extends Pick {\n}" + } + }, + "URLFieldElementEvents": { + "src/surfaces/checkout/components/UrlField.ts": { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "name": "URLFieldElementEvents", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "blur", + "value": "CallbackEventListener", + "description": "A callback fired when the URL field loses focus.\n\nLearn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "change", + "value": "CallbackEventListener", + "description": "A callback fired when the URL field value changes.\n\nLearn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "focus", + "value": "CallbackEventListener", + "description": "A callback fired when the URL field receives focus.\n\nLearn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "input", + "value": "CallbackEventListener", + "description": "A callback fired when the user inputs data into the URL field.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).", + "isOptional": true + } + ], + "value": "export interface URLFieldElementEvents {\n /**\n * A callback fired when the URL field loses focus.\n *\n * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).\n */\n blur?: CallbackEventListener;\n /**\n * A callback fired when the URL field value changes.\n *\n * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).\n */\n change?: CallbackEventListener;\n /**\n * A callback fired when the URL field receives focus.\n *\n * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).\n */\n focus?: CallbackEventListener;\n /**\n * A callback fired when the user inputs data into the URL field.\n *\n * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event).\n */\n input?: CallbackEventListener;\n}" + } + }, + "URLFieldElementSlots": { + "src/surfaces/checkout/components/UrlField.ts": { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "name": "URLFieldElementSlots", + "description": "", + "isPublicDocs": true, + "members": [ + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "accessory", + "value": "HTMLElement", + "description": "Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.", + "isOptional": true + } + ], + "value": "export interface URLFieldElementSlots {\n /**\n * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.\n */\n accessory?: HTMLElement;\n}" + } + }, + "UrlFieldElement": { + "src/surfaces/checkout/components/UrlField.ts": { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "name": "UrlFieldElement", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKey", + "value": "string", + "description": "The **`HTMLElement.accessKey`** property sets the keystroke which a user can press to jump to a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "accessKeyLabel", + "value": "string", + "description": "The **`HTMLElement.accessKeyLabel`** read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "addEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; }", + "description": "\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)\n\nThe **`addEventListener()`** method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "after", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/after)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "animate", + "value": "(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions) => Animation", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animate)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "append", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "appendChild", + "value": "(node: T) => T", + "description": "The **`appendChild()`** method of the Node interface adds a node to the end of the list of children of a specified parent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaActiveDescendantElement", + "value": "Element | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaActiveDescendantElement)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAtomic", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAtomic)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaAutoComplete", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaAutoComplete)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBrailleRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBrailleRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaBusy", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaBusy)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaChecked", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaChecked)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColCount)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaColSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaColSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaControlsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaControlsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaCurrent", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaCurrent)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescribedByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDetailsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDetailsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaDisabled", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaDisabled)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaErrorMessageElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaErrorMessageElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaExpanded", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaExpanded)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaFlowToElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaFlowToElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHasPopup", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHasPopup)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaHidden", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaHidden)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaInvalid", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaInvalid)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaKeyShortcuts", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaKeyShortcuts)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabel)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLabelledByElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLevel", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLevel)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaLive", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaLive)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaModal", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaModal)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiLine", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiLine)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaMultiSelectable", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaMultiSelectable)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOrientation", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOrientation)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaOwnsElements", + "value": "ReadonlyArray | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaOwnsElements)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPlaceholder", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPlaceholder)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPosInSet", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPosInSet)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaPressed", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaPressed)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaReadOnly", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaReadOnly)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRelevant", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRelevant)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRequired", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRequired)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRoleDescription", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRoleDescription)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowCount", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowCount)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndex", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowIndexText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowIndexText)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaRowSpan", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaRowSpan)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSelected", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSelected)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSetSize", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSetSize)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaSort", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaSort)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMax", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMax)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueMin", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueMin)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueNow", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueNow)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ariaValueText", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/ariaValueText)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "assignedSlot", + "value": "HTMLSlotElement | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "attachInternals", + "value": "() => ElementInternals", + "description": "The **`HTMLElement.attachInternals()`** method returns an ElementInternals object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "attachShadow", + "value": "(init: ShadowRootInit) => ShadowRoot", + "description": "The **`Element.attachShadow()`** method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ATTRIBUTE_NODE", + "value": "2", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "attributes", + "value": "NamedNodeMap", + "description": "The **`Element.attributes`** property returns a live collection of all attribute nodes registered to the specified node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "attributeStyleMap", + "value": "StylePropertyMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "autocapitalize", + "value": "string", + "description": "The **`autocapitalize`** property of the HTMLElement interface represents the element's capitalization behavior for user input.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "autocorrect", + "value": "boolean", + "description": "The **`autocorrect`** property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "autofocus", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "baseURI", + "value": "string", + "description": "The read-only **`baseURI`** property of the Node interface returns the absolute base URL of the document containing the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "before", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/before)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "blur", + "value": "() => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "CDATA_SECTION_NODE", + "value": "4", + "description": "node is a CDATASection node." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "checkVisibility", + "value": "(options?: CheckVisibilityOptions) => boolean", + "description": "The **`checkVisibility()`** method of the Element interface checks whether the element is visible.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "childElementCount", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "childNodes", + "value": "NodeListOf", + "description": "The read-only **`childNodes`** property of the Node interface returns a live the first child node is assigned index `0`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "children", + "value": "HTMLCollection", + "description": "Returns the child elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "GetAccessor", + "name": "classList", + "value": "DOMTokenList", + "description": "The **`Element.classList`** is a read-only property that returns a live DOMTokenList collection of the `class` attributes of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "className", + "value": "string", + "description": "The **`className`** property of the of the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "click", + "value": "() => void", + "description": "The **`HTMLElement.click()`** method simulates a mouse click on an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "clientHeight", + "value": "number", + "description": "The **`clientHeight`** read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "clientLeft", + "value": "number", + "description": "The **`clientLeft`** read-only property of the Element interface returns the width of the left border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "clientTop", + "value": "number", + "description": "The **`clientTop`** read-only property of the Element interface returns the width of the top border of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "clientWidth", + "value": "number", + "description": "The **`clientWidth`** read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "cloneNode", + "value": "(subtree?: boolean) => Node", + "description": "The **`cloneNode()`** method of the Node interface returns a duplicate of the node on which this method was called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "closest", + "value": "{ (selector: K): HTMLElementTagNameMap[K]; (selector: K): SVGElementTagNameMap[K]; (selector: K): MathMLElementTagNameMap[K]; (selectors: string): E; }", + "description": "The **`closest()`** method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "COMMENT_NODE", + "value": "8", + "description": "node is a Comment node." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "compareDocumentPosition", + "value": "(other: Node) => number", + "description": "The **`compareDocumentPosition()`** method of the Node interface reports the position of its argument node relative to the node on which it is called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "computedStyleMap", + "value": "() => StylePropertyMapReadOnly", + "description": "The **`computedStyleMap()`** method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "contains", + "value": "(other: Node) => boolean", + "description": "The **`contains()`** method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "contentEditable", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "currentCSSZoom", + "value": "number", + "description": "The **`currentCSSZoom`** read-only property of the Element interface provides the 'effective' CSS `zoom` of an element, taking into account the zoom applied to the element and all its parent elements.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "dataset", + "value": "DOMStringMap", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "dir", + "value": "string", + "description": "The **`HTMLElement.dir`** property indicates the text writing directionality of the content of the current element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "dispatchEvent", + "value": "(event: Event) => boolean", + "description": "The **`dispatchEvent()`** method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_FRAGMENT_NODE", + "value": "11", + "description": "node is a DocumentFragment node." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_NODE", + "value": "9", + "description": "node is a document." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINED_BY", + "value": "16", + "description": "Set when other is a descendant of node." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_CONTAINS", + "value": "8", + "description": "Set when other is an ancestor of node." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_DISCONNECTED", + "value": "1", + "description": "Set when node and other are not in the same tree." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_FOLLOWING", + "value": "4", + "description": "Set when other is following node." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC", + "value": "32", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_POSITION_PRECEDING", + "value": "2", + "description": "Set when other is preceding node." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "DOCUMENT_TYPE_NODE", + "value": "10", + "description": "node is a doctype." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "draggable", + "value": "boolean", + "description": "The **`draggable`** property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ELEMENT_NODE", + "value": "1", + "description": "node is an element." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "enterKeyHint", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_NODE", + "value": "6", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ENTITY_REFERENCE_NODE", + "value": "5", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "firstChild", + "value": "ChildNode | null", + "description": "The read-only **`firstChild`** property of the Node interface returns the node's first child in the tree, or `null` if the node has no children.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "firstElementChild", + "value": "Element | null", + "description": "Returns the first child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "focus", + "value": "(options?: FocusOptions) => void", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getAnimations", + "value": "(options?: GetAnimationsOptions) => Animation[]", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAnimations)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttribute", + "value": "(qualifiedName: string) => string", + "description": "The **`getAttribute()`** method of the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNames", + "value": "() => string[]", + "description": "The **`getAttributeNames()`** method of the array.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNode", + "value": "(qualifiedName: string) => Attr", + "description": "Returns the specified attribute of the specified element, as an Attr node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNodeNS", + "value": "(namespace: string, localName: string) => Attr", + "description": "The **`getAttributeNodeNS()`** method of the Element interface returns the namespaced Attr node of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getAttributeNS", + "value": "(namespace: string, localName: string) => string", + "description": "The **`getAttributeNS()`** method of the Element interface returns the string value of the attribute with the specified namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getBoundingClientRect", + "value": "() => DOMRect", + "description": "The **`Element.getBoundingClientRect()`** method returns a position relative to the viewport.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getClientRects", + "value": "() => DOMRectList", + "description": "The **`getClientRects()`** method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByClassName", + "value": "(classNames: string) => HTMLCollectionOf", + "description": "The Element method **`getElementsByClassName()`** returns a live specified class name or names.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagName", + "value": "{ (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: K): HTMLCollectionOf; (qualifiedName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagName()`** method returns a live All descendants of the specified element are searched, but not the element itself.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getElementsByTagNameNS", + "value": "{ (namespaceURI: \"http://www.w3.org/1999/xhtml\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/2000/svg\", localName: string): HTMLCollectionOf; (namespaceURI: \"http://www.w3.org/1998/Math/MathML\", localName: string): HTMLCollectionOf; (namespace: string, localName: string): HTMLCollectionOf; }", + "description": "The **`Element.getElementsByTagNameNS()`** method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getHTML", + "value": "(options?: GetHTMLOptions) => string", + "description": "The **`getHTML()`** method of the Element interface is used to serialize an element's DOM to an HTML string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "getRootNode", + "value": "(options?: GetRootNodeOptions) => Node", + "description": "The **`getRootNode()`** method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttribute", + "value": "(qualifiedName: string) => boolean", + "description": "The **`Element.hasAttribute()`** method returns a **Boolean** value indicating whether the specified element has the specified attribute or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributeNS", + "value": "(namespace: string, localName: string) => boolean", + "description": "The **`hasAttributeNS()`** method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "hasAttributes", + "value": "() => boolean", + "description": "The **`hasAttributes()`** method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "hasChildNodes", + "value": "() => boolean", + "description": "The **`hasChildNodes()`** method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "hasPointerCapture", + "value": "(pointerId: number) => boolean", + "description": "The **`hasPointerCapture()`** method of the pointer capture for the pointer identified by the given pointer ID.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "hidden", + "value": "boolean", + "description": "The HTMLElement property **`hidden`** reflects the value of the element's `hidden` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "hidePopover", + "value": "() => void", + "description": "The **`hidePopover()`** method of the HTMLElement interface hides a popover element (i.e., one that has a valid `popover` attribute) by removing it from the top layer and styling it with `display: none`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "inert", + "value": "boolean", + "description": "The HTMLElement property **`inert`** reflects the value of the element's `inert` attribute.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "innerHTML", + "value": "string", + "description": "The **`innerHTML`** property of the Element interface gets or sets the HTML or XML markup contained within the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "innerText", + "value": "string", + "description": "The **`innerText`** property of the HTMLElement interface represents the rendered text content of a node and its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "inputMode", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentElement", + "value": "(where: InsertPosition, element: Element) => Element", + "description": "The **`insertAdjacentElement()`** method of the relative to the element it is invoked upon.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentHTML", + "value": "(position: InsertPosition, string: string) => void", + "description": "The **`insertAdjacentHTML()`** method of the the resulting nodes into the DOM tree at a specified position.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "insertAdjacentText", + "value": "(where: InsertPosition, data: string) => void", + "description": "The **`insertAdjacentText()`** method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "insertBefore", + "value": "(node: T, child: Node) => T", + "description": "The **`insertBefore()`** method of the Node interface inserts a node before a _reference node_ as a child of a specified _parent node_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "isConnected", + "value": "boolean", + "description": "The read-only **`isConnected`** property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "isContentEditable", + "value": "boolean", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "isDefaultNamespace", + "value": "(namespace: string) => boolean", + "description": "The **`isDefaultNamespace()`** method of the Node interface accepts a namespace URI as an argument.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "isEqualNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isEqualNode()`** method of the Node interface tests whether two nodes are equal.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "isSameNode", + "value": "(otherNode: Node) => boolean", + "description": "The **`isSameNode()`** method of the Node interface is a legacy alias the for the `===` strict equality operator.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "lang", + "value": "string", + "description": "The **`lang`** property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "lastChild", + "value": "ChildNode | null", + "description": "The read-only **`lastChild`** property of the Node interface returns the last child of the node, or `null` if there are no child nodes.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "lastElementChild", + "value": "Element | null", + "description": "Returns the last child that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "localName", + "value": "string", + "description": "The **`Element.localName`** read-only property returns the local part of the qualified name of an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupNamespaceURI", + "value": "(prefix: string) => string", + "description": "The **`lookupNamespaceURI()`** method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and `null` if not).\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "lookupPrefix", + "value": "(namespace: string) => string", + "description": "The **`lookupPrefix()`** method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and `null` if not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "matches", + "value": "(selectors: string) => boolean", + "description": "The **`matches()`** method of the Element interface tests whether the element would be selected by the specified CSS selector.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "namespaceURI", + "value": "string | null", + "description": "The **`Element.namespaceURI`** read-only property returns the namespace URI of the element, or `null` if the element is not in a namespace.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "nextElementSibling", + "value": "Element | null", + "description": "Returns the first following sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "nextSibling", + "value": "ChildNode | null", + "description": "The read-only **`nextSibling`** property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns `null` if the specified node is the last child in the parent element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeName", + "value": "string", + "description": "The read-only **`nodeName`** property of Node returns the name of the current node as a string.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeType", + "value": "number", + "description": "The read-only **`nodeType`** property of a Node interface is an integer that identifies what the node is.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "nodeValue", + "value": "string | null", + "description": "The **`nodeValue`** property of the Node interface returns or sets the value of the current node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "nonce", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "normalize", + "value": "() => void", + "description": "The **`normalize()`** method of the Node interface puts the specified node and all of its sub-tree into a _normalized_ form.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "NOTATION_NODE", + "value": "12", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetHeight", + "value": "number", + "description": "The **`offsetHeight`** read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetLeft", + "value": "number", + "description": "The **`offsetLeft`** read-only property of the HTMLElement interface returns the number of pixels that the _upper left corner_ of the current element is offset to the left within the HTMLElement.offsetParent node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetParent", + "value": "Element | null", + "description": "The **`HTMLElement.offsetParent`** read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetTop", + "value": "number", + "description": "The **`offsetTop`** read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the _closest positioned_ ancestor element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "offsetWidth", + "value": "number", + "description": "The **`offsetWidth`** read-only property of the HTMLElement interface returns the layout width of an element as an integer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onabort", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationcancel", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationend", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationiteration", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onanimationstart", + "value": "((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onauxclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforeinput", + "value": "((this: GlobalEventHandlers, ev: InputEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforematch", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforematch_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onbeforetoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onblur", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oncancel", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/cancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oncanplaythrough", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onchange", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onclick", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onclose", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextlost", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextlost_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextmenu", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oncontextrestored", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oncopy", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oncuechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oncut", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ondblclick", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrag", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragend", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragenter", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragleave", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragover", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ondragstart", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ondrop", + "value": "((this: GlobalEventHandlers, ev: DragEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ondurationchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onemptied", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onended", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onerror", + "value": "OnErrorEventHandler", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onfocus", + "value": "(event: FocusEvent) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onformdata", + "value": "((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenchange", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onfullscreenerror", + "value": "((this: Element, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ongotpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oninput", + "value": "(event: Event) => void", + "description": "" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "oninvalid", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeydown", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeypress", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "", + "deprecationMessage": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onkeyup", + "value": "((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onload", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/load_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadeddata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadedmetadata", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onloadstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onlostpointercapture", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousedown", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseenter", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseleave", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onmousemove", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseout", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseover", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onmouseup", + "value": "((this: GlobalEventHandlers, ev: MouseEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpaste", + "value": "((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpause", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onplay", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onplaying", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointercancel", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerdown", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerenter", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerleave", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointermove", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerout", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerover", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerrawupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "Available only in secure contexts.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerrawupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onpointerup", + "value": "((this: GlobalEventHandlers, ev: PointerEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onprogress", + "value": "((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onratechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onreset", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onresize", + "value": "((this: GlobalEventHandlers, ev: UIEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onscroll", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onscrollend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onsecuritypolicyviolation", + "value": "((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeked", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onseeking", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onselect", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectionchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onselectstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onslotchange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onstalled", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onsubmit", + "value": "((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onsuspend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontimeupdate", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontoggle", + "value": "((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/toggle_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchcancel", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchend", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchmove", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontouchstart", + "value": "((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event)", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitioncancel", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionend", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionrun", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ontransitionstart", + "value": "((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onvolumechange", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onwaiting", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationiteration", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationiteration`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkitanimationstart", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `onanimationstart`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onwebkittransitionend", + "value": "((this: GlobalEventHandlers, ev: Event) => any) | null", + "description": "", + "deprecationMessage": "This is a legacy alias of `ontransitionend`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onwheel", + "value": "((this: GlobalEventHandlers, ev: WheelEvent) => any) | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "outerHTML", + "value": "string", + "description": "The **`outerHTML`** attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "outerText", + "value": "string", + "description": "The **`outerText`** property of the HTMLElement interface returns the same value as HTMLElement.innerText.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "ownerDocument", + "value": "Document", + "description": "The read-only **`ownerDocument`** property of the Node interface returns the top-level document object of the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/ownerDocument)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "parentElement", + "value": "HTMLElement | null", + "description": "The read-only **`parentElement`** property of Node interface returns the DOM node's parent Element, or `null` if the node either has no parent, or its parent isn't a DOM Element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "parentNode", + "value": "ParentNode | null", + "description": "The read-only **`parentNode`** property of the Node interface returns the parent of the specified node in the DOM tree.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "GetAccessor", + "name": "part", + "value": "DOMTokenList", + "description": "The **`part`** property of the Element interface represents the part identifier(s) of the element (i.e., set using the `part` attribute), returned as a DOMTokenList.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "popover", + "value": "string | null", + "description": "The **`popover`** property of the HTMLElement interface gets and sets an element's popover state via JavaScript (`'auto'`, `'hint'`, or `'manual'`), and can be used for feature detection.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "prepend", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "previousElementSibling", + "value": "Element | null", + "description": "Returns the first preceding sibling that is an element, and null otherwise.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "previousSibling", + "value": "ChildNode | null", + "description": "The read-only **`previousSibling`** property of the Node interface returns the node immediately preceding the specified one in its parent's or `null` if the specified node is the first in that list.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "PROCESSING_INSTRUCTION_NODE", + "value": "7", + "description": "node is a ProcessingInstruction node." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelector", + "value": "{ (selectors: K): HTMLElementTagNameMap[K]; (selectors: K): SVGElementTagNameMap[K]; (selectors: K): MathMLElementTagNameMap[K]; (selectors: K): HTMLElementDeprecatedTagNameMap[K]; (selectors: string): E; }", + "description": "Returns the first element that is a descendant of node that matches selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "querySelectorAll", + "value": "{ (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: K): NodeListOf; (selectors: string): NodeListOf; }", + "description": "Returns all element descendants of node that match selectors.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)", + "deprecationMessage": "Deprecated" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "releasePointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`releasePointerCapture()`** method of the previously set for a specific (PointerEvent) _pointer_.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "remove", + "value": "() => void", + "description": "Removes node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/remove)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttribute", + "value": "(qualifiedName: string) => void", + "description": "The Element method **`removeAttribute()`** removes the attribute with the specified name from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`removeAttributeNode()`** method of the Element interface removes the specified Attr node from the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "removeAttributeNS", + "value": "(namespace: string, localName: string) => void", + "description": "The **`removeAttributeNS()`** method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "removeChild", + "value": "(child: T) => T", + "description": "The **`removeChild()`** method of the Node interface removes a child node from the DOM and returns the removed node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "removeEventListener", + "value": "{ (type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; }", + "description": "\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)\n\nThe **`removeEventListener()`** method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChild", + "value": "(node: Node, child: T) => T", + "description": "The **`replaceChild()`** method of the Node interface replaces a child node within the given (parent) node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceChildren", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "replaceWith", + "value": "(...nodes: (string | Node)[]) => void", + "description": "Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.\n\nThrows a \"HierarchyRequestError\" DOMException if the constraints of the node tree are violated.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/replaceWith)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "requestFullscreen", + "value": "(options?: FullscreenOptions) => Promise", + "description": "The **`Element.requestFullscreen()`** method issues an asynchronous request to make the element be displayed in fullscreen mode.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "requestPointerLock", + "value": "(options?: PointerLockOptions) => Promise", + "description": "The **`requestPointerLock()`** method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "role", + "value": "string | null", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/role)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "scroll", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scroll()`** method of the Element interface scrolls the element to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollBy", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollBy()`** method of the Element interface scrolls an element by the given amount.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollHeight", + "value": "number", + "description": "The **`scrollHeight`** read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollIntoView", + "value": "(arg?: boolean | ScrollIntoViewOptions) => void", + "description": "The Element interface's **`scrollIntoView()`** method scrolls the element's ancestor containers such that the element on which `scrollIntoView()` is called is visible to the user.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollLeft", + "value": "number", + "description": "The **`scrollLeft`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "scrollTo", + "value": "{ (options?: ScrollToOptions): void; (x: number, y: number): void; }", + "description": "The **`scrollTo()`** method of the Element interface scrolls to a particular set of coordinates inside a given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollTop", + "value": "number", + "description": "The **`scrollTop`** property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "scrollWidth", + "value": "number", + "description": "The **`scrollWidth`** read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttribute", + "value": "(qualifiedName: string, value: string) => void", + "description": "The **`setAttribute()`** method of the Element interface sets the value of an attribute on the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNode", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNode()`** method of the Element interface adds a new Attr node to the specified element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNodeNS", + "value": "(attr: Attr) => Attr", + "description": "The **`setAttributeNodeNS()`** method of the Element interface adds a new namespaced Attr node to an element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "setAttributeNS", + "value": "(namespace: string, qualifiedName: string, value: string) => void", + "description": "`setAttributeNS` adds a new attribute or changes the value of an attribute with the given namespace and name.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "setHTMLUnsafe", + "value": "(html: string) => void", + "description": "The **`setHTMLUnsafe()`** method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "setPointerCapture", + "value": "(pointerId: number) => void", + "description": "The **`setPointerCapture()`** method of the _capture target_ of future pointer events.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "shadowRoot", + "value": "ShadowRoot | null", + "description": "The `Element.shadowRoot` read-only property represents the shadow root hosted by the element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "showPopover", + "value": "() => void", + "description": "The **`showPopover()`** method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid `popover` attribute) by adding it to the top layer.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "slot", + "value": "string", + "description": "The **`slot`** property of the Element interface returns the name of the shadow DOM slot the element is inserted in.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "spellcheck", + "value": "boolean", + "description": "The **`spellcheck`** property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "GetAccessor", + "name": "style", + "value": "CSSStyleDeclaration", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "tabIndex", + "value": "number", + "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "tagName", + "value": "string", + "description": "The **`tagName`** read-only property of the Element interface returns the tag name of the element on which it's called.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "TEXT_NODE", + "value": "3", + "description": "node is a Text node." + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "GetAccessor", + "name": "textContent", + "value": "string", + "description": "[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "title", + "value": "string", + "description": "The **`HTMLElement.title`** property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "toggleAttribute", + "value": "(qualifiedName: string, force?: boolean) => boolean", + "description": "The **`toggleAttribute()`** method of the present and adding it if it is not present) on the given element.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "togglePopover", + "value": "(options?: boolean) => boolean", + "description": "The **`togglePopover()`** method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid `popover` attribute) between the hidden and showing states.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "translate", + "value": "boolean", + "description": "The **`translate`** property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "MethodSignature", + "name": "webkitMatchesSelector", + "value": "(selectors: string) => boolean", + "description": "", + "deprecationMessage": "This is a legacy alias of `matches`.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches)" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "writingSuggestions", + "value": "string", + "description": "The **`writingSuggestions`** property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/writingSuggestions)" + } + ], + "value": "export interface UrlFieldElement extends URLFieldElementProps, Omit {\n onblur: UrlFieldEvents['onBlur'];\n onchange: UrlFieldEvents['onChange'];\n onfocus: UrlFieldEvents['onFocus'];\n oninput: UrlFieldEvents['onInput'];\n}" + } + }, + "UrlFieldProps": { + "src/surfaces/checkout/components/UrlField.ts": { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "name": "UrlFieldProps", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "autocomplete", + "value": "AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | \"on\" | \"off\"", + "description": "A hint about the intended content of the field for browser autofill.\n\nWhen 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.\n\nWhen set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.\n\nAlternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.\n\nLearn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.", + "isOptional": true, + "defaultValue": "'on'" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "defaultValue", + "value": "string", + "description": "The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "disabled", + "value": "boolean", + "description": "Whether the field is disabled, preventing any user interaction.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "error", + "value": "string", + "description": "An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "label", + "value": "string", + "description": "The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "labelAccessibilityVisibility", + "value": "'visible' | 'exclusive'", + "description": "Controls whether the label is visible to all users or only to screen readers.\n\n- `visible`: The label is shown to everyone.\n- `exclusive`: The label is visually hidden but still announced by screen readers.", + "isOptional": true, + "defaultValue": "'visible'" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "maxLength", + "value": "number", + "description": "Specifies the maximum number of characters allowed.", + "isOptional": true, + "defaultValue": "Infinity" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "minLength", + "value": "number", + "description": "Specifies the minimum number of characters allowed.", + "isOptional": true, + "defaultValue": "0" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "name", + "value": "string", + "description": "The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onBlur", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onChange", + "value": "(event: Event) => void", + "description": "A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onFocus", + "value": "(event: FocusEvent) => void", + "description": "A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "onInput", + "value": "(event: Event) => void", + "description": "A callback fired when the user makes any changes in the field, such as typing a character.\n\nLearn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "readOnly", + "value": "boolean", + "description": "Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "required", + "value": "boolean", + "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.", + "isOptional": true, + "defaultValue": "false" + }, + { + "filePath": "src/surfaces/checkout/components/UrlField.ts", + "syntaxKind": "PropertySignature", + "name": "value", + "value": "string", + "description": "The current value for the field. If omitted, the field will be empty.", + "isOptional": true + } + ], + "value": "export interface UrlFieldProps extends URLFieldElementProps, UrlFieldEvents {\n}" + } + }, + "UseApiGeneratedType": { + "src/surfaces/checkout/preact/api.ts": { + "filePath": "src/surfaces/checkout/preact/api.ts", + "name": "UseApiGeneratedType", + "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Note: > As of version 2025-10, you no longer need this hook. The full API object is accessible via > the global `shopify` object.", + "isPublicDocs": true, + "params": [ + { + "name": "_target", + "description": "", + "value": "Target extends keyof RenderExtensionTargets", + "isOptional": true, + "filePath": "src/surfaces/checkout/preact/api.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/api.ts", + "description": "", + "name": "ApiForExtension", + "value": "ApiForExtension" + }, + "value": "export function useApi<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(_target?: Target): ApiForExtension {\n const api = (globalThis as any)?.shopify as ApiForExtension;\n\n if (!api) {\n throw new CheckoutUIExtensionError(\n 'You can only call this hook when running as a checkout UI extension on at least API version 2025-10.',\n );\n }\n return api;\n}" + } + }, + "UseExtensionApiGeneratedType": { + "src/surfaces/checkout/preact/api.ts": { + "filePath": "src/surfaces/checkout/preact/api.ts", + "name": "UseExtensionApiGeneratedType", + "description": "Returns the full API object that was passed in to your extension when it was created. Depending on the extension target, this object can contain different properties.\n\nFor example, the `purchase.checkout.cart-line-item.render-after` extension target will return the [CartLineDetailsApi](/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi) object. Other targets may only have access to the [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi) object, which contains a basic set of properties about the checkout.\n\nFor a full list of the API available to each extension target, see the [ExtensionTargets type](/docs/api/checkout-ui-extensions/apis/extensiontargets).\n\n> Caution: This is deprecated, use `useApi` instead.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/api.ts", + "description": "", + "name": "ApiForExtension", + "value": "ApiForExtension" + }, + "value": "export function useExtensionApi<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): ApiForExtension {\n return useApi();\n}" + } + }, + "UseSubscriptionGeneratedType": { + "src/surfaces/checkout/preact/subscription.ts": { + "filePath": "src/surfaces/checkout/preact/subscription.ts", + "name": "UseSubscriptionGeneratedType", + "description": "Subscribes to the special wrapper type that all \"changeable\" values in the checkout use. This hook extracts the most recent value from that object, and subscribes to update the value when changes occur in the checkout.\n\n> Note: > As of version 2025-10, you no longer need this hook. When you access `.value` > (instead of `.current`) on subscribable properties, Preact will automatically > re-render as `.value` changes.", + "isPublicDocs": true, + "params": [ + { + "name": "subscription", + "description": "", + "value": "SubscribableSignalLike", + "filePath": "src/surfaces/checkout/preact/subscription.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/subscription.ts", + "description": "", + "name": "Value", + "value": "Value" + }, + "value": "export function useSubscription(\n subscription: SubscribableSignalLike,\n): Value {\n const [, setValue] = useState(subscription.value);\n\n useEffect(() => {\n let didUnsubscribe = false;\n\n const checkForUpdates: Subscriber = (newValue) => {\n if (didUnsubscribe) {\n return;\n }\n\n setValue(newValue);\n };\n\n const unsubscribe = subscription.subscribe(checkForUpdates);\n\n // Because we're subscribing in a passive effect,\n // it's possible for an update to occur between render and the effect handler.\n // Check for this and schedule an update if work has occurred.\n checkForUpdates(subscription.value);\n\n return () => {\n didUnsubscribe = true;\n unsubscribe();\n };\n }, [subscription]);\n\n return subscription.value;\n}" + } + }, + "UseAppMetafieldsGeneratedType": { + "src/surfaces/checkout/preact/app-metafields.ts": { + "filePath": "src/surfaces/checkout/preact/app-metafields.ts", + "name": "UseAppMetafieldsGeneratedType", + "description": "Returns the metafields configured with `shopify.extension.toml`.", + "isPublicDocs": true, + "params": [ + { + "name": "filters", + "description": "", + "value": "AppMetafieldFilters", + "isOptional": true, + "defaultValue": "{}", + "filePath": "src/surfaces/checkout/preact/app-metafields.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/app-metafields.ts", + "description": "", + "name": "AppMetafieldEntry[]", + "value": "AppMetafieldEntry[]" + }, + "value": "export function useAppMetafields<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(filters: AppMetafieldFilters = {}): AppMetafieldEntry[] {\n const appMetafields = useSubscription(useApi().appMetafields);\n\n return useMemo(() => {\n if (filters.key && !filters.namespace) {\n throw new CheckoutUIExtensionError(\n 'You must pass in a namespace with a key',\n );\n }\n\n const filterKeys = Object.keys(filters) as AppMetafieldFilterKeys[];\n\n if (filterKeys.length) {\n return appMetafields.filter((app) => {\n return filterKeys.every((key) => {\n if (key === 'id' || key === 'type') {\n return app.target[key] === filters[key];\n }\n\n return app.metafield[key] === filters[key];\n });\n });\n }\n\n return appMetafields;\n }, [filters, appMetafields]);\n}" + } + }, + "AppMetafieldFilters": { + "src/surfaces/checkout/preact/app-metafields.ts": { + "filePath": "src/surfaces/checkout/preact/app-metafields.ts", + "name": "AppMetafieldFilters", + "description": "", + "members": [ + { + "filePath": "src/surfaces/checkout/preact/app-metafields.ts", + "syntaxKind": "PropertySignature", + "name": "id", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/preact/app-metafields.ts", + "syntaxKind": "PropertySignature", + "name": "key", + "value": "string", + "description": "", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/preact/app-metafields.ts", + "syntaxKind": "PropertySignature", + "name": "namespace", + "value": "string", + "description": "To filter for app owned metafields, use the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported.\n\nSee [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.", + "isOptional": true + }, + { + "filePath": "src/surfaces/checkout/preact/app-metafields.ts", + "syntaxKind": "PropertySignature", + "name": "type", + "value": "'customer' | 'product' | 'shop' | 'shopUser' | 'variant' | 'company' | 'companyLocation' | 'cart'", + "description": "", + "isOptional": true + } + ], + "value": "interface AppMetafieldFilters {\n id?: AppMetafieldEntryTarget['id'];\n type?: AppMetafieldEntryTarget['type'];\n /**\n * To filter for app owned metafields, use the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported.\n *\n * See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.\n */\n namespace?: Metafield['namespace'];\n key?: Metafield['key'];\n}" + } + }, + "UseAttributesGeneratedType": { + "src/surfaces/checkout/preact/attributes.ts": { + "filePath": "src/surfaces/checkout/preact/attributes.ts", + "name": "UseAttributesGeneratedType", + "description": "Returns the proposed `attributes` applied to the checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/attributes.ts", + "description": "", + "name": "Attribute[]", + "value": "Attribute[]" + }, + "value": "export function useAttributes<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Attribute[] {\n return useSubscription(useApi().attributes);\n}" + } + }, + "UseAttributeValuesGeneratedType": { + "src/surfaces/checkout/preact/attributes.ts": { + "filePath": "src/surfaces/checkout/preact/attributes.ts", + "name": "UseAttributeValuesGeneratedType", + "description": "Returns the values for the specified `attributes` applied to the checkout.", + "isPublicDocs": true, + "params": [ + { + "name": "keys", + "description": "An array of attribute keys.", + "value": "string[]", + "filePath": "src/surfaces/checkout/preact/attributes.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/attributes.ts", + "description": "", + "name": "(string | undefined)[]", + "value": "(string | undefined)[]" + }, + "value": "export function useAttributeValues<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(keys: string[]): (string | undefined)[] {\n const attributes = useAttributes();\n\n if (!attributes.length) {\n return [];\n }\n\n return keys.map((key) => {\n const attribute = attributes.find((attribute) => attribute.key === key);\n return attribute?.value;\n });\n}" + } + }, + "UseApplyAttributeChangeGeneratedType": { + "src/surfaces/checkout/preact/attributes.ts": { + "filePath": "src/surfaces/checkout/preact/attributes.ts", + "name": "UseApplyAttributeChangeGeneratedType", + "description": "Returns a function to mutate the `attributes` property of the checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/attributes.ts", + "description": "", + "name": "(change: AttributeChange) => Promise", + "value": "(change: AttributeChange) => Promise" + }, + "value": "export function useApplyAttributeChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: AttributeChange) => Promise {\n const api = useApi();\n\n if ('applyAttributeChange' in api) {\n return api.applyAttributeChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyAttributeChange',\n api.extension.target,\n );\n}" + } + }, + "UseBillingAddressGeneratedType": { + "src/surfaces/checkout/preact/billing-address.ts": { + "filePath": "src/surfaces/checkout/preact/billing-address.ts", + "name": "UseBillingAddressGeneratedType", + "description": "Returns the proposed `billingAddress` applied to the checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/billing-address.ts", + "description": "", + "name": "MailingAddress | undefined", + "value": "MailingAddress | undefined" + }, + "value": "export function useBillingAddress<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): MailingAddress | undefined {\n const billingAddress = useApi().billingAddress;\n\n if (!billingAddress) {\n throw new ScopeNotGrantedError(\n 'Using billing address requires having billing address permissions granted to your app.',\n );\n }\n\n return useSubscription(billingAddress);\n}" + } + }, + "UseCustomerGeneratedType": { + "src/surfaces/checkout/preact/buyer-identity.ts": { + "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", + "name": "UseCustomerGeneratedType", + "description": "Returns the current `Customer`.\n\nThe value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", + "description": "", + "name": "Customer | undefined", + "value": "Customer | undefined" + }, + "value": "export function useCustomer<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Customer | undefined {\n const buyerIdentity = useApi().buyerIdentity;\n\n if (!buyerIdentity) {\n throw new ScopeNotGrantedError(\n 'Using buyer identity requires having personal customer data permissions granted to your app.',\n );\n }\n\n return useSubscription(buyerIdentity.customer);\n}" + } + }, + "UseEmailGeneratedType": { + "src/surfaces/checkout/preact/buyer-identity.ts": { + "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", + "name": "UseEmailGeneratedType", + "description": "Returns the email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", + "description": "", + "name": "string | undefined", + "value": "string | undefined" + }, + "value": "export function useEmail<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): string | undefined {\n const buyerIdentity = useApi().buyerIdentity;\n\n if (!buyerIdentity) {\n throw new ScopeNotGrantedError(\n 'Using buyer identity requires having personal customer data permissions granted to your app.',\n );\n }\n\n return useSubscription(buyerIdentity.email);\n}" + } + }, + "UsePhoneGeneratedType": { + "src/surfaces/checkout/preact/buyer-identity.ts": { + "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", + "name": "UsePhoneGeneratedType", + "description": "Returns the phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", + "description": "", + "name": "string | undefined", + "value": "string | undefined" + }, + "value": "export function usePhone<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): string | undefined {\n const buyerIdentity = useApi().buyerIdentity;\n\n if (!buyerIdentity) {\n throw new ScopeNotGrantedError(\n 'Using buyer identity requires having personal customer data permissions granted to your app.',\n );\n }\n\n return useSubscription(buyerIdentity.phone);\n}" + } + }, + "UsePurchasingCompanyGeneratedType": { + "src/surfaces/checkout/preact/buyer-identity.ts": { + "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", + "name": "UsePurchasingCompanyGeneratedType", + "description": "Provides information about the company and its location that the business customer is purchasing on behalf of during a B2B checkout. It includes details that can be utilized to identify both the company and its corresponding location to which the business customer belongs.\n\nThe value is `undefined` if a business customer isn't logged in. This function throws an error if the app doesn't have access to customer data.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/buyer-identity.ts", + "description": "", + "name": "PurchasingCompany | undefined", + "value": "PurchasingCompany | undefined" + }, + "value": "export function usePurchasingCompany<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): PurchasingCompany | undefined {\n const buyerIdentity = useApi().buyerIdentity;\n\n if (!buyerIdentity) {\n throw new ScopeNotGrantedError(\n 'Using buyer identity requires having personal customer data permissions granted to your app.',\n );\n }\n\n return useSubscription(buyerIdentity.purchasingCompany);\n}" + } + }, + "UseBuyerJourneyGeneratedType": { + "src/surfaces/checkout/preact/buyer-journey.ts": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "name": "UseBuyerJourneyGeneratedType", + "description": "Returns the `buyerJourney` details on buyer progression in checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "description": "", + "name": "BuyerJourney", + "value": "BuyerJourney" + }, + "value": "export function useBuyerJourney<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): BuyerJourney {\n const api = useApi();\n\n return api.buyerJourney;\n}" + } + }, + "UseBuyerJourneyCompletedGeneratedType": { + "src/surfaces/checkout/preact/buyer-journey.ts": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "name": "UseBuyerJourneyCompletedGeneratedType", + "description": "Returns true if the buyer completed submitting their order.\n\nFor example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "description": "", + "name": "false | true", + "value": "false | true" + }, + "value": "export function useBuyerJourneyCompleted<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): boolean {\n const api = useApi();\n return useSubscription(api.buyerJourney.completed);\n}" + } + }, + "UseBuyerJourneyInterceptGeneratedType": { + "src/surfaces/checkout/preact/buyer-journey.ts": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "name": "UseBuyerJourneyInterceptGeneratedType", + "description": "Installs a function for intercepting and preventing progress on checkout.\n\nTo block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration.\n\nIf you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension.\n\n`useBuyerJourneyIntercept()` should be called at the top level of the extension, not within an embedded or child component, to avoid errors should the child component get destroyed.\n\nIt is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress.", + "isPublicDocs": true, + "params": [ + { + "name": "interceptor", + "description": "", + "value": "Interceptor", + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "description": "", + "name": "void", + "value": "void" + }, + "value": "export function useBuyerJourneyIntercept<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(interceptor: Interceptor): void {\n const api = useApi();\n\n const interceptorRef = useRef(interceptor);\n interceptorRef.current = interceptor;\n\n return useEffect(() => {\n const teardownPromise = api.buyerJourney.intercept((interceptorProps) =>\n interceptorRef.current(interceptorProps),\n );\n\n return () => {\n teardownPromise.then((teardown) => teardown()).catch(() => {});\n };\n }, [api.buyerJourney]);\n}" + } + }, + "UseBuyerJourneyStepsGeneratedType": { + "src/surfaces/checkout/preact/buyer-journey.ts": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "name": "UseBuyerJourneyStepsGeneratedType", + "description": "Returns all possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "description": "", + "name": "BuyerJourneyStep[]", + "value": "BuyerJourneyStep[]" + }, + "value": "export function useBuyerJourneySteps<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): BuyerJourneyStep[] {\n const api = useApi();\n\n if (!('buyerJourney' in api) || !api.buyerJourney) {\n throw new ExtensionHasNoMethodError('buyerJourney', api.extension.target);\n }\n\n return useSubscription(api.buyerJourney.steps);\n}" + } + }, + "UseBuyerJourneyActiveStepGeneratedType": { + "src/surfaces/checkout/preact/buyer-journey.ts": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "name": "UseBuyerJourneyActiveStepGeneratedType", + "description": "Returns the buyer journey step that the buyer is currently on.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/buyer-journey.ts", + "description": "", + "name": "BuyerJourneyStep | undefined", + "value": "BuyerJourneyStep | undefined" + }, + "value": "export function useBuyerJourneyActiveStep<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): BuyerJourneyStep | undefined {\n const api = useApi();\n\n if (!('buyerJourney' in api) || !api.buyerJourney) {\n throw new ExtensionHasNoMethodError('buyerJourney', api.extension.target);\n }\n\n const steps = useSubscription(api.buyerJourney.steps);\n const activeStep = useSubscription(api.buyerJourney.activeStep);\n\n return activeStep\n ? steps.find(({handle}) => handle === activeStep.handle)\n : undefined;\n}" + } + }, + "UseExtensionCapabilitiesGeneratedType": { + "src/surfaces/checkout/preact/capabilities.ts": { + "filePath": "src/surfaces/checkout/preact/capabilities.ts", + "name": "UseExtensionCapabilitiesGeneratedType", + "description": "Returns a list of an extension's granted capabilities.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/capabilities.ts", + "description": "", + "name": "Capability[]", + "value": "Capability[]" + }, + "value": "export function useExtensionCapabilities(): Capability[] {\n return useSubscription(useApi().extension.capabilities);\n}" + } + }, + "UseExtensionCapabilityGeneratedType": { + "src/surfaces/checkout/preact/capabilities.ts": { + "filePath": "src/surfaces/checkout/preact/capabilities.ts", + "name": "UseExtensionCapabilityGeneratedType", + "description": "Returns whether or not a given capability of an extension is granted.", + "isPublicDocs": true, + "params": [ + { + "name": "capability", + "description": "", + "value": "Capability", + "filePath": "src/surfaces/checkout/preact/capabilities.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/capabilities.ts", + "description": "", + "name": "boolean", + "value": "boolean" + }, + "value": "export function useExtensionCapability(capability: Capability): boolean {\n return useExtensionCapabilities().includes(capability);\n}" + } + }, + "UseCartLineTargetGeneratedType": { + "src/surfaces/checkout/preact/cart-line-target.ts": { + "filePath": "src/surfaces/checkout/preact/cart-line-target.ts", + "name": "UseCartLineTargetGeneratedType", + "description": "Returns the cart line the extension is attached to. This hook can only be used by extensions in the following extension targets:\n- `purchase.cart-line-item.line-components.render`\n- `purchase.checkout.cart-line-item.render-after`\n- `purchase.thank-you.cart-line-item.render-after`", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/cart-line-target.ts", + "description": "", + "name": "CartLine", + "value": "CartLine" + }, + "value": "export function useCartLineTarget(): CartLine {\n const api = useApi<\n | 'purchase.cart-line-item.line-components.render'\n | 'purchase.checkout.cart-line-item.render-after'\n | 'purchase.thank-you.cart-line-item.render-after'\n >();\n if (!api.target) {\n throw new ExtensionHasNoTargetError(\n 'useCartLineTarget',\n api.extension.target,\n );\n }\n\n return useSubscription(api.target);\n}" + } + }, + "UseCartLinesGeneratedType": { + "src/surfaces/checkout/preact/cart-lines.ts": { + "filePath": "src/surfaces/checkout/preact/cart-lines.ts", + "name": "UseCartLinesGeneratedType", + "description": "Returns the current line items for the checkout, and automatically re-renders your component if line items are added, removed, or updated.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/cart-lines.ts", + "description": "", + "name": "CartLine[]", + "value": "CartLine[]" + }, + "value": "export function useCartLines<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CartLine[] {\n const {lines} = useApi();\n\n return useSubscription(lines);\n}" + } + }, + "UseApplyCartLinesChangeGeneratedType": { + "src/surfaces/checkout/preact/cart-lines.ts": { + "filePath": "src/surfaces/checkout/preact/cart-lines.ts", + "name": "UseApplyCartLinesChangeGeneratedType", + "description": "Returns a function to mutate the `lines` property of checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/cart-lines.ts", + "description": "", + "name": "(change: CartLineChange) => Promise", + "value": "(change: CartLineChange) => Promise" + }, + "value": "export function useApplyCartLinesChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: CartLineChange) => Promise {\n const api = useApi();\n\n if ('applyCartLinesChange' in api) {\n return api.applyCartLinesChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyCartLinesChange',\n api.extension.target,\n );\n}" + } + }, + "UseCheckoutSettingsGeneratedType": { + "src/surfaces/checkout/preact/checkout-settings.ts": { + "filePath": "src/surfaces/checkout/preact/checkout-settings.ts", + "name": "UseCheckoutSettingsGeneratedType", + "description": "Returns the `checkoutSettings` applied to the checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/checkout-settings.ts", + "description": "", + "name": "CheckoutSettings", + "value": "CheckoutSettings" + }, + "value": "export function useCheckoutSettings<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CheckoutSettings {\n return useSubscription(useApi().checkoutSettings);\n}" + } + }, + "UseCheckoutTokenGeneratedType": { + "src/surfaces/checkout/preact/checkout-token.ts": { + "filePath": "src/surfaces/checkout/preact/checkout-token.ts", + "name": "UseCheckoutTokenGeneratedType", + "description": "A stable id that represents the current checkout.\n\nMatches the `token` field in the [WebPixel checkout payload](/docs/api/pixels/customer-events#checkout) and the `checkout_token` field in the [Admin REST API Order resource](/docs/api/admin-rest/unstable/resources/order#resource-object).", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/checkout-token.ts", + "description": "", + "name": "CheckoutToken | undefined", + "value": "CheckoutToken | undefined" + }, + "value": "export function useCheckoutToken<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CheckoutToken | undefined {\n return useSubscription(useApi().checkoutToken);\n}" + } + }, + "UseSubtotalAmountGeneratedType": { + "src/surfaces/checkout/preact/cost.ts": { + "filePath": "src/surfaces/checkout/preact/cost.ts", + "name": "UseSubtotalAmountGeneratedType", + "description": "A `Money` value representing the subtotal value of the items in the cart at the current step of checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/cost.ts", + "description": "", + "name": "Money", + "value": "Money" + }, + "value": "export function useSubtotalAmount<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Money {\n return useSubscription(useApi().cost.subtotalAmount);\n}" + } + }, + "UseTotalShippingAmountGeneratedType": { + "src/surfaces/checkout/preact/cost.ts": { + "filePath": "src/surfaces/checkout/preact/cost.ts", + "name": "UseTotalShippingAmountGeneratedType", + "description": "A `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/cost.ts", + "description": "", + "name": "Money | undefined", + "value": "Money | undefined" + }, + "value": "export function useTotalShippingAmount<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Money | undefined {\n return useSubscription(useApi().cost.totalShippingAmount);\n}" + } + }, + "UseTotalTaxAmountGeneratedType": { + "src/surfaces/checkout/preact/cost.ts": { + "filePath": "src/surfaces/checkout/preact/cost.ts", + "name": "UseTotalTaxAmountGeneratedType", + "description": "A `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/cost.ts", + "description": "", + "name": "Money | undefined", + "value": "Money | undefined" + }, + "value": "export function useTotalTaxAmount<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Money | undefined {\n return useSubscription(useApi().cost.totalTaxAmount);\n}" + } + }, + "UseTotalAmountGeneratedType": { + "src/surfaces/checkout/preact/cost.ts": { + "filePath": "src/surfaces/checkout/preact/cost.ts", + "name": "UseTotalAmountGeneratedType", + "description": "Returns a `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/cost.ts", + "description": "", + "name": "Money", + "value": "Money" + }, + "value": "export function useTotalAmount<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Money {\n return useSubscription(useApi().cost.totalAmount);\n}" + } + }, + "UseLocalizationCountryGeneratedType": { + "src/surfaces/checkout/preact/country.ts": { + "filePath": "src/surfaces/checkout/preact/country.ts", + "name": "UseLocalizationCountryGeneratedType", + "description": "Returns the country of the checkout, and automatically re-renders your component if the country changes.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/country.ts", + "description": "", + "name": "Country | undefined", + "value": "Country | undefined" + }, + "value": "export function useLocalizationCountry<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Country | undefined {\n const {localization} = useApi();\n\n return useSubscription(localization.country);\n}" + } + }, + "UseCurrencyGeneratedType": { + "src/surfaces/checkout/preact/currency.ts": { + "filePath": "src/surfaces/checkout/preact/currency.ts", + "name": "UseCurrencyGeneratedType", + "description": "Returns the currency of the checkout, and automatically re-renders your component if the currency changes.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/currency.ts", + "description": "", + "name": "Currency", + "value": "Currency" + }, + "value": "export function useCurrency<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Currency {\n const {localization} = useApi();\n\n return useSubscription(localization.currency);\n}" + } + }, + "UseCustomerPrivacyGeneratedType": { + "src/surfaces/checkout/preact/customer-privacy.ts": { + "filePath": "src/surfaces/checkout/preact/customer-privacy.ts", + "name": "UseCustomerPrivacyGeneratedType", + "description": "Returns the current customer privacy settings and metadata and re-renders your component if the customer privacy settings change.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/customer-privacy.ts", + "description": "", + "name": "CustomerPrivacy", + "value": "CustomerPrivacy" + }, + "value": "export function useCustomerPrivacy<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CustomerPrivacy {\n return useSubscription(useApi().customerPrivacy);\n}" + } + }, + "UseDeliveryGroupListTargetGeneratedType": { + "src/surfaces/checkout/preact/delivery-group-list-target.ts": { + "filePath": "src/surfaces/checkout/preact/delivery-group-list-target.ts", + "name": "UseDeliveryGroupListTargetGeneratedType", + "description": "Returns the delivery group list the extension is attached to. This hook can only be used by extensions in the following extension targets:\n- purchase.checkout.shipping-option-list.render-before\n- purchase.checkout.shipping-option-list.render-after", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/delivery-group-list-target.ts", + "description": "", + "name": "DeliveryGroupList | undefined", + "value": "DeliveryGroupList | undefined" + }, + "value": "export function useDeliveryGroupListTarget(): DeliveryGroupList | undefined {\n const api = useApi<\n | 'purchase.checkout.shipping-option-list.render-before'\n | 'purchase.checkout.shipping-option-list.render-after'\n >();\n\n return useSubscription(api.target);\n}" + } + }, + "UseDeliveryGroupTargetGeneratedType": { + "src/surfaces/checkout/preact/delivery-group-target.ts": { + "filePath": "src/surfaces/checkout/preact/delivery-group-target.ts", + "name": "UseDeliveryGroupTargetGeneratedType", + "description": "Returns the delivery group the extension is attached to. This hook can only be used by extensions in the following extension targets:\n- purchase.checkout.shipping-option-list.render-before\n- purchase.checkout.shipping-option-list.render-after\n\n> Caution: Deprecated as of version `2024-07`, use `useDeliveryGroupListTarget()` instead.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/delivery-group-target.ts", + "description": "", + "name": "DeliveryGroup | undefined", + "value": "DeliveryGroup | undefined" + }, + "value": "export function useDeliveryGroupTarget(): DeliveryGroup | undefined {\n const api = useApi<\n | 'purchase.checkout.shipping-option-list.render-before'\n | 'purchase.checkout.shipping-option-list.render-after'\n >();\n\n const target = useSubscription(api.target);\n return target?.deliveryGroups[0];\n}" + } + }, + "UseDeliveryGroupGeneratedType": { + "src/surfaces/checkout/preact/delivery-group.ts": { + "filePath": "src/surfaces/checkout/preact/delivery-group.ts", + "name": "UseDeliveryGroupGeneratedType", + "description": "Returns the full expanded details of a delivery group and automatically re-renders your component when that delivery group changes.", + "isPublicDocs": true, + "params": [ + { + "name": "deliveryGroup", + "description": "", + "value": "DeliveryGroup", + "filePath": "src/surfaces/checkout/preact/delivery-group.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/delivery-group.ts", + "description": "", + "name": "DeliveryGroupDetails | undefined", + "value": "DeliveryGroupDetails | undefined" + }, + "value": "export function useDeliveryGroup<\n ID extends RenderExtensionTarget = RenderExtensionTarget,\n>(deliveryGroup: DeliveryGroup | undefined): DeliveryGroupDetails | undefined {\n const {lines} = useApi();\n const cartLines = useSubscription(lines);\n\n return useMemo(() => {\n if (!deliveryGroup) {\n return undefined;\n }\n\n const deliveryGroupDetails = {\n ...deliveryGroup,\n selectedDeliveryOption: getSelectedDeliveryOption(deliveryGroup),\n targetedCartLines: getTargetedCartLines(deliveryGroup, cartLines),\n };\n\n return deliveryGroupDetails;\n }, [deliveryGroup, cartLines]);\n}" + } + }, + "UseDeliveryGroupsGeneratedType": { + "src/surfaces/checkout/preact/delivery-groups.ts": { + "filePath": "src/surfaces/checkout/preact/delivery-groups.ts", + "name": "UseDeliveryGroupsGeneratedType", + "description": "Returns the current delivery groups for the checkout, and automatically re-renders your component when delivery address or delivery option selection changes.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/delivery-groups.ts", + "description": "", + "name": "DeliveryGroup[]", + "value": "DeliveryGroup[]" + }, + "value": "export function useDeliveryGroups<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): DeliveryGroup[] {\n const api = useApi();\n return useSubscription(api.deliveryGroups);\n}" + } + }, + "UseDeliverySelectionGroupsGeneratedType": { + "src/surfaces/checkout/preact/delivery-selection-groups.ts": { + "filePath": "src/surfaces/checkout/preact/delivery-selection-groups.ts", + "name": "UseDeliverySelectionGroupsGeneratedType", + "description": "Returns the list of delivery selection groups available to the buyers. This hook can only be used by extensions in the following extension targets:\n- purchase.checkout.shipping-option-list.render-before\n- purchase.checkout.shipping-option-list.render-after", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/delivery-selection-groups.ts", + "description": "", + "name": "| DeliverySelectionGroup[]\n | undefined", + "value": "| DeliverySelectionGroup[]\n | undefined" + }, + "value": "export function useDeliverySelectionGroups():\n | DeliverySelectionGroup[]\n | undefined {\n const api = useApi<\n | 'purchase.checkout.shipping-option-list.render-before'\n | 'purchase.checkout.shipping-option-list.render-after'\n >();\n\n return useSubscription(api.deliverySelectionGroups);\n}" + } + }, + "UseDiscountCodesGeneratedType": { + "src/surfaces/checkout/preact/discounts.ts": { + "filePath": "src/surfaces/checkout/preact/discounts.ts", + "name": "UseDiscountCodesGeneratedType", + "description": "Returns the current discount codes applied to the cart, and automatically re-renders your component if discount codes are added or removed.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/discounts.ts", + "description": "", + "name": "CartDiscountCode[]", + "value": "CartDiscountCode[]" + }, + "value": "export function useDiscountCodes<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CartDiscountCode[] {\n const {discountCodes} = useApi();\n\n return useSubscription(discountCodes);\n}" + } + }, + "UseDiscountAllocationsGeneratedType": { + "src/surfaces/checkout/preact/discounts.ts": { + "filePath": "src/surfaces/checkout/preact/discounts.ts", + "name": "UseDiscountAllocationsGeneratedType", + "description": "Returns the current discount allocations applied to the cart, and automatically re-renders your component if discount allocations changed.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/discounts.ts", + "description": "", + "name": "CartDiscountAllocation[]", + "value": "CartDiscountAllocation[]" + }, + "value": "export function useDiscountAllocations<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CartDiscountAllocation[] {\n const {discountAllocations} = useApi();\n\n return useSubscription(discountAllocations);\n}" + } + }, + "UseApplyDiscountCodeChangeGeneratedType": { + "src/surfaces/checkout/preact/discounts.ts": { + "filePath": "src/surfaces/checkout/preact/discounts.ts", + "name": "UseApplyDiscountCodeChangeGeneratedType", + "description": "Returns a function to add or remove discount codes.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/discounts.ts", + "description": "", + "name": "(change: DiscountCodeChange) => Promise", + "value": "(change: DiscountCodeChange) => Promise" + }, + "value": "export function useApplyDiscountCodeChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: DiscountCodeChange) => Promise {\n const api = useApi();\n\n if ('applyDiscountCodeChange' in api) {\n return api.applyDiscountCodeChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyDiscountCodeChange',\n api.extension.target,\n );\n}" + } + }, + "UseExtensionEditorGeneratedType": { + "src/surfaces/checkout/preact/extension-editor.ts": { + "filePath": "src/surfaces/checkout/preact/extension-editor.ts", + "name": "UseExtensionEditorGeneratedType", + "description": "Returns information about the editor where the extension is being rendered.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/extension-editor.ts", + "description": "", + "name": "Editor | undefined", + "value": "Editor | undefined" + }, + "value": "export function useExtensionEditor(): Editor | undefined {\n return useApi().extension.editor;\n}" + } + }, + "UseExtensionLanguageGeneratedType": { + "src/surfaces/checkout/preact/extension-language.ts": { + "filePath": "src/surfaces/checkout/preact/extension-language.ts", + "name": "UseExtensionLanguageGeneratedType", + "description": "Returns the buyer's language, as supported by the extension.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/extension-language.ts", + "description": "", + "name": "Language", + "value": "Language" + }, + "value": "export function useExtensionLanguage<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Language {\n const {localization} = useApi();\n\n return useSubscription(localization.extensionLanguage);\n}" + } + }, + "UseExtensionGeneratedType": { + "src/surfaces/checkout/preact/extension.ts": { + "filePath": "src/surfaces/checkout/preact/extension.ts", + "name": "UseExtensionGeneratedType", + "description": "Returns the metadata about the extension.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/extension.ts", + "description": "", + "name": "Extension", + "value": "Extension" + }, + "value": "export function useExtension(): Extension {\n return useApi().extension as Extension;\n}" + } + }, + "UseExtensionDataGeneratedType": { + "src/surfaces/checkout/preact/extension.ts": { + "filePath": "src/surfaces/checkout/preact/extension.ts", + "name": "UseExtensionDataGeneratedType", + "description": "Returns the metadata about the extension. > Caution: This is deprecated, use `useExtension()` instead.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/extension.ts", + "description": "", + "name": "Extension", + "value": "Extension" + }, + "value": "export function useExtensionData(): Extension {\n return useExtension();\n}" + } + }, + "UseAppliedGiftCardsGeneratedType": { + "src/surfaces/checkout/preact/gift-cards.ts": { + "filePath": "src/surfaces/checkout/preact/gift-cards.ts", + "name": "UseAppliedGiftCardsGeneratedType", + "description": "Returns the current gift cards applied to the cart, and automatically re-renders your component if gift cards are added or removed.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/gift-cards.ts", + "description": "", + "name": "AppliedGiftCard[]", + "value": "AppliedGiftCard[]" + }, + "value": "export function useAppliedGiftCards<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): AppliedGiftCard[] {\n const {appliedGiftCards} = useApi();\n\n return useSubscription(appliedGiftCards);\n}" + } + }, + "UseApplyGiftCardChangeGeneratedType": { + "src/surfaces/checkout/preact/gift-cards.ts": { + "filePath": "src/surfaces/checkout/preact/gift-cards.ts", + "name": "UseApplyGiftCardChangeGeneratedType", + "description": "Returns a function to add or remove gift cards.\n\n> Caution: > See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/gift-cards.ts", + "description": "", + "name": "(change: GiftCardChange) => Promise", + "value": "(change: GiftCardChange) => Promise" + }, + "value": "export function useApplyGiftCardChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: GiftCardChange) => Promise {\n const api = useApi();\n\n if ('applyGiftCardChange' in api) {\n return api.applyGiftCardChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyGiftCardChange',\n api.extension.target,\n );\n}" + } + }, + "UseInstructionsGeneratedType": { + "src/surfaces/checkout/preact/instructions.ts": { + "filePath": "src/surfaces/checkout/preact/instructions.ts", + "name": "UseInstructionsGeneratedType", + "description": "Returns the cart instructions used to create the checkout and possibly limit extension capabilities.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/instructions.ts", + "description": "", + "name": "CartInstructions", + "value": "CartInstructions" + }, + "value": "export function useInstructions<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): CartInstructions {\n return useSubscription(useApi().instructions);\n}" + } + }, + "UseLanguageGeneratedType": { + "src/surfaces/checkout/preact/language.ts": { + "filePath": "src/surfaces/checkout/preact/language.ts", + "name": "UseLanguageGeneratedType", + "description": "Returns the current language of the checkout, and automatically re-renders your component if the language changes.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/language.ts", + "description": "", + "name": "Language", + "value": "Language" + }, + "value": "export function useLanguage<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Language {\n const {localization} = useApi();\n\n return useSubscription(localization.language);\n}" + } + }, + "UseLocalizedFieldsGeneratedType": { + "src/surfaces/checkout/preact/localized-fields.ts": { + "filePath": "src/surfaces/checkout/preact/localized-fields.ts", + "name": "UseLocalizedFieldsGeneratedType", + "description": "Returns the current localized fields and re-renders your component if the values change.", + "isPublicDocs": true, + "params": [ + { + "name": "keys", + "description": "", + "value": "LocalizedFieldKey[]", + "isOptional": true, + "filePath": "src/surfaces/checkout/preact/localized-fields.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/localized-fields.ts", + "description": "", + "name": "LocalizedField[]", + "value": "LocalizedField[]" + }, + "value": "export function useLocalizedFields<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(keys?: LocalizedFieldKey[]): LocalizedField[] {\n const {localizedFields} = useApi();\n\n if (!localizedFields) {\n throw new ScopeNotGrantedError(\n 'Using localized fields requires having personal customer data permissions granted to your app.',\n );\n }\n\n const localizedFieldsData = useSubscription(localizedFields);\n\n if (!keys) {\n return localizedFieldsData;\n }\n\n if (!keys.length) {\n return [];\n }\n\n return localizedFieldsData.filter(({key}) => keys.includes(key));\n}" + } + }, + "UseLocalizedFieldGeneratedType": { + "src/surfaces/checkout/preact/localized-fields.ts": { + "filePath": "src/surfaces/checkout/preact/localized-fields.ts", + "name": "UseLocalizedFieldGeneratedType", + "description": "Returns the current localized field or undefined for the specified localized field key and re-renders your component if the value changes.\n\nReturns `undefined` when no field is configured for the buyer's country.", + "isPublicDocs": true, + "params": [ + { + "name": "key", + "description": "", + "value": "LocalizedFieldKey", + "filePath": "src/surfaces/checkout/preact/localized-fields.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/localized-fields.ts", + "description": "", + "name": "LocalizedField | undefined", + "value": "LocalizedField | undefined" + }, + "value": "export function useLocalizedField<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(key: LocalizedFieldKey): LocalizedField | undefined {\n const fields = useLocalizedFields([key]);\n return fields[0];\n}" + } + }, + "UseLocalizationMarketGeneratedType": { + "src/surfaces/checkout/preact/market.ts": { + "filePath": "src/surfaces/checkout/preact/market.ts", + "name": "UseLocalizationMarketGeneratedType", + "description": "Returns the market of the checkout, and automatically re-renders your component if it changes.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/market.ts", + "description": "", + "name": "Market | undefined", + "value": "Market | undefined" + }, + "value": "export function useLocalizationMarket<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Market | undefined {\n const {localization} = useApi();\n\n return useSubscription(localization.market);\n}" + } + }, + "UseApplyMetafieldsChangeGeneratedType": { + "src/surfaces/checkout/preact/metafields.ts": { + "filePath": "src/surfaces/checkout/preact/metafields.ts", + "name": "UseApplyMetafieldsChangeGeneratedType", + "description": "Returns a function to mutate the `metafields` property of the checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/metafields.ts", + "description": "", + "name": "(change: MetafieldChange) => Promise", + "value": "(change: MetafieldChange) => Promise" + }, + "value": "export function useApplyMetafieldsChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: MetafieldChange) => Promise {\n const api = useApi();\n\n if ('applyMetafieldChange' in api) {\n return api.applyMetafieldChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyMetafieldChange',\n api.extension.target,\n );\n}" + } + }, + "UseNoteGeneratedType": { + "src/surfaces/checkout/preact/note.ts": { + "filePath": "src/surfaces/checkout/preact/note.ts", + "name": "UseNoteGeneratedType", + "description": "Returns the proposed `note` applied to the checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/note.ts", + "description": "", + "name": "string | undefined", + "value": "string | undefined" + }, + "value": "export function useNote<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): string | undefined {\n return useSubscription(useApi().note);\n}" + } + }, + "UseApplyNoteChangeGeneratedType": { + "src/surfaces/checkout/preact/note.ts": { + "filePath": "src/surfaces/checkout/preact/note.ts", + "name": "UseApplyNoteChangeGeneratedType", + "description": "Returns a function to mutate the `note` property of the checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/note.ts", + "description": "", + "name": "(change: NoteChange) => Promise", + "value": "(change: NoteChange) => Promise" + }, + "value": "export function useApplyNoteChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): (change: NoteChange) => Promise {\n const api = useApi();\n\n if ('applyNoteChange' in api) {\n return api.applyNoteChange;\n }\n\n throw new ExtensionHasNoMethodError('applyNoteChange', api.extension.target);\n}" + } + }, + "UsePaymentMethodAttributesGeneratedType": { + "src/surfaces/checkout/preact/payment-method.ts": { + "filePath": "src/surfaces/checkout/preact/payment-method.ts", + "name": "UsePaymentMethodAttributesGeneratedType", + "description": "Returns the proposed `paymentAttributes` applied to the checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/payment-method.ts", + "description": "", + "name": "| PaymentMethodAttribute[]\n | undefined", + "value": "| PaymentMethodAttribute[]\n | undefined" + }, + "value": "export function usePaymentMethodAttributes():\n | PaymentMethodAttribute[]\n | undefined {\n const {paymentMethodAttributes} = useApi<\n | 'purchase.checkout.payment-option-item.details.render'\n | 'purchase.checkout.payment-option-item.hosted-fields.render-after'\n >();\n\n if (!paymentMethodAttributes) {\n throw new ScopeNotGrantedError(\n 'Using payment method attributes requires having checkout extension payments scope granted to your app.',\n );\n }\n\n return useSubscription(paymentMethodAttributes);\n}" + } + }, + "UsePaymentMethodAttributeValuesGeneratedType": { + "src/surfaces/checkout/preact/payment-method.ts": { + "filePath": "src/surfaces/checkout/preact/payment-method.ts", + "name": "UsePaymentMethodAttributeValuesGeneratedType", + "description": "Returns the values for the specified `paymentAttributes` applied to the checkout.", + "isPublicDocs": true, + "params": [ + { + "name": "keys", + "description": "An array of attribute keys.", + "value": "string[]", + "filePath": "src/surfaces/checkout/preact/payment-method.ts" + } + ], + "returns": { + "filePath": "src/surfaces/checkout/preact/payment-method.ts", + "description": "", + "name": "(PaymentMethodAttribute['value'] | undefined)[]", + "value": "(PaymentMethodAttribute['value'] | undefined)[]" + }, + "value": "export function usePaymentMethodAttributeValues(\n keys: string[],\n): (PaymentMethodAttribute['value'] | undefined)[] {\n const attributes = usePaymentMethodAttributes();\n\n if (!attributes?.length) {\n return [];\n }\n\n return keys.map((key) => {\n const attribute = attributes.find((attribute) => attribute.key === key);\n return attribute?.value;\n });\n}" + } + }, + "UseApplyPaymentMethodAttributesChangeGeneratedType": { + "src/surfaces/checkout/preact/payment-method.ts": { + "filePath": "src/surfaces/checkout/preact/payment-method.ts", + "name": "UseApplyPaymentMethodAttributesChangeGeneratedType", + "description": "Returns a function to set payment method attributes.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/payment-method.ts", + "description": "", + "name": "(\n change: PaymentMethodAttributesChange,\n) => Promise", + "value": "(\n change: PaymentMethodAttributesChange,\n) => Promise" + }, + "value": "export function useApplyPaymentMethodAttributesChange(): (\n change: PaymentMethodAttributesChange,\n) => Promise {\n const api = useApi<\n | 'purchase.checkout.payment-option-item.details.render'\n | 'purchase.checkout.payment-option-item.hosted-fields.render-after'\n >();\n\n if (!api.applyPaymentMethodAttributesChange) {\n throw new ExtensionHasNoMethodError(\n 'useApplyPaymentMethodAttributesChange',\n api.extension.target,\n );\n }\n\n return api.applyPaymentMethodAttributesChange;\n}" + } + }, + "UseAvailablePaymentOptionsGeneratedType": { + "src/surfaces/checkout/preact/payment-options.ts": { + "filePath": "src/surfaces/checkout/preact/payment-options.ts", + "name": "UseAvailablePaymentOptionsGeneratedType", + "description": "Returns all available payment options.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/payment-options.ts", + "description": "", + "name": "PaymentOption[]", + "value": "PaymentOption[]" + }, + "value": "export function useAvailablePaymentOptions<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): PaymentOption[] {\n const api = useApi();\n return useSubscription(api.availablePaymentOptions);\n}" + } + }, + "UseSelectedPaymentOptionsGeneratedType": { + "src/surfaces/checkout/preact/payment-options.ts": { + "filePath": "src/surfaces/checkout/preact/payment-options.ts", + "name": "UseSelectedPaymentOptionsGeneratedType", + "description": "Returns payment options selected by the buyer.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/payment-options.ts", + "description": "", + "name": "SelectedPaymentOption[]", + "value": "SelectedPaymentOption[]" + }, + "value": "export function useSelectedPaymentOptions<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): SelectedPaymentOption[] {\n const api = useApi();\n return useSubscription(api.selectedPaymentOptions);\n}" + } + }, + "UsePickupLocationOptionTargetGeneratedType": { + "src/surfaces/checkout/preact/pickup-location-option-target.ts": { + "filePath": "src/surfaces/checkout/preact/pickup-location-option-target.ts", + "name": "UsePickupLocationOptionTargetGeneratedType", + "description": "Returns the pickup location option the extension is attached to. This hook can only be used by extensions in the following extension target:\n- `purchase.checkout.pickup-location-option-item.render-after`", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/pickup-location-option-target.ts", + "description": "", + "name": "{\n pickupLocationOptionTarget: PickupLocationOption;\n isTargetSelected: boolean;\n}", + "value": "{\n pickupLocationOptionTarget: PickupLocationOption;\n isTargetSelected: boolean;\n}" + }, + "value": "export function usePickupLocationOptionTarget(): {\n pickupLocationOptionTarget: PickupLocationOption;\n isTargetSelected: boolean;\n} {\n const api =\n useApi<'purchase.checkout.pickup-location-option-item.render-after'>();\n if (!api.target || api.isTargetSelected === undefined) {\n throw new ExtensionHasNoTargetError(\n 'usePickupLocationOptionTarget',\n api.extension.target,\n );\n }\n\n const pickupLocationOptionTarget = useSubscription(api.target);\n const isTargetSelected = useSubscription(api.isTargetSelected);\n\n const pickupLocationOption = useMemo(() => {\n return {\n pickupLocationOptionTarget,\n isTargetSelected,\n };\n }, [pickupLocationOptionTarget, isTargetSelected]);\n\n return pickupLocationOption;\n}" + } + }, + "UseApplyRedeemableChangeGeneratedType": { + "src/surfaces/checkout/preact/redeemable.ts": { + "filePath": "src/surfaces/checkout/preact/redeemable.ts", + "name": "UseApplyRedeemableChangeGeneratedType", + "description": "Returns a function to apply a change to add a redeemable.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/redeemable.ts", + "description": "", + "name": "(\n change: RedeemableChange,\n) => Promise", + "value": "(\n change: RedeemableChange,\n) => Promise" + }, + "value": "export function useApplyRedeemableChange(): (\n change: RedeemableChange,\n) => Promise {\n const api = useApi<'purchase.checkout.gift-card.render'>();\n\n if (!api.applyRedeemableChange) {\n throw new ExtensionHasNoMethodError(\n 'useApplyRedeemableChange',\n api.extension.target,\n );\n }\n\n return api.applyRedeemableChange;\n}" + } + }, + "UseSessionTokenGeneratedType": { + "src/surfaces/checkout/preact/session-token.ts": { + "filePath": "src/surfaces/checkout/preact/session-token.ts", + "name": "UseSessionTokenGeneratedType", + "description": "Provides access to session tokens, which can be used to verify token claims on your app's server.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/session-token.ts", + "description": "", + "name": "SessionToken", + "value": "SessionToken" + }, + "value": "export function useSessionToken<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): SessionToken {\n return useApi().sessionToken;\n}" + } + }, + "UseSettingsGeneratedType": { + "src/surfaces/checkout/preact/settings.ts": { + "filePath": "src/surfaces/checkout/preact/settings.ts", + "name": "UseSettingsGeneratedType", + "description": "Returns the setting values defined by the merchant for the extension.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/settings.ts", + "description": "", + "name": "Partial", + "value": "Partial" + }, + "value": "export function useSettings<\n Settings extends ExtensionSettings,\n>(): Partial {\n const settings = useSubscription(useApi().settings);\n\n return settings as Settings;\n}" + } + }, + "UseShippingAddressGeneratedType": { + "src/surfaces/checkout/preact/shipping-address.ts": { + "filePath": "src/surfaces/checkout/preact/shipping-address.ts", + "name": "UseShippingAddressGeneratedType", + "description": "Returns the proposed `shippingAddress` applied to the checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/shipping-address.ts", + "description": "", + "name": "ShippingAddress | undefined", + "value": "ShippingAddress | undefined" + }, + "value": "export function useShippingAddress<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): ShippingAddress | undefined {\n const shippingAddress = useApi().shippingAddress;\n\n if (!shippingAddress) {\n throw new ScopeNotGrantedError(\n 'Using shipping address requires having shipping address permissions granted to your app.',\n );\n }\n\n return useSubscription(shippingAddress);\n}" + } + }, + "UseApplyShippingAddressChangeGeneratedType": { + "src/surfaces/checkout/preact/shipping-address.ts": { + "filePath": "src/surfaces/checkout/preact/shipping-address.ts", + "name": "UseApplyShippingAddressChangeGeneratedType", + "description": "Returns a function to mutate the `shippingAddress` property of checkout.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/shipping-address.ts", + "description": "", + "name": "(change: ShippingAddressChange) => Promise | undefined", + "value": "(change: ShippingAddressChange) => Promise | undefined" + }, + "value": "export function useApplyShippingAddressChange<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>():\n | ((change: ShippingAddressChange) => Promise)\n | undefined {\n const api = useApi();\n\n if ('applyShippingAddressChange' in api) {\n return api.applyShippingAddressChange;\n }\n\n throw new ExtensionHasNoMethodError(\n 'applyShippingAddressChange',\n api.extension.target,\n );\n}" + } + }, + "UseShippingOptionTargetGeneratedType": { + "src/surfaces/checkout/preact/shipping-option-target.ts": { + "filePath": "src/surfaces/checkout/preact/shipping-option-target.ts", + "name": "UseShippingOptionTargetGeneratedType", + "description": "Returns the shipping option the extension is attached to. This hook can only be used by extensions in the following extension targets:\n- `purchase.checkout.shipping-option-item.render-after`\n- `purchase.checkout.shipping-option-item.details.render`", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/shipping-option-target.ts", + "description": "", + "name": "{\n shippingOptionTarget: ShippingOption;\n isTargetSelected: boolean;\n /**\n * @deprecated Do not rely on render context. This target can render inside an overlay, so use inline UI instead of opening overlays such as modals.\n */\n renderMode: ShippingOptionItemRenderMode;\n}", + "value": "{\n shippingOptionTarget: ShippingOption;\n isTargetSelected: boolean;\n /**\n * @deprecated Do not rely on render context. This target can render inside an overlay, so use inline UI instead of opening overlays such as modals.\n */\n renderMode: ShippingOptionItemRenderMode;\n}" + }, + "value": "export function useShippingOptionTarget(): {\n shippingOptionTarget: ShippingOption;\n isTargetSelected: boolean;\n /**\n * @deprecated Do not rely on render context. This target can render inside an overlay, so use inline UI instead of opening overlays such as modals.\n */\n renderMode: ShippingOptionItemRenderMode;\n} {\n const api = useApi<\n | 'purchase.checkout.shipping-option-item.render-after'\n | 'purchase.checkout.shipping-option-item.details.render'\n >();\n if (!api.target || api.isTargetSelected === undefined) {\n throw new ExtensionHasNoTargetError(\n 'useShippingOptionTarget',\n api.extension.target,\n );\n }\n\n const shippingOptionTarget = useSubscription(api.target);\n const isTargetSelected = useSubscription(api.isTargetSelected);\n const renderMode = api.renderMode;\n\n const shippingOption = useMemo(() => {\n return {\n shippingOptionTarget,\n isTargetSelected,\n renderMode,\n };\n }, [shippingOptionTarget, isTargetSelected, renderMode]);\n\n return shippingOption;\n}" + } + }, + "UseShopGeneratedType": { + "src/surfaces/checkout/preact/shop.ts": { + "filePath": "src/surfaces/checkout/preact/shop.ts", + "name": "UseShopGeneratedType", + "description": "Returns the `Shop` where the checkout is taking place.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/shop.ts", + "description": "", + "name": "Shop", + "value": "Shop" + }, + "value": "export function useShop<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Shop {\n return useApi().shop;\n}" + } + }, + "UseStorageGeneratedType": { + "src/surfaces/checkout/preact/storage.ts": { + "filePath": "src/surfaces/checkout/preact/storage.ts", + "name": "UseStorageGeneratedType", + "description": "Returns the key-value `Storage` interface for the extension. Uses `localStorage` and should persist across the buyer's current checkout session. However, data persistence isn't guaranteed and storage is reset when the buyer starts a new checkout.\n\nData is shared across all activated extension targets of this extension. In versions `<=2023-07`, each activated extension target had its own storage.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/storage.ts", + "description": "", + "name": "Storage", + "value": "Storage" + }, + "value": "export function useStorage<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Storage {\n return useApi().storage;\n}" + } + }, + "UseTargetGeneratedType": { + "src/surfaces/checkout/preact/target.ts": { + "filePath": "src/surfaces/checkout/preact/target.ts", + "name": "UseTargetGeneratedType", + "description": "Returns the cart line the extension is attached to. This hook can only be used by extensions in the `purchase.cart-line-item.line-components.render`, `purchase.checkout.cart-line-item.render-after`, and `purchase.thank-you.cart-line-item.render-after` extension targets. Until version `2023-04`, this hook returned a `PresentmentCartLine` object.\n\n> Caution: Deprecated as of version `2023-10`, use `useCartLineTarget()` instead.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/target.ts", + "description": "", + "name": "CartLine", + "value": "CartLine" + }, + "value": "export function useTarget(): CartLine {\n const api = useApi<\n | 'purchase.cart-line-item.line-components.render'\n | 'purchase.checkout.cart-line-item.render-after'\n | 'purchase.thank-you.cart-line-item.render-after'\n >();\n if (!api.target) {\n throw new ExtensionHasNoTargetError(api.extension.target);\n }\n\n return useSubscription(api.target);\n}" + } + }, + "UseTimezoneGeneratedType": { + "src/surfaces/checkout/preact/timezone.ts": { + "filePath": "src/surfaces/checkout/preact/timezone.ts", + "name": "UseTimezoneGeneratedType", + "description": "Returns the time zone of the checkout, and automatically re-renders your component if the time zone changes.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/timezone.ts", + "description": "", + "name": "\"Africa/Abidjan\" | \"Africa/Algiers\" | \"Africa/Bissau\" | \"Africa/Cairo\" | \"Africa/Casablanca\" | \"Africa/Ceuta\" | \"Africa/El_Aaiun\" | \"Africa/Johannesburg\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Lagos\" | \"Africa/Maputo\" | \"Africa/Monrovia\" | \"Africa/Nairobi\" | \"Africa/Ndjamena\" | \"Africa/Sao_Tome\" | \"Africa/Tripoli\" | \"Africa/Tunis\" | \"Africa/Windhoek\" | \"America/Adak\" | \"America/Anchorage\" | \"America/Araguaina\" | \"America/Argentina/Buenos_Aires\" | \"America/Argentina/Catamarca\" | \"America/Argentina/Cordoba\" | \"America/Argentina/Jujuy\" | \"America/Argentina/La_Rioja\" | \"America/Argentina/Mendoza\" | \"America/Argentina/Rio_Gallegos\" | \"America/Argentina/Salta\" | \"America/Argentina/San_Juan\" | \"America/Argentina/San_Luis\" | \"America/Argentina/Tucuman\" | \"America/Argentina/Ushuaia\" | \"America/Asuncion\" | \"America/Bahia\" | \"America/Bahia_Banderas\" | \"America/Barbados\" | \"America/Belem\" | \"America/Belize\" | \"America/Boa_Vista\" | \"America/Bogota\" | \"America/Boise\" | \"America/Cambridge_Bay\" | \"America/Campo_Grande\" | \"America/Cancun\" | \"America/Caracas\" | \"America/Cayenne\" | \"America/Chicago\" | \"America/Chihuahua\" | \"America/Costa_Rica\" | \"America/Cuiaba\" | \"America/Danmarkshavn\" | \"America/Dawson\" | \"America/Dawson_Creek\" | \"America/Denver\" | \"America/Detroit\" | \"America/Edmonton\" | \"America/Eirunepe\" | \"America/El_Salvador\" | \"America/Fort_Nelson\" | \"America/Fortaleza\" | \"America/Glace_Bay\" | \"America/Goose_Bay\" | \"America/Grand_Turk\" | \"America/Guatemala\" | \"America/Guayaquil\" | \"America/Guyana\" | \"America/Halifax\" | \"America/Havana\" | \"America/Hermosillo\" | \"America/Indiana/Indianapolis\" | \"America/Indiana/Knox\" | \"America/Indiana/Marengo\" | \"America/Indiana/Petersburg\" | \"America/Indiana/Tell_City\" | \"America/Indiana/Vevay\" | \"America/Indiana/Vincennes\" | \"America/Indiana/Winamac\" | \"America/Inuvik\" | \"America/Iqaluit\" | \"America/Jamaica\" | \"America/Juneau\" | \"America/Kentucky/Louisville\" | \"America/Kentucky/Monticello\" | \"America/La_Paz\" | \"America/Lima\" | \"America/Los_Angeles\" | \"America/Maceio\" | \"America/Managua\" | \"America/Manaus\" | \"America/Martinique\" | \"America/Matamoros\" | \"America/Mazatlan\" | \"America/Menominee\" | \"America/Merida\" | \"America/Metlakatla\" | \"America/Mexico_City\" | \"America/Miquelon\" | \"America/Moncton\" | \"America/Monterrey\" | \"America/Montevideo\" | \"America/New_York\" | \"America/Nipigon\" | \"America/Nome\" | \"America/Noronha\" | \"America/North_Dakota/Beulah\" | \"America/North_Dakota/Center\" | \"America/North_Dakota/New_Salem\" | \"America/Nuuk\" | \"America/Ojinaga\" | \"America/Panama\" | \"America/Pangnirtung\" | \"America/Paramaribo\" | \"America/Phoenix\" | \"America/Port-au-Prince\" | \"America/Porto_Velho\" | \"America/Puerto_Rico\" | \"America/Punta_Arenas\" | \"America/Rainy_River\" | \"America/Rankin_Inlet\" | \"America/Recife\" | \"America/Regina\" | \"America/Resolute\" | \"America/Rio_Branco\" | \"America/Santarem\" | \"America/Santiago\" | \"America/Santo_Domingo\" | \"America/Sao_Paulo\" | \"America/Scoresbysund\" | \"America/Sitka\" | \"America/St_Johns\" | \"America/Swift_Current\" | \"America/Tegucigalpa\" | \"America/Thule\" | \"America/Thunder_Bay\" | \"America/Tijuana\" | \"America/Toronto\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Winnipeg\" | \"America/Yakutat\" | \"America/Yellowknife\" | \"Antarctica/Casey\" | \"Antarctica/Davis\" | \"Antarctica/Macquarie\" | \"Antarctica/Mawson\" | \"Antarctica/Palmer\" | \"Antarctica/Rothera\" | \"Antarctica/Troll\" | \"Antarctica/Vostok\" | \"Asia/Almaty\" | \"Asia/Amman\" | \"Asia/Anadyr\" | \"Asia/Aqtau\" | \"Asia/Aqtobe\" | \"Asia/Ashgabat\" | \"Asia/Atyrau\" | \"Asia/Baghdad\" | \"Asia/Baku\" | \"Asia/Bangkok\" | \"Asia/Barnaul\" | \"Asia/Beirut\" | \"Asia/Bishkek\" | \"Asia/Brunei\" | \"Asia/Chita\" | \"Asia/Choibalsan\" | \"Asia/Colombo\" | \"Asia/Damascus\" | \"Asia/Dhaka\" | \"Asia/Dili\" | \"Asia/Dubai\" | \"Asia/Dushanbe\" | \"Asia/Famagusta\" | \"Asia/Gaza\" | \"Asia/Hebron\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Hong_Kong\" | \"Asia/Hovd\" | \"Asia/Irkutsk\" | \"Asia/Jakarta\" | \"Asia/Jayapura\" | \"Asia/Jerusalem\" | \"Asia/Kabul\" | \"Asia/Kamchatka\" | \"Asia/Karachi\" | \"Asia/Kathmandu\" | \"Asia/Khandyga\" | \"Asia/Kolkata\" | \"Asia/Krasnoyarsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Kuching\" | \"Asia/Macau\" | \"Asia/Magadan\" | \"Asia/Makassar\" | \"Asia/Manila\" | \"Asia/Nicosia\" | \"Asia/Novokuznetsk\" | \"Asia/Novosibirsk\" | \"Asia/Omsk\" | \"Asia/Oral\" | \"Asia/Pontianak\" | \"Asia/Pyongyang\" | \"Asia/Qatar\" | \"Asia/Qostanay\" | \"Asia/Qyzylorda\" | \"Asia/Riyadh\" | \"Asia/Sakhalin\" | \"Asia/Samarkand\" | \"Asia/Seoul\" | \"Asia/Shanghai\" | \"Asia/Singapore\" | \"Asia/Srednekolymsk\" | \"Asia/Taipei\" | \"Asia/Tashkent\" | \"Asia/Tbilisi\" | \"Asia/Tehran\" | \"Asia/Thimphu\" | \"Asia/Tokyo\" | \"Asia/Tomsk\" | \"Asia/Ulaanbaatar\" | \"Asia/Urumqi\" | \"Asia/Ust-Nera\" | \"Asia/Vladivostok\" | \"Asia/Yakutsk\" | \"Asia/Yangon\" | \"Asia/Yekaterinburg\" | \"Asia/Yerevan\" | \"Atlantic/Azores\" | \"Atlantic/Bermuda\" | \"Atlantic/Canary\" | \"Atlantic/Cape_Verde\" | \"Atlantic/Faroe\" | \"Atlantic/Madeira\" | \"Atlantic/Reykjavik\" | \"Atlantic/South_Georgia\" | \"Atlantic/Stanley\" | \"Australia/Adelaide\" | \"Australia/Brisbane\" | \"Australia/Broken_Hill\" | \"Australia/Darwin\" | \"Australia/Eucla\" | \"Australia/Hobart\" | \"Australia/Lindeman\" | \"Australia/Lord_Howe\" | \"Australia/Melbourne\" | \"Australia/Perth\" | \"Australia/Sydney\" | \"CET\" | \"CST6CDT\" | \"EET\" | \"EST\" | \"EST5EDT\" | \"Etc/GMT\" | \"Etc/GMT-1\" | \"Etc/GMT-10\" | \"Etc/GMT-11\" | \"Etc/GMT-12\" | \"Etc/GMT-13\" | \"Etc/GMT-14\" | \"Etc/GMT-2\" | \"Etc/GMT-3\" | \"Etc/GMT-4\" | \"Etc/GMT-5\" | \"Etc/GMT-6\" | \"Etc/GMT-7\" | \"Etc/GMT-8\" | \"Etc/GMT-9\" | \"Etc/GMT+1\" | \"Etc/GMT+10\" | \"Etc/GMT+11\" | \"Etc/GMT+12\" | \"Etc/GMT+2\" | \"Etc/GMT+3\" | \"Etc/GMT+4\" | \"Etc/GMT+5\" | \"Etc/GMT+6\" | \"Etc/GMT+7\" | \"Etc/GMT+8\" | \"Etc/GMT+9\" | \"Etc/UTC\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Astrakhan\" | \"Europe/Athens\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Brussels\" | \"Europe/Bucharest\" | \"Europe/Budapest\" | \"Europe/Chisinau\" | \"Europe/Copenhagen\" | \"Europe/Dublin\" | \"Europe/Gibraltar\" | \"Europe/Helsinki\" | \"Europe/Istanbul\" | \"Europe/Kaliningrad\" | \"Europe/Kiev\" | \"Europe/Kirov\" | \"Europe/Lisbon\" | \"Europe/London\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Malta\" | \"Europe/Minsk\" | \"Europe/Monaco\" | \"Europe/Moscow\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Prague\" | \"Europe/Riga\" | \"Europe/Rome\" | \"Europe/Samara\" | \"Europe/Saratov\" | \"Europe/Simferopol\" | \"Europe/Sofia\" | \"Europe/Stockholm\" | \"Europe/Tallinn\" | \"Europe/Tirane\" | \"Europe/Ulyanovsk\" | \"Europe/Uzhgorod\" | \"Europe/Vienna\" | \"Europe/Vilnius\" | \"Europe/Volgograd\" | \"Europe/Warsaw\" | \"Europe/Zaporozhye\" | \"Europe/Zurich\" | \"HST\" | \"Indian/Chagos\" | \"Indian/Christmas\" | \"Indian/Cocos\" | \"Indian/Kerguelen\" | \"Indian/Mahe\" | \"Indian/Maldives\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"MET\" | \"MST\" | \"MST7MDT\" | \"Pacific/Apia\" | \"Pacific/Auckland\" | \"Pacific/Bougainville\" | \"Pacific/Chatham\" | \"Pacific/Chuuk\" | \"Pacific/Easter\" | \"Pacific/Efate\" | \"Pacific/Fakaofo\" | \"Pacific/Fiji\" | \"Pacific/Funafuti\" | \"Pacific/Galapagos\" | \"Pacific/Gambier\" | \"Pacific/Guadalcanal\" | \"Pacific/Guam\" | \"Pacific/Honolulu\" | \"Pacific/Kanton\" | \"Pacific/Kiritimati\" | \"Pacific/Kosrae\" | \"Pacific/Kwajalein\" | \"Pacific/Majuro\" | \"Pacific/Marquesas\" | \"Pacific/Nauru\" | \"Pacific/Niue\" | \"Pacific/Norfolk\" | \"Pacific/Noumea\" | \"Pacific/Pago_Pago\" | \"Pacific/Palau\" | \"Pacific/Pitcairn\" | \"Pacific/Pohnpei\" | \"Pacific/Port_Moresby\" | \"Pacific/Rarotonga\" | \"Pacific/Tahiti\" | \"Pacific/Tarawa\" | \"Pacific/Tongatapu\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"PST8PDT\" | \"WET\"", + "value": "\"Africa/Abidjan\" | \"Africa/Algiers\" | \"Africa/Bissau\" | \"Africa/Cairo\" | \"Africa/Casablanca\" | \"Africa/Ceuta\" | \"Africa/El_Aaiun\" | \"Africa/Johannesburg\" | \"Africa/Juba\" | \"Africa/Khartoum\" | \"Africa/Lagos\" | \"Africa/Maputo\" | \"Africa/Monrovia\" | \"Africa/Nairobi\" | \"Africa/Ndjamena\" | \"Africa/Sao_Tome\" | \"Africa/Tripoli\" | \"Africa/Tunis\" | \"Africa/Windhoek\" | \"America/Adak\" | \"America/Anchorage\" | \"America/Araguaina\" | \"America/Argentina/Buenos_Aires\" | \"America/Argentina/Catamarca\" | \"America/Argentina/Cordoba\" | \"America/Argentina/Jujuy\" | \"America/Argentina/La_Rioja\" | \"America/Argentina/Mendoza\" | \"America/Argentina/Rio_Gallegos\" | \"America/Argentina/Salta\" | \"America/Argentina/San_Juan\" | \"America/Argentina/San_Luis\" | \"America/Argentina/Tucuman\" | \"America/Argentina/Ushuaia\" | \"America/Asuncion\" | \"America/Bahia\" | \"America/Bahia_Banderas\" | \"America/Barbados\" | \"America/Belem\" | \"America/Belize\" | \"America/Boa_Vista\" | \"America/Bogota\" | \"America/Boise\" | \"America/Cambridge_Bay\" | \"America/Campo_Grande\" | \"America/Cancun\" | \"America/Caracas\" | \"America/Cayenne\" | \"America/Chicago\" | \"America/Chihuahua\" | \"America/Costa_Rica\" | \"America/Cuiaba\" | \"America/Danmarkshavn\" | \"America/Dawson\" | \"America/Dawson_Creek\" | \"America/Denver\" | \"America/Detroit\" | \"America/Edmonton\" | \"America/Eirunepe\" | \"America/El_Salvador\" | \"America/Fort_Nelson\" | \"America/Fortaleza\" | \"America/Glace_Bay\" | \"America/Goose_Bay\" | \"America/Grand_Turk\" | \"America/Guatemala\" | \"America/Guayaquil\" | \"America/Guyana\" | \"America/Halifax\" | \"America/Havana\" | \"America/Hermosillo\" | \"America/Indiana/Indianapolis\" | \"America/Indiana/Knox\" | \"America/Indiana/Marengo\" | \"America/Indiana/Petersburg\" | \"America/Indiana/Tell_City\" | \"America/Indiana/Vevay\" | \"America/Indiana/Vincennes\" | \"America/Indiana/Winamac\" | \"America/Inuvik\" | \"America/Iqaluit\" | \"America/Jamaica\" | \"America/Juneau\" | \"America/Kentucky/Louisville\" | \"America/Kentucky/Monticello\" | \"America/La_Paz\" | \"America/Lima\" | \"America/Los_Angeles\" | \"America/Maceio\" | \"America/Managua\" | \"America/Manaus\" | \"America/Martinique\" | \"America/Matamoros\" | \"America/Mazatlan\" | \"America/Menominee\" | \"America/Merida\" | \"America/Metlakatla\" | \"America/Mexico_City\" | \"America/Miquelon\" | \"America/Moncton\" | \"America/Monterrey\" | \"America/Montevideo\" | \"America/New_York\" | \"America/Nipigon\" | \"America/Nome\" | \"America/Noronha\" | \"America/North_Dakota/Beulah\" | \"America/North_Dakota/Center\" | \"America/North_Dakota/New_Salem\" | \"America/Nuuk\" | \"America/Ojinaga\" | \"America/Panama\" | \"America/Pangnirtung\" | \"America/Paramaribo\" | \"America/Phoenix\" | \"America/Port-au-Prince\" | \"America/Porto_Velho\" | \"America/Puerto_Rico\" | \"America/Punta_Arenas\" | \"America/Rainy_River\" | \"America/Rankin_Inlet\" | \"America/Recife\" | \"America/Regina\" | \"America/Resolute\" | \"America/Rio_Branco\" | \"America/Santarem\" | \"America/Santiago\" | \"America/Santo_Domingo\" | \"America/Sao_Paulo\" | \"America/Scoresbysund\" | \"America/Sitka\" | \"America/St_Johns\" | \"America/Swift_Current\" | \"America/Tegucigalpa\" | \"America/Thule\" | \"America/Thunder_Bay\" | \"America/Tijuana\" | \"America/Toronto\" | \"America/Vancouver\" | \"America/Whitehorse\" | \"America/Winnipeg\" | \"America/Yakutat\" | \"America/Yellowknife\" | \"Antarctica/Casey\" | \"Antarctica/Davis\" | \"Antarctica/Macquarie\" | \"Antarctica/Mawson\" | \"Antarctica/Palmer\" | \"Antarctica/Rothera\" | \"Antarctica/Troll\" | \"Antarctica/Vostok\" | \"Asia/Almaty\" | \"Asia/Amman\" | \"Asia/Anadyr\" | \"Asia/Aqtau\" | \"Asia/Aqtobe\" | \"Asia/Ashgabat\" | \"Asia/Atyrau\" | \"Asia/Baghdad\" | \"Asia/Baku\" | \"Asia/Bangkok\" | \"Asia/Barnaul\" | \"Asia/Beirut\" | \"Asia/Bishkek\" | \"Asia/Brunei\" | \"Asia/Chita\" | \"Asia/Choibalsan\" | \"Asia/Colombo\" | \"Asia/Damascus\" | \"Asia/Dhaka\" | \"Asia/Dili\" | \"Asia/Dubai\" | \"Asia/Dushanbe\" | \"Asia/Famagusta\" | \"Asia/Gaza\" | \"Asia/Hebron\" | \"Asia/Ho_Chi_Minh\" | \"Asia/Hong_Kong\" | \"Asia/Hovd\" | \"Asia/Irkutsk\" | \"Asia/Jakarta\" | \"Asia/Jayapura\" | \"Asia/Jerusalem\" | \"Asia/Kabul\" | \"Asia/Kamchatka\" | \"Asia/Karachi\" | \"Asia/Kathmandu\" | \"Asia/Khandyga\" | \"Asia/Kolkata\" | \"Asia/Krasnoyarsk\" | \"Asia/Kuala_Lumpur\" | \"Asia/Kuching\" | \"Asia/Macau\" | \"Asia/Magadan\" | \"Asia/Makassar\" | \"Asia/Manila\" | \"Asia/Nicosia\" | \"Asia/Novokuznetsk\" | \"Asia/Novosibirsk\" | \"Asia/Omsk\" | \"Asia/Oral\" | \"Asia/Pontianak\" | \"Asia/Pyongyang\" | \"Asia/Qatar\" | \"Asia/Qostanay\" | \"Asia/Qyzylorda\" | \"Asia/Riyadh\" | \"Asia/Sakhalin\" | \"Asia/Samarkand\" | \"Asia/Seoul\" | \"Asia/Shanghai\" | \"Asia/Singapore\" | \"Asia/Srednekolymsk\" | \"Asia/Taipei\" | \"Asia/Tashkent\" | \"Asia/Tbilisi\" | \"Asia/Tehran\" | \"Asia/Thimphu\" | \"Asia/Tokyo\" | \"Asia/Tomsk\" | \"Asia/Ulaanbaatar\" | \"Asia/Urumqi\" | \"Asia/Ust-Nera\" | \"Asia/Vladivostok\" | \"Asia/Yakutsk\" | \"Asia/Yangon\" | \"Asia/Yekaterinburg\" | \"Asia/Yerevan\" | \"Atlantic/Azores\" | \"Atlantic/Bermuda\" | \"Atlantic/Canary\" | \"Atlantic/Cape_Verde\" | \"Atlantic/Faroe\" | \"Atlantic/Madeira\" | \"Atlantic/Reykjavik\" | \"Atlantic/South_Georgia\" | \"Atlantic/Stanley\" | \"Australia/Adelaide\" | \"Australia/Brisbane\" | \"Australia/Broken_Hill\" | \"Australia/Darwin\" | \"Australia/Eucla\" | \"Australia/Hobart\" | \"Australia/Lindeman\" | \"Australia/Lord_Howe\" | \"Australia/Melbourne\" | \"Australia/Perth\" | \"Australia/Sydney\" | \"CET\" | \"CST6CDT\" | \"EET\" | \"EST\" | \"EST5EDT\" | \"Etc/GMT\" | \"Etc/GMT-1\" | \"Etc/GMT-10\" | \"Etc/GMT-11\" | \"Etc/GMT-12\" | \"Etc/GMT-13\" | \"Etc/GMT-14\" | \"Etc/GMT-2\" | \"Etc/GMT-3\" | \"Etc/GMT-4\" | \"Etc/GMT-5\" | \"Etc/GMT-6\" | \"Etc/GMT-7\" | \"Etc/GMT-8\" | \"Etc/GMT-9\" | \"Etc/GMT+1\" | \"Etc/GMT+10\" | \"Etc/GMT+11\" | \"Etc/GMT+12\" | \"Etc/GMT+2\" | \"Etc/GMT+3\" | \"Etc/GMT+4\" | \"Etc/GMT+5\" | \"Etc/GMT+6\" | \"Etc/GMT+7\" | \"Etc/GMT+8\" | \"Etc/GMT+9\" | \"Etc/UTC\" | \"Europe/Amsterdam\" | \"Europe/Andorra\" | \"Europe/Astrakhan\" | \"Europe/Athens\" | \"Europe/Belgrade\" | \"Europe/Berlin\" | \"Europe/Brussels\" | \"Europe/Bucharest\" | \"Europe/Budapest\" | \"Europe/Chisinau\" | \"Europe/Copenhagen\" | \"Europe/Dublin\" | \"Europe/Gibraltar\" | \"Europe/Helsinki\" | \"Europe/Istanbul\" | \"Europe/Kaliningrad\" | \"Europe/Kiev\" | \"Europe/Kirov\" | \"Europe/Lisbon\" | \"Europe/London\" | \"Europe/Luxembourg\" | \"Europe/Madrid\" | \"Europe/Malta\" | \"Europe/Minsk\" | \"Europe/Monaco\" | \"Europe/Moscow\" | \"Europe/Oslo\" | \"Europe/Paris\" | \"Europe/Prague\" | \"Europe/Riga\" | \"Europe/Rome\" | \"Europe/Samara\" | \"Europe/Saratov\" | \"Europe/Simferopol\" | \"Europe/Sofia\" | \"Europe/Stockholm\" | \"Europe/Tallinn\" | \"Europe/Tirane\" | \"Europe/Ulyanovsk\" | \"Europe/Uzhgorod\" | \"Europe/Vienna\" | \"Europe/Vilnius\" | \"Europe/Volgograd\" | \"Europe/Warsaw\" | \"Europe/Zaporozhye\" | \"Europe/Zurich\" | \"HST\" | \"Indian/Chagos\" | \"Indian/Christmas\" | \"Indian/Cocos\" | \"Indian/Kerguelen\" | \"Indian/Mahe\" | \"Indian/Maldives\" | \"Indian/Mauritius\" | \"Indian/Reunion\" | \"MET\" | \"MST\" | \"MST7MDT\" | \"Pacific/Apia\" | \"Pacific/Auckland\" | \"Pacific/Bougainville\" | \"Pacific/Chatham\" | \"Pacific/Chuuk\" | \"Pacific/Easter\" | \"Pacific/Efate\" | \"Pacific/Fakaofo\" | \"Pacific/Fiji\" | \"Pacific/Funafuti\" | \"Pacific/Galapagos\" | \"Pacific/Gambier\" | \"Pacific/Guadalcanal\" | \"Pacific/Guam\" | \"Pacific/Honolulu\" | \"Pacific/Kanton\" | \"Pacific/Kiritimati\" | \"Pacific/Kosrae\" | \"Pacific/Kwajalein\" | \"Pacific/Majuro\" | \"Pacific/Marquesas\" | \"Pacific/Nauru\" | \"Pacific/Niue\" | \"Pacific/Norfolk\" | \"Pacific/Noumea\" | \"Pacific/Pago_Pago\" | \"Pacific/Palau\" | \"Pacific/Pitcairn\" | \"Pacific/Pohnpei\" | \"Pacific/Port_Moresby\" | \"Pacific/Rarotonga\" | \"Pacific/Tahiti\" | \"Pacific/Tarawa\" | \"Pacific/Tongatapu\" | \"Pacific/Wake\" | \"Pacific/Wallis\" | \"PST8PDT\" | \"WET\"" + }, + "value": "export function useTimezone<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): Timezone {\n const {localization} = useApi();\n\n return useSubscription(localization.timezone);\n}" + } + }, + "UseTranslateGeneratedType": { + "src/surfaces/checkout/preact/translate.ts": { + "filePath": "src/surfaces/checkout/preact/translate.ts", + "name": "UseTranslateGeneratedType", + "description": "Returns the `I18nTranslate` interface used to translate strings.", + "isPublicDocs": true, + "params": [], + "returns": { + "filePath": "src/surfaces/checkout/preact/translate.ts", + "description": "", + "name": "I18nTranslate", + "value": "I18nTranslate" + }, + "value": "export function useTranslate<\n Target extends RenderExtensionTarget = RenderExtensionTarget,\n>(): I18nTranslate {\n const api = useApi();\n return api.i18n.translate.bind(api.i18n);\n}" + } + } +} \ No newline at end of file diff --git a/packages/ui-extensions/docs/surfaces/checkout/generated/targets.json b/packages/ui-extensions/docs/surfaces/checkout/generated/targets.json new file mode 100644 index 0000000000..e70e2b820f --- /dev/null +++ b/packages/ui-extensions/docs/surfaces/checkout/generated/targets.json @@ -0,0 +1,5799 @@ +{ + "purchase.checkout.actions.render-before": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.cart-line-list.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.cart-line-item.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLineItemApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.contact.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.delivery-address.render-before": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.delivery-address.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.block.render": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.thank-you.block.render": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "OrderConfirmationApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.thank-you.cart-line-item.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLineItemApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "OrderConfirmationApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.thank-you.cart-line-list.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "OrderConfirmationApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.thank-you.customer-information.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "OrderConfirmationApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.payment-method-list.render-before": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.payment-method-list.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.reductions.render-before": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.reductions.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.shipping-option-list.render-before": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShippingOptionListApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.shipping-option-list.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShippingOptionListApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.pickup-location-list.render-before": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "PickupLocationListApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.pickup-location-list.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "PickupLocationListApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.shipping-option-item.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShippingOptionItemApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.shipping-option-item.details.render": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShippingOptionItemApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.pickup-point-list.render-before": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "PickupPointListApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.pickup-point-list.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "PickupPointListApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.pickup-location-option-item.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "PickupLocationItemApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.header.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.footer.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.checkout.chat.render": { + "components": [ + "Chat" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.thank-you.header.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "OrderConfirmationApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.thank-you.footer.render-after": { + "components": [ + "Abbreviation", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "OrderConfirmationApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.thank-you.chat.render": { + "components": [ + "Chat" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "OrderConfirmationApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.thank-you.announcement.render": { + "components": [ + "Abbreviation", + "Announcement", + "Badge", + "Banner", + "Box", + "Button", + "Chat", + "Checkbox", + "Chip", + "Choice", + "ChoiceList", + "Clickable", + "ClickableChip", + "ClipboardItem", + "ConsentCheckbox", + "ConsentPhoneField", + "DateField", + "DatePicker", + "Details", + "Divider", + "DropZone", + "EmailField", + "Form", + "Grid", + "GridItem", + "Heading", + "Icon", + "Image", + "Link", + "ListItem", + "Map", + "MapMarker", + "Modal", + "MoneyField", + "NumberField", + "Option", + "OrderedList", + "Paragraph", + "PasswordField", + "PaymentIcon", + "PhoneField", + "Popover", + "PressButton", + "ProductThumbnail", + "Progress", + "QRCode", + "QueryContainer", + "ScrollBox", + "Section", + "Select", + "Sheet", + "SkeletonParagraph", + "Spinner", + "Stack", + "Summary", + "Switch", + "Text", + "TextArea", + "TextField", + "Time", + "Tooltip", + "UnorderedList", + "UrlField" + ], + "apis": [ + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "BuyerIdentityApi", + "BuyerJourneyApi", + "CartInstructionsApi", + "CartLinesApi", + "CheckoutTokenApi", + "CostApi", + "CustomerPrivacyApi", + "DeliveryApi", + "DiscountsApi", + "ExtensionApi", + "GiftCardsApi", + "LocalizationApi", + "LocalizedFieldsApi", + "MetafieldsApi", + "NoteApi", + "OrderConfirmationApi", + "PaymentsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.address-autocomplete.suggest": { + "components": [], + "apis": [ + "AddressAutocompleteSuggestApi", + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "CheckoutTokenApi", + "ExtensionApi", + "LocalizationApi", + "MetafieldsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "purchase.address-autocomplete.format-suggestion": { + "components": [], + "apis": [ + "AddressAutocompleteFormatSuggestionApi", + "AddressesApi", + "AnalyticsApi", + "AttributesApi", + "CheckoutTokenApi", + "ExtensionApi", + "LocalizationApi", + "MetafieldsApi", + "SessionTokenApi", + "SettingsApi", + "ShopApi", + "StorageApi", + "StorefrontApi" + ] + }, + "AddressesApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "AnalyticsApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "AttributesApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "BuyerIdentityApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "BuyerJourneyApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "CartInstructionsApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "CartLinesApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "CheckoutTokenApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "CostApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "CustomerPrivacyApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "DeliveryApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "DiscountsApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ExtensionApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "GiftCardsApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "LocalizationApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "LocalizedFieldsApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "MetafieldsApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "NoteApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "PaymentsApi": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "SessionTokenApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "SettingsApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ShopApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "StorageApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "StorefrontApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "CartLineItemApi": { + "targets": [ + "purchase.checkout.cart-line-item.render-after", + "purchase.thank-you.cart-line-item.render-after" + ] + }, + "OrderConfirmationApi": { + "targets": [ + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ShippingOptionListApi": { + "targets": [ + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before" + ] + }, + "PickupLocationListApi": { + "targets": [ + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before" + ] + }, + "ShippingOptionItemApi": { + "targets": [ + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after" + ] + }, + "PickupPointListApi": { + "targets": [ + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before" + ] + }, + "PickupLocationItemApi": { + "targets": [ + "purchase.checkout.pickup-location-option-item.render-after" + ] + }, + "AddressAutocompleteSuggestApi": { + "targets": [ + "purchase.address-autocomplete.suggest" + ] + }, + "AddressAutocompleteFormatSuggestionApi": { + "targets": [ + "purchase.address-autocomplete.format-suggestion" + ] + }, + "Abbreviation": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Badge": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Banner": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Box": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Button": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Chat": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Checkbox": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Chip": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Choice": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ChoiceList": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Clickable": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ClickableChip": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ClipboardItem": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ConsentCheckbox": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ConsentPhoneField": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "DateField": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "DatePicker": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Details": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Divider": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "DropZone": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "EmailField": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Form": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Grid": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "GridItem": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Heading": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Icon": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Image": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Link": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ListItem": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Map": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "MapMarker": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Modal": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "MoneyField": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "NumberField": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Option": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "OrderedList": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Paragraph": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "PasswordField": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "PaymentIcon": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "PhoneField": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Popover": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "PressButton": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ProductThumbnail": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Progress": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "QRCode": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "QueryContainer": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "ScrollBox": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Section": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Select": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Sheet": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "SkeletonParagraph": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Spinner": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Stack": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Summary": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Switch": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Text": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "TextArea": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "TextField": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Time": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Tooltip": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "UnorderedList": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "UrlField": { + "targets": [ + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + }, + "Announcement": { + "targets": [ + "purchase.thank-you.announcement.render" + ] + }, + "StyleHelper": { + "targets": [ + "purchase.address-autocomplete.format-suggestion", + "purchase.address-autocomplete.suggest", + "purchase.checkout.actions.render-before", + "purchase.checkout.block.render", + "purchase.checkout.cart-line-item.render-after", + "purchase.checkout.cart-line-list.render-after", + "purchase.checkout.chat.render", + "purchase.checkout.contact.render-after", + "purchase.checkout.delivery-address.render-after", + "purchase.checkout.delivery-address.render-before", + "purchase.checkout.footer.render-after", + "purchase.checkout.header.render-after", + "purchase.checkout.payment-method-list.render-after", + "purchase.checkout.payment-method-list.render-before", + "purchase.checkout.pickup-location-list.render-after", + "purchase.checkout.pickup-location-list.render-before", + "purchase.checkout.pickup-location-option-item.render-after", + "purchase.checkout.pickup-point-list.render-after", + "purchase.checkout.pickup-point-list.render-before", + "purchase.checkout.reductions.render-after", + "purchase.checkout.reductions.render-before", + "purchase.checkout.shipping-option-item.details.render", + "purchase.checkout.shipping-option-item.render-after", + "purchase.checkout.shipping-option-list.render-after", + "purchase.checkout.shipping-option-list.render-before", + "purchase.thank-you.announcement.render", + "purchase.thank-you.block.render", + "purchase.thank-you.cart-line-item.render-after", + "purchase.thank-you.cart-line-list.render-after", + "purchase.thank-you.chat.render", + "purchase.thank-you.customer-information.render-after", + "purchase.thank-you.footer.render-after", + "purchase.thank-you.header.render-after" + ] + } +} \ No newline at end of file diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts deleted file mode 100644 index fc49bc9db2..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/address.doc.ts +++ /dev/null @@ -1,50 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, - CHECKOUT_API_PROPERTIES_DESCRIPTION, - REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Addresses', - description: 'The API for interacting with addresses.', - isVisualComponent: false, - requires: REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_AddressApi', - }, - { - title: 'CheckoutApi', - description: CHECKOUT_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Checkout_AddressApi', - }, - { - title: 'useBillingAddress', - description: - 'Returns the proposed `billingAddress` applied to the checkout.', - type: 'UseBillingAddressGeneratedType', - }, - { - title: 'useShippingAddress', - description: - 'Returns the proposed `shippingAddress` applied to the checkout.', - type: 'UseShippingAddressGeneratedType', - }, - { - title: 'useApplyShippingAddressChange', - description: - 'Returns a function to mutate the `shippingAddress` property of checkout.', - type: 'UseApplyShippingAddressChangeGeneratedType', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts deleted file mode 100644 index 4439fdf4c7..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/analytics.doc.ts +++ /dev/null @@ -1,30 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Analytics', - description: 'The API for interacting with web pixels.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_AnalyticsApi', - }, - ], - defaultExample: getExample('analytics-publish', ['jsx']), - examples: { - description: '', - examples: [getExample('analytics-visitor', ['jsx'])], - }, - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts deleted file mode 100644 index 0dfa4e2789..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/attributes.doc.ts +++ /dev/null @@ -1,54 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - STANDARD_API_PROPERTIES_DESCRIPTION, - CHECKOUT_API_PROPERTIES_DESCRIPTION, - getLinksByTag, - getHookExample, - getExample, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Attributes', - description: 'The API for interacting with cart and checkout attributes.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_AttributesApi', - }, - { - title: 'CheckoutApi', - description: CHECKOUT_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Checkout_AttributesApi', - }, - { - title: 'useApplyAttributeChange', - description: - 'Returns a function to mutate the `attributes` property of the checkout.', - type: 'UseApplyAttributeChangeGeneratedType', - }, - { - title: 'useAttributes', - description: 'Returns the proposed `attributes` applied to the checkout.', - type: 'UseAttributesGeneratedType', - }, - { - title: 'useAttributeValues', - description: - 'Returns the values for the specified `attributes` applied to the checkout.', - type: 'UseAttributeValuesGeneratedType', - }, - ], - defaultExample: getExample('attribute-values', ['jsx']), - examples: { - description: '', - examples: [getExample('attributes/attribute-change', ['jsx'])], - }, - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts deleted file mode 100644 index ac5a92e7d4..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-identity.doc.ts +++ /dev/null @@ -1,50 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - STANDARD_API_PROPERTIES_DESCRIPTION, - REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2, - getLinksByTag, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Buyer Identity', - description: 'The API for interacting with the buyer identity.', - requires: REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2, - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_BuyerIdentityApi', - }, - { - title: 'useCustomer', - description: - "Returns the current `Customer`. The value is `undefined` if the buyer isn't a known customer for this shop or if they haven't logged in yet.", - type: 'UseCustomerGeneratedType', - }, - { - title: 'useEmail', - description: - 'Returns the email address of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.', - type: 'UseEmailGeneratedType', - }, - { - title: 'usePhone', - description: - 'Returns the phone number of the buyer that is interacting with the cart. The value is `undefined` if the app does not have access to customer data.', - type: 'UsePhoneGeneratedType', - }, - { - title: 'usePurchasingCompany', - description: - "Provides information about the company and its location that the business customer is purchasing on behalf of during a B2B checkout. It includes details that can be utilized to identify both the company and its corresponding location to which the business customer belongs. \n \n The value is `undefined` if a business customer isn't logged in. This function throws an error if the app doesn't have access to customer data.", - type: 'UsePurchasingCompanyGeneratedType', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts deleted file mode 100644 index 8c4cd2bdc5..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/buyer-journey.doc.ts +++ /dev/null @@ -1,83 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - STANDARD_API_PROPERTIES_DESCRIPTION, - getExample, - getLinksByTag, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Buyer Journey', - description: 'The API for interacting with the buyer journey.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_BuyerJourneyApi', - }, - { - title: 'useBuyerJourney', - description: - 'Returns the buyerJourney details on buyer progression in checkout.', - type: 'UseBuyerJourneyGeneratedType', - }, - { - title: 'useBuyerJourneyCompleted', - description: ` - Returns \`true\` if the buyer completed submitting their order. - For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order. - `, - type: 'UseBuyerJourneyCompletedGeneratedType', - }, - { - title: 'useBuyerJourneyIntercept', - description: ` - Installs a function for intercepting and preventing progress on checkout. - To block checkout progress, you must set the [block_progress](/docs/api/checkout-ui-extensions/configuration#block-progress) capability in your extension's configuration. - If you do, then you're expected to inform the buyer why navigation was blocked, either by passing validation errors to the checkout UI or rendering the errors in your extension. - \`useBuyerJourneyIntercept()\` should be called at the top level of the extension, not within an embedded or child component, to avoid errors should the child component get destroyed. - It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension to block checkout progress. - `, - type: 'UseBuyerJourneyInterceptGeneratedType', - }, - { - title: 'useBuyerJourneySteps', - description: ` - Returns all possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration. - `, - type: 'UseBuyerJourneyStepsGeneratedType', - }, - { - title: 'useBuyerJourneyActiveStep', - description: ` - Returns the buyer journey step that the buyer is currently on. - `, - type: 'UseBuyerJourneyActiveStepGeneratedType', - }, - ], - defaultExample: getExample('buyer-journey-intercept/target-native-field', [ - 'jsx', - ]), - examples: { - description: - 'In addition to targeting checkout UI fields, you can also pass errors to the page level or render the error in your extension.', - examples: [ - getExample('buyer-journey-intercept/page-level-error', ['jsx']), - getExample('buyer-journey-intercept/extension-banner', ['jsx']), - ], - }, - related: [ - { - subtitle: 'Tutorial', - name: 'Validating fields at checkout', - url: '/docs/apps/checkout/validation/fields', - type: 'tutorial', - }, - ...getLinksByTag('apis'), - ], -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts deleted file mode 100644 index 2164708cc2..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-instructions.doc.ts +++ /dev/null @@ -1,44 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - STANDARD_API_PROPERTIES_DESCRIPTION, - getLinksByTag, - getExample, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Cart Instructions', - description: 'Instructions used to create the checkout.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_CartInstructionsApi', - }, - { - title: 'useInstructions', - description: - 'Returns the cart instructions used to create the checkout and possibly limit extension capabilities.', - type: 'UseInstructionsGeneratedType', - }, - ], - defaultExample: getExample('cart-instructions/discounts', ['jsx']), - examples: { - description: - 'Use the cart instructions API to determine if the affected APIs are available in checkout.', - examples: [ - getExample('cart-instructions/attributes', ['jsx']), - getExample('cart-instructions/delivery', ['jsx']), - getExample('cart-instructions/discounts', ['jsx']), - getExample('cart-instructions/cart-lines-add', ['jsx']), - getExample('cart-instructions/metafields', ['jsx']), - getExample('cart-instructions/notes', ['jsx']), - ], - }, - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts deleted file mode 100644 index c205cf10a3..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cart-lines.doc.ts +++ /dev/null @@ -1,62 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - STANDARD_API_PROPERTIES_DESCRIPTION, - CHECKOUT_API_PROPERTIES_DESCRIPTION, - getLinksByTag, - getExample, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Cart Lines', - description: 'The API for interacting with the cart lines.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_CartLinesApi', - }, - { - title: 'useCartLines', - description: - 'Returns the current line items for the checkout, and automatically re-renders your component if line items are added, removed, or updated.', - type: 'UseCartLinesGeneratedType', - }, - { - title: 'CheckoutApi', - description: CHECKOUT_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Checkout_CartLinesApi', - }, - { - title: 'useApplyCartLinesChange', - description: - 'Returns a function to mutate the `lines` property of checkout.', - type: 'UseApplyCartLinesChangeGeneratedType', - }, - { - title: 'CartLineItemApi', - description: - 'The API object provided to `cart-line-item` extension targets.', - type: 'Docs_CartLineItem_CartLinesApi', - }, - { - title: 'useTarget', - description: - 'Returns the cart line the extension is attached to. This hook can only be used by `cart-line-item` extension targets. Until version `2023-04`, this hook returned a `PresentmentCartLine object`.', - type: 'UseTargetGeneratedType', - }, - { - title: 'useCartLineTarget', - description: - 'Returns the cart line the extension is attached to. This hook can only be used by `cart-line-item` extension targets', - type: 'UseCartLineTargetGeneratedType', - }, - ], - defaultExample: getExample('cart-line-item/default', ['jsx']), - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts deleted file mode 100644 index 7e8bdcbdf9..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/checkout-token.doc.ts +++ /dev/null @@ -1,29 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Checkout Token', - description: 'The API for interacting with the token of a checkout.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_CheckoutTokenApi', - }, - { - title: 'useCheckoutToken', - description: 'Returns a stable id that represents the current checkout.', - type: 'UseCheckoutTokenGeneratedType', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts deleted file mode 100644 index 31f6d5e39f..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/cost.doc.ts +++ /dev/null @@ -1,48 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Cost', - description: 'The API for interacting with the cost of a checkout.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_CostApi', - }, - { - title: 'useSubtotalAmount', - description: - 'A `Money` value representing the subtotal value of the items in the cart at the current step of checkout.', - type: 'UseSubtotalAmountGeneratedType', - }, - { - title: 'useTotoalShippingAmount', - description: - 'Returns a `Money` value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step.', - type: 'UseTotalShippingAmountGeneratedType', - }, - { - title: 'useTotalTaxAmount', - description: - 'Returns a `Money` value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable.', - type: 'UseTotalTaxAmountGeneratedType', - }, - { - title: 'useTotalAmount', - description: - 'Returns a `Money` value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated. Applied gift cards and store credit are excluded.', - type: 'UseTotalAmountGeneratedType', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts deleted file mode 100644 index f784c52de9..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/customer-privacy.doc.ts +++ /dev/null @@ -1,37 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, - REQUIRES_PROTECTED_CUSTOMER_DATA, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Customer Privacy', - description: - "The API for interacting with a customer's privacy consent. It is similar to the [Customer Privacy API in storefront](/docs/api/customer-privacy).", - isVisualComponent: false, - requires: REQUIRES_PROTECTED_CUSTOMER_DATA, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - // replace with STANDARD_API_PROPERTIES_DESCRIPTION after Customer Privacy API has been added to customer accounts - description: - 'The base API object provided to `purchase` extension targets.', - type: 'Docs_Standard_CustomerPrivacyApi', - }, - { - title: 'useCustomerPrivacy', - description: - 'Returns the current customer privacy settings and metadata and re-renders your component if the customer privacy settings change.', - type: 'UseCustomerPrivacyGeneratedType', - }, - ], - defaultExample: getExample('customer-privacy/default', ['jsx']), - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts deleted file mode 100644 index 975eb9af94..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/delivery.doc.ts +++ /dev/null @@ -1,118 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getLinksByTag, - getHookExample, - getExample, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Delivery', - description: ` - The APIs for interacting with delivery and shipping options. - - > Tip: Not all extension targets implement all APIs. Check the documentation for the extension target you are using to see which APIs are available. - `, - overviewPreviewDescription: - 'The APIs for interacting with delivery and shipping options.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_DeliveryApi', - }, - { - title: 'useDeliveryGroup', - description: - 'Returns the full expanded details of a delivery group and automatically re-renders your component when that delivery group changes.', - type: 'UseDeliveryGroupGeneratedType', - }, - { - title: 'useDeliveryGroups', - description: - 'Returns the current delivery groups for the checkout, and automatically re-renders your component when delivery address or delivery option selection changes.', - type: 'UseDeliveryGroupsGeneratedType', - }, - { - title: 'Shipping Option', - description: - 'This API object is provided to extensions registered for the `purchase.checkout.shipping-option-item.render-after` and `purchase.checkout.shipping-option-item.details.render` extension targets.', - type: 'ShippingOptionItemApi', - }, - { - title: 'useShippingOptionTarget', - description: - 'Returns the shipping option for the `purchase.checkout.shipping-option-item.render-after` and `purchase.checkout.shipping-option-item.details.render` attached extensions.', - type: 'UseShippingOptionTargetGeneratedType', - }, - { - title: 'ShippingOptionListApi', - description: - 'This API object is provided to extensions registered for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` extension targets.', - type: 'ShippingOptionListApi', - }, - { - title: 'useDeliveryGroupTarget', - description: - 'Returns the delivery group for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` attached extensions. This is deprecated, use `useDeliveryGroupListTarget()` instead.', - type: 'UseDeliveryGroupTargetGeneratedType', - }, - { - title: 'useDeliveryGroupListTarget', - description: - 'Returns the delivery group list for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` attached extensions.', - type: 'UseDeliveryGroupListTargetGeneratedType', - }, - { - title: 'useDeliverySelectionGroups', - description: - 'Returns the delivery selection groups for the `purchase.checkout.shipping-option-list.render-before` and `purchase.checkout.shipping-option-list.render-after` attached extensions.', - type: 'UseDeliverySelectionGroupsGeneratedType', - }, - { - title: 'PickupPointListApi', - description: - 'This API object is provided to extensions registered for the `purchase.checkout.pickup-point-list.render-after` and `purchase.checkout.pickup-point-list.render-after` extension target.', - type: 'PickupPointListApi', - }, - { - title: 'PickupLocationListApi', - description: - 'This API object is provided to extensions registered for the `purchase.checkout.pickup-location-list.render-after` and `purchase.checkout.pickup-location-list.render-after` extension target.', - type: 'PickupLocationListApi', - }, - { - title: 'PickupLocationItemApi', - description: - 'The API object provided to the `purchase.checkout.pickup-location-option-item.render-after` extension target.', - type: 'PickupLocationItemApi', - }, - { - title: 'usePickupLocationOptionTarget', - description: - 'Returns the pickup location option for `purchase.checkout.pickup-location-option-item.render-after` attached extensions.', - type: 'UsePickupLocationOptionTargetGeneratedType', - }, - ], - defaultExample: getHookExample('delivery-group'), - examples: { - description: - 'Learn how to use the API with JavaScript (JS) and React. See [React Hooks](../react-hooks) for all available hooks.', - examples: [ - getExample('shipping-option-item/default', ['jsx']), - getExample( - 'purchase.checkout.pickup-location-option-item.render-after/default', - ['jsx'], - ), - getExample('pickup-point-list/default', ['jsx']), - getHookExample('delivery-groups'), - ], - }, - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts deleted file mode 100644 index e7a61d82d4..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/discounts.doc.ts +++ /dev/null @@ -1,46 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - CHECKOUT_API_PROPERTIES_DESCRIPTION, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Discounts', - description: 'The API for interacting with discounts.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_DiscountsApi', - }, - { - title: 'CheckoutApi', - description: CHECKOUT_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Checkout_DiscountsApi', - }, - { - title: 'useApplyDiscountCodeChange', - description: 'Returns a function to add or remove discount codes.', - type: 'UseApplyDiscountCodeChangeGeneratedType', - }, - { - title: 'useDiscountAllocations', - description: - 'Returns the current discount allocations applied to the cart.', - type: 'UseDiscountAllocationsGeneratedType', - }, - { - title: 'useDiscountCodes', - description: 'Returns the current discount codes applied to the cart.', - type: 'UseDiscountCodesGeneratedType', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts deleted file mode 100644 index a764fc0fa6..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/extension-meta.doc.ts +++ /dev/null @@ -1,51 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Extension', - description: 'The API for interacting with the metadata of an extension.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_ExtensionMetaApi', - }, - { - title: 'useExtension', - description: 'Returns the metadata about the extension.', - type: 'UseExtensionGeneratedType', - }, - { - title: 'useExtensionData', - description: `Returns the metadata about the extension. This is deprecated, use \`useExtension()\` instead.`, - type: 'UseExtensionDataGeneratedType', - }, - { - title: 'useExtensionCapabilities', - description: "Returns a list of an extension's granted capabilities.", - type: 'UseExtensionCapabilitiesGeneratedType', - }, - { - title: 'useExtensionCapability', - description: - 'Returns whether or not a given capability of an extension is granted.', - type: 'UseExtensionCapabilityGeneratedType', - }, - { - title: 'useExtensionEditor', - description: - 'Returns information about the editor where the extension is being rendered.', - type: 'UseExtensionEditorGeneratedType', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts deleted file mode 100644 index daa8a766f9..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/gift-cards.doc.ts +++ /dev/null @@ -1,40 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - CHECKOUT_API_PROPERTIES_DESCRIPTION, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Gift Cards', - description: 'The API for interacting with gift cards.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_GiftCardsApi', - }, - { - title: 'CheckoutApi', - description: CHECKOUT_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Checkout_GiftCardsApi', - }, - { - title: 'useAppliedGiftCards', - description: 'Returns the current gift cards applied to the cart.', - type: 'UseAppliedGiftCardsGeneratedType', - }, - { - title: 'useApplyGiftCardChange', - description: 'Returns a function to add or remove gift cards.', - type: 'UseApplyGiftCardChangeGeneratedType', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts deleted file mode 100644 index af53ca9a2f..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localization.doc.ts +++ /dev/null @@ -1,71 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Localization', - description: 'The APIs for localizing your extension.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_LocalizationApi', - }, - { - title: 'useCurrency', - description: 'Returns the currency of the checkout.', - type: 'UseCurrencyGeneratedType', - }, - { - title: 'useExtensionLanguage', - description: - "Returns the buyer's language, as supported by the extension.", - type: 'UseExtensionLanguageGeneratedType', - }, - { - title: 'useLanguage', - description: - 'Returns the current language of the checkout, and automatically re-renders your component if the language changes.', - type: 'UseLanguageGeneratedType', - }, - { - title: 'useLocalizationCountry', - description: - 'Returns the country of the checkout, and automatically re-renders your component if the country changes.', - type: 'UseLocalizationCountryGeneratedType', - }, - { - title: 'useLocalizationMarket', - description: - 'Returns the market of the checkout, and automatically re-renders your component if it changes.', - type: 'UseLocalizationMarketGeneratedType', - }, - { - title: 'useTimezone', - description: - 'Returns the time zone of the checkout, and automatically re-renders your component if the time zone changes.', - type: 'UseTimezoneGeneratedType', - }, - { - title: 'useTranslate', - description: - 'Returns the `I18nTranslate` interface used to translate strings.', - type: 'UseTranslateGeneratedType', - }, - ], - defaultExample: getExample('translate', ['jsx']), - examples: { - description: '', - examples: [getExample('translate-pluralization', ['jsx'])], - }, - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts deleted file mode 100644 index 29ede432a3..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/localized-fields.doc.ts +++ /dev/null @@ -1,40 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, - REQUIRES_PROTECTED_CUSTOMER_DATA, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Localized Fields', - description: 'The API for interacting with localized fields.', - isVisualComponent: false, - requires: REQUIRES_PROTECTED_CUSTOMER_DATA, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_LocalizedFieldsApi', - }, - { - title: 'useLocalizedFields', - description: - 'Returns the current localized fields and re-renders your component if the values change.', - type: 'UseLocalizedFieldsGeneratedType', - }, - { - title: 'useLocalizedField', - description: - 'Returns the requested localized field and re-renders your component if the value changes.', - type: 'UseLocalizedFieldGeneratedType', - }, - ], - defaultExample: getExample('localized-fields/default', ['jsx']), - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts deleted file mode 100644 index 224d7fcc39..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/metafields.doc.ts +++ /dev/null @@ -1,57 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getLinksByTag, - REQUIRES_PROTECTED_CUSTOMER_DATA, - STANDARD_API_PROPERTIES_DESCRIPTION, - CHECKOUT_API_PROPERTIES_DESCRIPTION, - getExample, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Metafields', - description: 'The API for interacting with metafields.', - isVisualComponent: false, - requires: REQUIRES_PROTECTED_CUSTOMER_DATA, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_MetafieldsApi', - }, - { - title: 'useAppMetafields', - description: - 'Returns the metafields configured with `shopify.extension.toml`.', - type: 'UseAppMetafieldsGeneratedType', - }, - { - title: 'useMetafield', - description: 'Returns a single filtered `Metafield` or `undefined`.', - type: 'UseMetafieldGeneratedType', - }, - { - title: 'useMetafields', - description: - 'Returns the current array of `metafields` applied to the checkout. You can optionally filter the list.', - type: 'UseMetafieldsGeneratedType', - }, - { - title: 'CheckoutApi', - description: CHECKOUT_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Checkout_MetafieldsApi', - }, - { - title: 'useApplyMetafieldsChange', - description: - 'Returns a function to mutate the `metafields` property of the checkout.', - type: 'UseApplyMetafieldsChangeGeneratedType', - }, - ], - defaultExample: getExample('metafields/default', ['jsx', 'toml']), - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts deleted file mode 100644 index 1b791f3bfa..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/note.doc.ts +++ /dev/null @@ -1,41 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - CHECKOUT_API_PROPERTIES_DESCRIPTION, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Note', - description: 'The API for interacting with the note applied to checkout.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_NoteApi', - }, - { - title: 'useNote', - description: 'Returns the proposed `note` applied to the checkout.', - type: 'UseNoteGeneratedType', - }, - { - title: 'CheckoutApi', - description: CHECKOUT_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Checkout_NoteApi', - }, - { - title: 'useApplyNoteChange', - description: - 'Returns a function to mutate the `note` property of the checkout.', - type: 'UseApplyNoteChangeGeneratedType', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts deleted file mode 100644 index fccd57fdd6..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/order.doc.ts +++ /dev/null @@ -1,41 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getLinksByTag, - ORDER_CONFIRMATION_API_PROPERTIES_DESCRIPTION, - getExample, - ORDER_STATUS_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -// added temporarily to keep a note that the order status api docs have been moved to customer accounts -// can be removed from 2025-01 on -// An empty interface means any no-nullish value including values like strings. -// That seems incorrect, but the lint rule was added after this interface and -// I don't want to touch this public API. - -interface OrderStatusApiEmpty {} - -const data: ReferenceEntityTemplateSchema = { - name: 'Order', - description: - 'The API for interacting with the order confirmation, available on the **Thank You** page.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - defaultExample: getExample('order-confirmation/default', ['jsx']), - definitions: [ - { - title: 'OrderConfirmationApi', - description: ORDER_CONFIRMATION_API_PROPERTIES_DESCRIPTION, - type: 'OrderConfirmationApi', - }, - { - title: 'OrderStatusApi', - description: ORDER_STATUS_API_PROPERTIES_DESCRIPTION, - type: 'OrderStatusApiEmpty', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts deleted file mode 100644 index 147bc74e3b..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/payment-options.doc.ts +++ /dev/null @@ -1,40 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getHookExample, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Payments', - description: 'The API for interacting with the payment options.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_PaymentOptionsApi', - }, - { - title: 'useAvailablePaymentOptions', - description: 'Returns all available payment options.', - type: 'UseAvailablePaymentOptionsGeneratedType', - }, - { - title: 'useSelectedPaymentOptions', - description: 'Returns payment options selected by the buyer.', - type: 'UseSelectedPaymentOptionsGeneratedType', - }, - ], - related: getLinksByTag('apis'), - defaultExample: getHookExample('payments/use-available-payment-options'), - examples: { - description: '', - examples: [getHookExample('payments/use-selected-payment-options')], - }, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts deleted file mode 100644 index 4bd6446adc..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/query.doc.ts +++ /dev/null @@ -1,30 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Storefront API', - description: 'Querying the Storefront API.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_QueryApi', - }, - ], - defaultExample: getExample('storefront-query-api', ['jsx']), - examples: { - description: '', - examples: [getExample('storefront-query-with-fetch', ['jsx'])], - }, - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts deleted file mode 100644 index 959677586f..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/session-token.doc.ts +++ /dev/null @@ -1,35 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Session Token', - description: 'The API for interacting with session tokens.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_SessionTokenApi', - }, - { - title: 'useSessionToken', - description: 'Returns a the session token API object.', - type: 'UseSessionTokenGeneratedType', - }, - ], - defaultExample: getExample('session-token', ['jsx']), - examples: { - description: '', - examples: [getExample('session-token-jwt', ['jsx'])], - }, - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts deleted file mode 100644 index 07add9ec5a..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/settings.doc.ts +++ /dev/null @@ -1,36 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Settings', - description: 'The API for interacting with merchant settings.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_SettingsApi', - }, - { - title: 'useSettings', - description: - 'Returns the setting values defined by the merchant for the extension.', - type: 'UseSettingsGeneratedType', - }, - ], - defaultExample: getExample('settings-access', ['jsx']), - examples: { - description: '', - examples: [getExample('settings', ['jsx'])], - }, - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts deleted file mode 100644 index cf475536b8..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/shop.doc.ts +++ /dev/null @@ -1,29 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Shop', - description: 'The API for interacting with shop.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_ShopApi', - }, - { - title: 'useShop', - description: 'Returns the `shop` where the checkout is taking place.', - type: 'UseShopGeneratedType', - }, - ], - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts deleted file mode 100644 index 931efadbfa..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/apis/storage.doc.ts +++ /dev/null @@ -1,32 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - STANDARD_API_PROPERTIES_DESCRIPTION, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Storage', - description: 'The API for interacting with local storage.', - isVisualComponent: false, - category: 'APIs', - type: 'API', - definitions: [ - { - title: 'StandardApi', - description: STANDARD_API_PROPERTIES_DESCRIPTION, - type: 'Docs_Standard_StorageApi', - }, - { - title: 'useStorage', - description: - 'Returns the key-value `Storage` interface for the extension target.', - type: 'UseStorageGeneratedType', - }, - ], - defaultExample: getExample('storage', ['jsx']), - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/extension-targets.example.toml b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/extension-targets.example.toml index 3196f64934..1e2675f28f 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/extension-targets.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/extension-targets.example.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] name = "My checkout extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-item.render-after/default.example.tsx b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-item.render-after/default.example.tsx index 5d4f93410f..5de34e9efd 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-item.render-after/default.example.tsx +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-item.render-after/default.example.tsx @@ -1,4 +1,4 @@ -import {render, Fragment} from 'preact'; +import {render} from 'preact'; import {useShippingOptionTarget} from '@shopify/ui-extensions/checkout/preact'; @@ -7,56 +7,22 @@ export default function extension() { } function Extension() { - const { - shippingOptionTarget, - isTargetSelected, - renderMode, - } = useShippingOptionTarget(); + const {shippingOptionTarget, isTargetSelected} = + useShippingOptionTarget(); const { cost: {amount, currencyCode}, title, } = shippingOptionTarget; - // When the target is rendered inside the "More shipping options" modal for split shipping scenarios, `renderMode.overlay` is true. This check allows to render an alternative UI to avoid nested modals. - if (renderMode.overlay) { - return ( - - Shipping method: {title} is{' '} - {isTargetSelected ? '' : 'not'} selected. - - ); - } - - // When the target is rendered inline for both split shipping and non-split shipping scenarios, a Modal can be rendered if desired. return ( - - - View details ({title} is{' '} - {isTargetSelected ? '' : 'not'} selected) - - - - Cost:{' '} - {Intl.NumberFormat(undefined, { - style: 'currency', - currency: currencyCode, - }).format(amount)} - - - shopify.ui.overlay.close('my-modal') - } - > - Close - - - + + Shipping method: {title} is{' '} + {isTargetSelected ? '' : 'not '}selected. + Cost:{' '} + {Intl.NumberFormat(undefined, { + style: 'currency', + currency: currencyCode, + }).format(amount)} + ); } diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-after/default.example.tsx b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-after/default.example.tsx index 87e8227e60..c59c15e4f2 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-after/default.example.tsx +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-after/default.example.tsx @@ -59,12 +59,14 @@ function Extension() { async function onCheckboxChange(isChecked) { setChecked(isChecked); const result = - await shopify.applyMetafieldsChange({ - type: 'updateMetafield', - namespace: metafieldNamespace, - key: metafieldKey, - value: isChecked ? 'yes' : 'no', - valueType: 'string', + await shopify.applyMetafieldChange({ + type: 'updateCartMetafield', + metafield: { + namespace: metafieldNamespace, + key: metafieldKey, + value: isChecked ? 'yes' : 'no', + type: 'single_line_text_field', + }, }); console.log( 'applyMetafieldsChange result', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-before/default.example.tsx b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-before/default.example.tsx index 87e8227e60..c59c15e4f2 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-before/default.example.tsx +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/purchase.checkout.shipping-option-list.render-before/default.example.tsx @@ -59,12 +59,14 @@ function Extension() { async function onCheckboxChange(isChecked) { setChecked(isChecked); const result = - await shopify.applyMetafieldsChange({ - type: 'updateMetafield', - namespace: metafieldNamespace, - key: metafieldKey, - value: isChecked ? 'yes' : 'no', - valueType: 'string', + await shopify.applyMetafieldChange({ + type: 'updateCartMetafield', + metafield: { + namespace: metafieldNamespace, + key: metafieldKey, + value: isChecked ? 'yes' : 'no', + type: 'single_line_text_field', + }, }); console.log( 'applyMetafieldsChange result', diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/settings.example.toml b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/settings.example.toml index caf0bd31fb..4993e49484 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/settings.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/settings.example.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] name = "My checkout extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/ui-components/overlay-close.example.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/examples/ui-components/overlay-close.example.ts deleted file mode 100644 index 67b0a06eee..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/examples/ui-components/overlay-close.example.ts +++ /dev/null @@ -1,46 +0,0 @@ -import { - extension, - Button, - Link, - Modal, - TextBlock, -} from '@shopify/ui-extensions/checkout'; - -export default extension( - 'purchase.checkout.block.render', - (root, {ui}) => { - const modalFragment = root.createFragment(); - const modal = root.createComponent( - Modal, - { - id: 'my-modal', - padding: true, - title: 'Return policy', - }, - root.createComponent( - TextBlock, - {}, - 'We have a 30-day return policy.', - ), - root.createComponent( - Button, - { - onPress: () => - ui.overlay.close('my-modal'), - }, - 'Close', - ), - ); - modalFragment.appendChild(modal); - - const link = root.createComponent( - Link, - { - overlay: modalFragment, - }, - 'Return policy', - ); - - root.appendChild(link); - }, -); diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/helper.docs.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/helper.docs.ts deleted file mode 100644 index e00ced41ae..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/helper.docs.ts +++ /dev/null @@ -1,857 +0,0 @@ -import type {CodeTabType, ExampleType, LinkType} from '@shopify/generate-docs'; - -const examplePath = '../examples'; - -export const REQUIRES_PROTECTED_CUSTOMER_DATA = - 'access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.'; - -export const REQUIRES_PROTECTED_CUSTOMER_DATA_LEVEL_2 = - 'level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).'; - -type NonEmptyArray = [T, ...T[]]; -type ExtensionExampleLanguage = 'js' | 'jsx' | 'toml'; -type ExtensionCodeTabConfig = Record< - ExtensionExampleLanguage, - { - title: string; - fileExtension: 'ts' | 'tsx' | 'toml'; - } ->; -const codeExampleTabConfig: ExtensionCodeTabConfig = { - js: { - title: 'JavaScript', - fileExtension: 'ts', - }, - jsx: { - title: 'Preact', - fileExtension: 'tsx', - }, - toml: { - title: 'TOML', - fileExtension: 'toml', - }, -}; - -interface OptionalCodeMetadata { - title?: string; - description?: string; - image?: string; -} - -/** - * Returns all examples available, specified with a key for reference. - */ -export function getExamples( - languages: NonEmptyArray, -): Record { - if (!languages || languages.length === 0) { - throw new HelperDocsError( - 'You must define at least one extension code language context you wish to retrieve the example(s) for.', - ); - } - /** - * Provides the code tab for the requested languages in "JavaScript" and "React". - */ - function getExtensionCodeTabs(name: string): CodeTabType[] { - return languages.map((language) => { - return { - code: `${examplePath}/${name}.example.${codeExampleTabConfig[language].fileExtension}`, - language, - title: codeExampleTabConfig[language].title, - }; - }); - } - - function createExample( - id: string, - metadata?: OptionalCodeMetadata, - ): Record { - return { - [id]: { - description: metadata?.description ?? '', - image: metadata?.image ?? undefined, - codeblock: { - title: metadata?.title ?? ` ${id.replace('/default', '')}`, - tabs: getExtensionCodeTabs(id), - }, - }, - }; - } - - // Add new examples here that can be shared across multiples pages. - return { - // The `name` of the example, used to reference this example with `getExample(name)` or `getHookExample(name)`. - default: { - // Shown in the example accordion or not shown at all if used as a default example on a page. - description: - "The extension API allows you to access information about the merchant's store, the customer's cart, and make changes.", - // Shown on the right-hand side of the page. - codeblock: { - // Shared for each code tab. - title: '', - // Use `generateCodeTabs(name)` to ensure you have both "JavaScript" and "React" examples available. - tabs: getExtensionCodeTabs('default'), - }, - }, - generic: { - description: '', - codeblock: { - title: '', - tabs: getExtensionCodeTabs('default'), - }, - }, - ...createExample('purchase.address-autocomplete.suggest/default'), - ...createExample('purchase.address-autocomplete.format-suggestion/default'), - ...createExample( - 'purchase.checkout.pickup-location-option-item.render-after/default', - ), - ...createExample( - 'purchase.checkout.shipping-option-item.details.render/default', - ), - ...createExample( - 'purchase.checkout.shipping-option-item.render-after/default', - ), - ...createExample( - 'purchase.checkout.shipping-option-list.render-after/default', - ), - ...createExample( - 'purchase.checkout.shipping-option-list.render-before/default', - ), - ...createExample('purchase.checkout.chat.render/default'), - ...createExample('purchase.thank-you.chat.render/default'), - ...createExample('purchase.thank-you.announcement.render/default'), - 'analytics-publish': { - description: - 'You can publish analytics events to the Shopify analytics frameworks and they will be propagated to all web pixels on the page.', - codeblock: { - title: 'Publish', - tabs: getExtensionCodeTabs('analytics-publish'), - }, - }, - 'analytics-visitor': { - description: - 'You can submit visitor information to Shopify, these will be sent to the shop backend and not be propagated to web pixels on the page.', - codeblock: { - title: 'Visitor', - tabs: getExtensionCodeTabs('analytics-visitor'), - }, - }, - // For examples specific to extension targets that differ from the StandardApi, organize them into folders (/). - 'cart-line-item/default': { - description: '', - codeblock: { - title: '', - tabs: getExtensionCodeTabs('cart-line-item/default'), - }, - }, - 'pickup-point-list/default': { - description: '', - codeblock: { - title: 'Determine if the location input form is shown', - tabs: getExtensionCodeTabs('pickup-point-list/default'), - }, - }, - 'shipping-option-item/default': { - description: '', - codeblock: { - title: 'Reading the selected shipping option', - tabs: getExtensionCodeTabs('shipping-option-item/default'), - }, - }, - 'pickup-location-list/default': { - description: '', - codeblock: { - title: '', - tabs: getExtensionCodeTabs('pickup-location-list/default'), - }, - }, - 'purchase.checkout.pickup-location-option-item.render-after/default': { - description: '', - codeblock: { - title: 'Reading the selected pickup location option', - tabs: getExtensionCodeTabs( - 'purchase.checkout.pickup-location-option-item.render-after/default', - ), - }, - }, - 'order-confirmation/default': { - description: '', - codeblock: { - title: 'Order confirmation', - tabs: getExtensionCodeTabs('order-confirmation/default'), - }, - }, - 'checkout/default': { - description: '', - codeblock: { - title: '', - tabs: getExtensionCodeTabs('checkout/default'), - }, - }, - api: { - description: ` -The extension API is passed as a parameter to the extension target function. -In React, you can access it from any component through the \`useApi()\` hook. - `, - codeblock: { - title: 'Accessing Properties', - tabs: getExtensionCodeTabs('api'), - }, - }, - 'extension-api': { - description: ` -The extension API is passed as a parameter to the extension target function. -In React, you can access it from any component through the \`useExtensionApi()\` hook. - `, - codeblock: { - title: 'Accessing Properties', - tabs: getExtensionCodeTabs('extension-api'), - }, - }, - 'api-subscribable': { - description: ` -Some API properties may change after the extension is rendered. -With Preact, any time you access \`.value\`, your extension components will re-render automatically when values change. -Without Preact, you'll need to call \`.subscribe()\` and render a new UI as values change. -`, - codeblock: { - title: 'Subscribing to changes', - tabs: getExtensionCodeTabs('api-subscribable'), - }, - }, - translate: { - description: ` -Define strings in JSON files for each locale and render them using \`translate()\`. -See [localizing UI extensions](/docs/apps/checkout/best-practices/localizing-ui-extensions) for more information. - `, - codeblock: { - title: 'Translating strings', - tabs: [ - ...getExtensionCodeTabs('translate'), - ...[ - { - code: `${examplePath}/translate.locale.example.json`, - language: 'json', - title: 'locales/en.default.json', - }, - ], - ], - }, - }, - 'translate-pluralization': { - description: ` -You can use the \`count\` option to get a pluralized string based on the current locale. -See [localizing UI extensions](/docs/apps/checkout/best-practices/localizing-ui-extensions) for more information. - `, - codeblock: { - title: 'Translating strings with pluralization', - tabs: [ - ...getExtensionCodeTabs('translate-pluralization'), - ...[ - { - code: `${examplePath}/translate-pluralization.locale.example.json`, - language: 'json', - title: 'locales/en.default.json', - }, - ], - ], - }, - }, - 'extension-targets': { - description: '', - codeblock: { - title: '', - tabs: [ - ...getExtensionCodeTabs('extension-targets'), - { - code: `${examplePath}/extension-targets.example.toml`, - language: 'toml', - title: 'shopify.extension.toml', - }, - ], - }, - }, - settings: { - description: ` -You can define settings that merchants can edit within the checkout editor. -See [settings](/docs/api/checkout-ui-extensions/configuration#settings-definition) for more information on how to define these. - `, - codeblock: { - title: 'Define merchant settings', - tabs: [ - { - code: `${examplePath}/settings.example.toml`, - language: 'toml', - title: 'shopify.extension.toml', - }, - ], - }, - }, - 'settings-access': { - description: ` -You can retrieve settings values within your extension. In React, the \`useSettings()\` hook re-renders your extension with the latest values. -In JavaScript, subscribe to changes and update your UI directly. - `, - codeblock: { - title: 'Accessing merchant settings', - tabs: getExtensionCodeTabs('settings-access'), - }, - }, - 'storefront-query-api': { - description: ` -You can access the [Storefront GraphQL API](/docs/api/storefront) via the \`query()\` helper function. -Ensure your extension can use this API by [enabling the \`api_access\` capability](/docs/api/checkout-ui-extensions/configuration#api-access). - `, - codeblock: { - title: 'Access the Storefront API with query', - tabs: getExtensionCodeTabs('query-default'), - }, - }, - 'storefront-query-with-fetch': { - description: ` -You can access the [Storefront GraphQL API](/docs/api/storefront) using global \`fetch()\`. -Ensure your extension can access the Storefront API via the [\`api_access\` capability](/docs/api/checkout-ui-extensions/configuration#api-access). - -The \`shopify:storefront\` protocol will automatically infer your Storefront URL and API version declared in your extension config. - -By omitting the API version (recommended), Shopify will use your API version configured in \`shopify.extension.toml\`. To change the API version, simply add it to the URL like \`shopify:storefront/api/2024-04/graphql.json\`. - -See [Storefront GraphQL API endpoints](/docs/api/storefront#endpoints) for more information. - `, - codeblock: { - title: 'Accessing the Storefront API with fetch()', - tabs: getExtensionCodeTabs('query-fetch'), - }, - }, - 'buyer-journey-intercept/page-level-error': { - description: `Intercept and prevent a buyer's progress through checkout while displaying an error message at the page level. - See the [validation tutorial](/docs/apps/checkout/validation) for more examples and best practices.`, - codeblock: { - title: 'Block progress and show error at page level', - tabs: getExtensionCodeTabs('buyer-journey-intercept/page-level-error'), - }, - }, - 'buyer-journey-intercept/target-native-field': { - description: `Intercept and prevent a buyer's progress through checkout while targeting a specific checkout UI field. - See the [validation tutorial](/docs/apps/checkout/validation) for more examples and best practices.`, - codeblock: { - title: 'Block progress and show error for a checkout UI field', - tabs: getExtensionCodeTabs( - 'buyer-journey-intercept/target-native-field', - ), - }, - }, - 'buyer-journey-intercept/extension-banner': { - description: `Intercept and prevent a buyer's progress through checkout while displaying an error message in your extension. - See the [validation tutorial](/docs/apps/checkout/validation) for more examples and best practices.`, - codeblock: { - title: 'Block progress and show error in your extension', - tabs: getExtensionCodeTabs('buyer-journey-intercept/extension-banner'), - }, - }, - 'payments/use-available-payment-options': { - description: '', - codeblock: { - title: 'Available payment options', - tabs: getExtensionCodeTabs('payments/use-available-payment-options'), - }, - }, - 'payments/use-selected-payment-options': { - description: '', - codeblock: { - title: 'Selected payment options', - tabs: getExtensionCodeTabs('payments/use-selected-payment-options'), - }, - }, - 'customer-privacy/default': { - description: '', - codeblock: { - title: 'Read Customer Privacy', - tabs: getExtensionCodeTabs('customer-privacy/default'), - }, - }, - 'customer-privacy/sheet-consent-banner-with-form': { - description: ` -You can apply changes to customer consent by using the \`applyTrackingConsentChanges\` API. - -> Note: Requires the [\`customer_privacy\` capability](https://shopify.dev/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to \`true\`.`, - codeblock: { - title: 'Use a Sheet to manage customer privacy consent', - tabs: getExtensionCodeTabs( - 'customer-privacy/sheet-consent-banner-with-form', - ), - }, - }, - subscription: { - description: '', - codeblock: { - title: 'Subscribing to changes', - tabs: getExtensionCodeTabs('subscription'), - }, - }, - 'localized-fields/default': { - description: '', - codeblock: { - title: 'Read localized fields', - tabs: getExtensionCodeTabs('localized-fields/default'), - }, - }, - 'session-token': { - description: ` -You can request a session token from Shopify to use on your application server. The contents of the token claims are signed using your shared app secret so you can trust the claims came from Shopify unaltered. - -> Note: You will need to [enable the \`network_access\` capability](/docs/api/checkout-ui-extensions/configuration#network-access) to use \`fetch()\`. -`, - codeblock: { - title: 'Using a session token with fetch()', - tabs: getExtensionCodeTabs('session-token'), - }, - }, - 'session-token-jwt': { - description: ` -The contents of the token are signed using your shared app secret. The optional \`sub\` claim contains the customer's \`gid\` if they are logged in and your app has permission to read customer accounts. For example, a loyalty app that needs to check a customer's point balance can use the \`sub\` claim to verify the customer's account. - -> Caution: -> Your app server can only trust the claims within the session token. It cannot use the token to trust the entire HTTP request. See [security considerations](/docs/api/checkout-ui-extensions/configuration#network-access) for details. -`, - codeblock: { - title: 'Session token claims', - tabs: [ - { - code: `${examplePath}/session-token-jwt.example.json`, - language: 'json', - title: 'session-token.jwt', - }, - ], - }, - }, - storage: { - description: '', - codeblock: { - title: 'Storage', - tabs: getExtensionCodeTabs('storage'), - }, - }, - 'delivery-groups': { - description: '', - codeblock: { - title: 'Delivery groups', - tabs: getExtensionCodeTabs('delivery-groups'), - }, - }, - 'delivery-group': { - description: '', - codeblock: { - title: 'Delivery group', - tabs: getExtensionCodeTabs('delivery-group'), - }, - }, - 'attribute-values': { - description: '', - codeblock: { - title: 'Attribute values', - tabs: getExtensionCodeTabs('attribute-values'), - }, - }, - 'attributes/attribute-change': { - description: - 'You can add or remove cart and checkout attributes by using the `applyAttributeChange` API.', - codeblock: { - title: 'Applying changes to attributes', - tabs: getExtensionCodeTabs('attributes/attribute-change'), - }, - }, - ...createExample('cart-instructions/attributes', { - title: 'Attributes', - description: ` - Check \`instructions.attributes.canUpdateAttributes\` before calling \`applyAttributeChange()\`. - `, - }), - ...createExample('cart-instructions/cart-lines-add', { - title: 'Lines', - description: ` - Check \`instructions.lines.canAddCartLine\` or \`instructions.lines.canRemoveCartLine\` or \`instructions.lines.canUpdateCartLine\` before calling \`applyCartLinesChange()\`. - `, - }), - ...createExample('cart-instructions/delivery', { - title: 'Delivery', - description: ` - Check \`instructions.delivery.canSelectCustomAddress\` before calling \`applyShippingAddressChange()\`. When \`true\`, this instruction implies that extensions can change the shipping address. - `, - }), - ...createExample('cart-instructions/discounts', { - title: 'Discounts', - description: ` - Check \`instructions.discounts.canUpdateDiscountCodes\` before calling \`applyDiscountCodeChange()\`. - `, - }), - ...createExample('cart-instructions/metafields', { - title: 'Metafields', - description: ` - Check \`instructions.metafields.canSetCartMetafields\` or \`instructions.metafields.canDeleteCartMetafields\` before calling \`applyMetafieldChange()\` if you are working with cart metafields. - `, - }), - ...createExample('cart-instructions/notes', { - title: 'Notes', - description: ` - Check \`instructions.notes.canUpdateNote\` before calling \`applyNoteChange()\`. - `, - }), - ...createExample('metafields/default', { - title: 'Use app owned metafields', - description: - 'Use the `$app` format to request metafields that are owned by your app in your extension configuration file. Your app exclusively controls structure, data, permissions and optional features for this type of metafield. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information.', - }), - }; -} - -const links: Record = { - apis: [ - { - name: 'Targets', - subtitle: 'Reference', - url: '/docs/api/checkout-ui-extensions/targets', - type: 'blocks', - }, - { - name: 'Components', - subtitle: 'Reference', - url: '/docs/api/checkout-ui-extensions/components', - type: 'apps', - }, - { - name: 'Configuration', - subtitle: 'Reference', - url: '/docs/api/checkout-ui-extensions/configuration', - type: 'gear', - }, - { - name: 'Tutorials', - subtitle: 'Learn', - url: '/apps/checkout', - type: 'tutorial', - }, - ], - configuration: [ - { - name: 'Configuration', - subtitle: 'Overview', - url: '/docs/api/checkout-ui-extensions/configuration', - type: 'gear', - }, - { - name: 'Settings Definition', - subtitle: 'Configuration', - url: '/docs/api/checkout-ui-extensions/configuration#settings-definition', - type: 'gear', - }, - { - name: 'Settings Examples', - subtitle: 'APIs', - url: '/docs/api/checkout-ui-extensions/apis/standardapi#example-settings', - type: 'gear', - }, - ], - targets: [ - { - name: 'APIs', - subtitle: 'Reference', - url: '/docs/api/checkout-ui-extensions/targets', - type: 'blocks', - }, - { - name: 'Components', - subtitle: 'Reference', - url: '/docs/api/checkout-ui-extensions/components', - type: 'apps', - }, - { - name: 'Configuration', - subtitle: 'Reference', - url: '/docs/api/checkout-ui-extensions/configuration', - type: 'gear', - }, - { - name: 'Tutorials', - subtitle: 'Learn', - url: '/apps/checkout', - type: 'tutorial', - }, - ], -}; - -/** - * Returns an array of `LinkType` that can be used as related links on an entity. - * This uses a tag structure to allow you to group links together. - * You can optionally exclude a specific type of link from the results - */ -export function getLinksByTag( - name: string, - excludeLinkName?: string, -): LinkType[] { - const linksByTag = links[name]; - if (!linksByTag) { - throw new HelperDocsError( - `Could not find a matching tag with the name "${name}". Does it exist within the file "docs/reference/helper.docs.ts"?`, - ); - } - if (excludeLinkName) { - return linksByTag.filter((link) => link.name !== excludeLinkName); - } - - return linksByTag; -} - -/** - * Returns a specific `Example` by name, as specified in `getExamples()`. - * Specify whether you want to include both `js` and `jsx`examples or just one. - */ -export function getExample( - name: string, - languages: NonEmptyArray = ['js'], -): ExampleType { - const example = getExamples(languages)[name]; - if (!example) { - throw new HelperDocsError( - `Could not find a matching example with the name "${name}". Does it exist within the file "docs/reference/helper.docs.ts" in getExamples()?`, - ); - } - return example; -} - -/** - * Returns a specific react hook `Example` by name, as specified in `getExamples()`. - */ -export function getHookExample(name: string) { - return getExample(name, ['jsx']); -} - -class HelperDocsError extends Error { - name = 'HelperDocsError'; -} - -const CHECKOUT_API_DEFINITION = { - title: 'CheckoutApi', - description: - 'The API object provided to this and other `purchase.checkout` extension targets.', - type: 'CheckoutApi', -}; - -const STANDARD_API_DEFINITION = { - title: 'StandardApi', - description: - 'The base API object provided to this and other `purchase.checkout` and `purchase.thank-you` extension targets.', - type: 'StandardApi', -}; - -const ADDRESS_AUTOCOMPLETE_STANDARD_API_DEFINITION = { - title: 'AddressAutocompleteStandardApi', - description: - 'The base API object provided to this and other `purchase.address-autocomplete` extension targets.', - type: 'AddressAutocompleteStandardApi', -}; - -const ADDRESS_AUTOCOMPLETE_SUGGEST_API_DEFINITION = { - title: 'AddressAutocompleteSuggestApi', - description: - 'The API object provided to the `purchase.address-autocomplete.suggest` extension target.', - type: 'AddressAutocompleteSuggestApi', -}; - -const ADDRESS_AUTOCOMPLETE_SUGGEST_OUTPUT_DEFINITION = { - title: 'AddressAutocompleteSuggestOutput', - description: - 'The object expected to be returned by the `purchase.address-autocomplete.suggest` extension target.', - type: 'AddressAutocompleteSuggestOutput', -}; - -const ADDRESS_AUTOCOMPLETE_FORMAT_SUGGESTION_API_DEFINITION = { - title: 'AddressAutocompleteFormatSuggestionApi', - description: - 'The API object provided to the `purchase.address-autocomplete.format-suggestion` extension target.', - type: 'AddressAutocompleteFormatSuggestionApi', -}; - -const ADDRESS_AUTOCOMPLETE_FORMAT_SUGGESTION_OUTPUT_DEFINITION = { - title: 'AddressAutocompleteFormatSuggestionOutput', - description: - 'The object expected to be returned by the `purchase.address-autocomplete.format-suggestion` extension target.', - type: 'AddressAutocompleteFormatSuggestionOutput', -}; - -const CART_LINE_ITEM_API_DEFINITION = { - title: 'CartLineItemApi', - description: - 'The API object provided to this and other `cart-line-item` extension targets.', - type: 'CartLineItemApi', -}; - -const ORDER_CONFIRMATION_API_DEFINITION = { - title: 'OrderConfirmationApi', - description: - 'The API object provided to this and other `purchase.thank-you` extension targets.', - type: 'OrderConfirmationApi', -}; - -const PICKUP_LOCATION_LIST_API_DEFINITION = { - title: 'PickupLocationListApi', - description: - 'The API object provided to this and other `pickup-location-list` extension targets.', - type: 'PickupLocationListApi', -}; - -const PICKUP_LOCATION_ITEM_API_DEFINITION = { - title: 'PickupLocationItemApi', - description: - 'The API object provided to this and other `pickup-location-option-item` extension targets.', - type: 'PickupLocationItemApi', -}; - -const PICKUP_POINT_LIST_API_DEFINITION = { - title: 'PickupPointListApi', - description: - 'The API object provided to this and other `pickup-point-list` extension targets.', - type: 'PickupPointListApi', -}; - -const SHIPPING_OPTION_ITEM_API_DEFINITION = { - title: 'ShippingOptionItemApi', - description: - 'The API object provided to this and other `shipping-option-item` extension targets.', - type: 'ShippingOptionItemApi', -}; - -const SHIPPING_OPTION_LIST_API_DEFINITION = { - title: 'ShippingOptionListApi', - description: - 'The API object provided to this and other `shipping-option-list` extension targets.', - type: 'ShippingOptionListApi', -}; - -const COMMON_API = { - category: 'Targets', - isVisualComponent: false, - requires: REQUIRES_PROTECTED_CUSTOMER_DATA, - type: 'Target', -}; - -export const STANDARD_API = { - definitions: [STANDARD_API_DEFINITION], - ...COMMON_API, -}; - -export const CHECKOUT_API = { - definitions: [CHECKOUT_API_DEFINITION, STANDARD_API_DEFINITION], - ...COMMON_API, -}; - -export const ADDRESS_AUTOCOMPLETE_SUGGEST_API = { - definitions: [ - ADDRESS_AUTOCOMPLETE_SUGGEST_API_DEFINITION, - ADDRESS_AUTOCOMPLETE_SUGGEST_OUTPUT_DEFINITION, - ADDRESS_AUTOCOMPLETE_STANDARD_API_DEFINITION, - ], - ...COMMON_API, -}; - -export const ADDRESS_AUTOCOMPLETE_FORMAT_SUGGESTION_API = { - definitions: [ - ADDRESS_AUTOCOMPLETE_FORMAT_SUGGESTION_API_DEFINITION, - ADDRESS_AUTOCOMPLETE_FORMAT_SUGGESTION_OUTPUT_DEFINITION, - ADDRESS_AUTOCOMPLETE_STANDARD_API_DEFINITION, - ], - ...COMMON_API, -}; - -export const CART_LINE_ITEM_API = { - subCategory: 'Order Summary', - definitions: [CART_LINE_ITEM_API_DEFINITION, STANDARD_API_DEFINITION], - ...COMMON_API, -}; - -export const CHECKOUT_CART_LINE_ITEM_API = { - subCategory: CART_LINE_ITEM_API.subCategory, - definitions: [ - CART_LINE_ITEM_API_DEFINITION, - CHECKOUT_API_DEFINITION, - STANDARD_API_DEFINITION, - ], - ...COMMON_API, -}; - -export const THANK_YOU_API = { - definitions: [ORDER_CONFIRMATION_API_DEFINITION, STANDARD_API_DEFINITION], - ...COMMON_API, -}; - -export const THANK_YOU_CART_LINE_ITEM_API = { - subCategory: 'Order Summary', - definitions: [ - ORDER_CONFIRMATION_API_DEFINITION, - CART_LINE_ITEM_API_DEFINITION, - STANDARD_API_DEFINITION, - ], - ...COMMON_API, -}; - -export const PICKUP_LOCATION_LIST_API = { - subCategory: 'Local Pickup', - definitions: [ - PICKUP_LOCATION_LIST_API_DEFINITION, - CHECKOUT_API_DEFINITION, - STANDARD_API_DEFINITION, - ], - ...COMMON_API, -}; - -export const PICKUP_LOCATION_ITEM_API = { - subCategory: 'Local Pickup', - definitions: [ - PICKUP_LOCATION_ITEM_API_DEFINITION, - CHECKOUT_API_DEFINITION, - STANDARD_API_DEFINITION, - ], - ...COMMON_API, -}; - -export const PICKUP_POINT_LIST_API = { - subCategory: 'Pickup Points', - definitions: [ - PICKUP_POINT_LIST_API_DEFINITION, - CHECKOUT_API_DEFINITION, - STANDARD_API_DEFINITION, - ], - ...COMMON_API, -}; - -export const SHIPPING_OPTION_ITEM_API = { - subCategory: 'Shipping', - definitions: [ - SHIPPING_OPTION_ITEM_API_DEFINITION, - CHECKOUT_API_DEFINITION, - STANDARD_API_DEFINITION, - ], - ...COMMON_API, -}; - -export const SHIPPING_OPTION_LIST_API = { - subCategory: 'Shipping', - definitions: [ - SHIPPING_OPTION_LIST_API_DEFINITION, - CHECKOUT_API_DEFINITION, - STANDARD_API_DEFINITION, - ], - ...COMMON_API, -}; - -export const STANDARD_API_PROPERTIES_DESCRIPTION = - 'The base API object provided to `purchase` extension targets.'; - -export const CHECKOUT_API_PROPERTIES_DESCRIPTION = - 'The API object provided to `purchase.checkout` extension targets.'; - -export const ORDER_CONFIRMATION_API_PROPERTIES_DESCRIPTION = - 'The API object provided to `purchase.thank-you` extension targets.'; - -export const ORDER_STATUS_API_PROPERTIES_DESCRIPTION = - '> Note: This documentation has moved to customer accounts. Refer to [Order API](/docs/api/customer-account-ui-extensions/apis/order)'; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/hooks/api.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/hooks/api.doc.ts deleted file mode 100644 index e009db28d4..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/hooks/api.doc.ts +++ /dev/null @@ -1,24 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getHookExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'useApi()', - description: '', - descriptionType: 'UseApiGeneratedType', - isVisualComponent: false, - type: 'React Hook', - category: 'APIs', - // subCategory: 'Utilities', - definitions: [ - { - title: '', - description: '', - type: 'UseApiGeneratedType', - }, - ], - defaultExample: getHookExample('api'), - related: getLinksByTag('apis', 'UseApiGeneratedType'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/hooks/extension-api.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/hooks/extension-api.doc.ts deleted file mode 100644 index 5316e0198c..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/hooks/extension-api.doc.ts +++ /dev/null @@ -1,24 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getHookExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'useExtensionApi()', - description: '', - descriptionType: 'UseExtensionApiGeneratedType', - isVisualComponent: false, - type: 'React Hook', - category: 'APIs', - // subCategory: 'Utilities', - definitions: [ - { - title: '', - description: '', - type: 'UseExtensionApiGeneratedType', - }, - ], - defaultExample: getHookExample('extension-api'), - related: getLinksByTag('apis', 'UseExtensionApiGeneratedType'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/hooks/subscription.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/hooks/subscription.doc.ts deleted file mode 100644 index cddd97a923..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/hooks/subscription.doc.ts +++ /dev/null @@ -1,24 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getHookExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'useSubscription()', - description: '', - descriptionType: 'UseSubscriptionGeneratedType', - isVisualComponent: false, - type: 'React Hook', - category: 'APIs', - // subCategory: 'Utilities', - definitions: [ - { - title: '', - description: '', - type: 'UseSubscriptionGeneratedType', - }, - ], - defaultExample: getHookExample('subscription'), - related: getLinksByTag('apis'), -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.address-autocomplete.format-suggestion.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.address-autocomplete.format-suggestion.doc.ts deleted file mode 100644 index 58a64d9aff..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.address-autocomplete.format-suggestion.doc.ts +++ /dev/null @@ -1,35 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - ADDRESS_AUTOCOMPLETE_FORMAT_SUGGESTION_API, - getExample, - getLinksByTag, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.address-autocomplete.format-suggestion', - description: ` - An extension target that formats the selected address suggestion provided by a [\`purchase.address-autocomplete.suggest\`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest) target. This formatted address is used to auto-populate the fields of the address form. - - It must return a [\`formattedAddress\`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-format-suggestion#addressautocompleteformatsuggestionoutput-propertydetail-formattedaddress). - - > Caution: - > This extension target is only necessary if the corresponding [\`purchase.address-autocomplete.suggest\`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest) target does not provide a \`formattedAddress\` for the suggestions. If a formatted address is provided with each suggestion, then this target will not be called. - > - > If the [\`purchase.address-autocomplete.suggest\`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest) target is not implemented, then this target will not work. - - > Note: - > - This target does not support rendering UI components. - > - This extension can only be developed as a JavaScript extension using the \`ui-extensions\` library. - > - The [app extension configuration](/docs/apps/app-extensions/configuration) \`shopify.extension.toml\` file is shared between this extension target and [\`purchase.address-autocomplete.suggest\`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest). This includes extension settings specified in the configuration file. - `, - subCategory: 'Address', - defaultExample: getExample( - 'purchase.address-autocomplete.format-suggestion/default', - ['js'], - ), - related: getLinksByTag('targets', 'Tutorials'), - ...ADDRESS_AUTOCOMPLETE_FORMAT_SUGGESTION_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.address-autocomplete.suggest.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.address-autocomplete.suggest.doc.ts deleted file mode 100644 index 0e9a23ac38..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.address-autocomplete.suggest.doc.ts +++ /dev/null @@ -1,33 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - ADDRESS_AUTOCOMPLETE_SUGGEST_API, - getExample, - getLinksByTag, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.address-autocomplete.suggest', - description: ` - An extension target that provides address autocomplete suggestions for address forms at checkout. Suggestions are presented to customers for delivery, billing, and pickup point addresses. - - The extension target must return a list of address [\`suggestions\`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-suggest#addressautocompletesuggestoutput-propertydetail-suggestions). - - If a formatted address is provided with each suggestion, then it will be used to auto-populate the fields in the address form when the customer selects a suggested address. - - Optionally, you can implement the [\`purchase.address-autocomplete.format-suggestion\`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-format-suggestion) extension target to format an address based on the address suggestion selected by the customer. - - > Note: - > - This target does not support rendering UI components. - > - This extension can only be developed as a JavaScript extension using the \`ui-extensions\` library. - > - The [app extension configuration](/docs/apps/app-extensions/configuration) \`shopify.extension.toml\` file is shared between this extension target and [\`purchase.address-autocomplete.format-suggestion\`](/docs/api/checkout-ui-extensions/latest/targets/address/purchase-address-autocomplete-format-suggestion). This includes extension settings specified in the configuration file. - `, - subCategory: 'Address', - defaultExample: getExample('purchase.address-autocomplete.suggest/default', [ - 'js', - ]), - related: getLinksByTag('targets', 'Tutorials'), - ...ADDRESS_AUTOCOMPLETE_SUGGEST_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.actions.render-before.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.actions.render-before.doc.ts deleted file mode 100644 index 8a6a3c6866..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.actions.render-before.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.actions.render-before', - description: - 'A static extension target that is rendered immediately before any actions within each step.', - subCategory: 'Navigation', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.block.render.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.block.render.doc.ts deleted file mode 100644 index ff20a429b3..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.block.render.doc.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.block.render', - description: `A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that isn't tied to a specific checkout section or feature. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor). - - The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).`, - subCategory: 'Block', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.cart-line-item.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.cart-line-item.render-after.doc.ts deleted file mode 100644 index 0200f70ee5..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.cart-line-item.render-after.doc.ts +++ /dev/null @@ -1,21 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - CHECKOUT_CART_LINE_ITEM_API, - getExample, - getLinksByTag, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.cart-line-item.render-after', - description: `A static extension target that renders on every line item, inside the details under the line item properties element. - - > Caution: - > This extension target will not be rendered if the line item is a custom line item belonging to a draft order invoice. - `, - defaultExample: getExample('cart-line-item/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_CART_LINE_ITEM_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.cart-line-list.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.cart-line-list.render-after.doc.ts deleted file mode 100644 index de326eba67..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.cart-line-list.render-after.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.cart-line-list.render-after', - description: - 'A static extension target that is rendered after all line items.', - subCategory: 'Order Summary', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.contact.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.contact.render-after.doc.ts deleted file mode 100644 index db02e714c5..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.contact.render-after.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.contact.render-after', - description: - 'A static extension target that is rendered immediately after the contact form element.', - subCategory: 'Information', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.delivery-address.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.delivery-address.render-after.doc.ts deleted file mode 100644 index 78a77a4150..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.delivery-address.render-after.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.delivery-address.render-after', - description: - 'A static extension target that is rendered after the shipping address form elements.', - subCategory: 'Shipping', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.delivery-address.render-before.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.delivery-address.render-before.doc.ts deleted file mode 100644 index 1ccb032e90..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.delivery-address.render-before.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.delivery-address.render-before', - description: - 'A static extension target that is rendered between the shipping address header and shipping address form elements.', - subCategory: 'Shipping', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.footer.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.footer.render-after.doc.ts deleted file mode 100644 index b5447646ee..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.footer.render-after.doc.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.footer.render-after', - description: `A static extension target that is rendered below the footer. - - > Tip: - > To prevent layout shifting, avoid dynamic data fetching & rendering in this target. If you need to render dynamic content, consider reserving space for your content while it is loading. - > See: [Spinner](https://shopify.dev/docs/api/checkout-ui-extensions/components/feedback/spinner), [SkeletonText](https://shopify.dev/docs/api/checkout-ui-extensions/components/feedback/skeletontext), or [BlockSpacer](https://shopify.dev/docs/api/checkout-ui-extensions/components/structure/blockspacer). - `, - defaultExample: getExample('generic', ['jsx']), - subCategory: 'Footer', - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.header.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.header.render-after.doc.ts deleted file mode 100644 index 07fe4b4e2c..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.header.render-after.doc.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.header.render-after', - description: `A static extension target that is rendered below the header. - - > Tip: - > To prevent layout shifting, avoid dynamic data fetching & rendering in this target. If you need to render dynamic content, consider reserving space for your content while it is loading. - > See: [Spinner](https://shopify.dev/docs/api/checkout-ui-extensions/components/feedback/spinner), [SkeletonText](https://shopify.dev/docs/api/checkout-ui-extensions/components/feedback/skeletontext), or [BlockSpacer](https://shopify.dev/docs/api/checkout-ui-extensions/components/structure/blockspacer). - `, - defaultExample: getExample('generic', ['jsx']), - subCategory: 'Header', - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.payment-method-list.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.payment-method-list.render-after.doc.ts deleted file mode 100644 index 6b10153b41..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.payment-method-list.render-after.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.payment-method-list.render-after', - description: - 'A static extension target that renders below the list of payment methods.', - subCategory: 'Payments', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.payment-method-list.render-before.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.payment-method-list.render-before.doc.ts deleted file mode 100644 index 1604467b4a..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.payment-method-list.render-before.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {CHECKOUT_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.payment-method-list.render-before', - description: - 'A static extension target that renders between the payment heading and payment method list.', - subCategory: 'Payments', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-location-list.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-location-list.render-after.doc.ts deleted file mode 100644 index 1e83cfeee0..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-location-list.render-after.doc.ts +++ /dev/null @@ -1,18 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - PICKUP_LOCATION_LIST_API, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.pickup-location-list.render-after', - description: - 'A static extension target that is rendered after pickup location options.', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...PICKUP_LOCATION_LIST_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-location-list.render-before.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-location-list.render-before.doc.ts deleted file mode 100644 index 46acdc34ea..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-location-list.render-before.doc.ts +++ /dev/null @@ -1,18 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - PICKUP_LOCATION_LIST_API, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.pickup-location-list.render-before', - description: - 'A static extension target that is rendered before pickup location options.', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...PICKUP_LOCATION_LIST_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-location-option-item.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-location-option-item.render-after.doc.ts deleted file mode 100644 index e735e35280..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-location-option-item.render-after.doc.ts +++ /dev/null @@ -1,21 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - PICKUP_LOCATION_ITEM_API, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.pickup-location-option-item.render-after', - description: - 'A static extension target that is rendered after the pickup location details within the local pickup option list, for each option.', - defaultExample: getExample( - 'purchase.checkout.pickup-location-option-item.render-after/default', - ['jsx'], - ), - related: getLinksByTag('targets'), - ...PICKUP_LOCATION_ITEM_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-point-list.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-point-list.render-after.doc.ts deleted file mode 100644 index d03aa0e703..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-point-list.render-after.doc.ts +++ /dev/null @@ -1,14 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getExample, getLinksByTag, PICKUP_POINT_LIST_API} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.pickup-point-list.render-after', - description: - 'A static extension target that is rendered immediately after the pickup points.', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...PICKUP_POINT_LIST_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-point-list.render-before.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-point-list.render-before.doc.ts deleted file mode 100644 index b4889b9527..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.pickup-point-list.render-before.doc.ts +++ /dev/null @@ -1,14 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getExample, getLinksByTag, PICKUP_POINT_LIST_API} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.pickup-point-list.render-before', - description: - 'A static extension target that is rendered immediately before the pickup points.', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...PICKUP_POINT_LIST_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.reductions.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.reductions.render-after.doc.ts deleted file mode 100644 index 1d6bbf4232..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.reductions.render-after.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getExample, getLinksByTag, CHECKOUT_API} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.reductions.render-after', - description: - 'A static extension target that is rendered in the order summary, after the discount form and discount tag elements.', - subCategory: 'Order Summary', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.reductions.render-before.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.reductions.render-before.doc.ts deleted file mode 100644 index 2f353d1fbe..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.reductions.render-before.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getExample, getLinksByTag, CHECKOUT_API} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.reductions.render-before', - description: - 'A static extension target that is rendered in the order summary, before the discount form element.', - subCategory: 'Order Summary', - defaultExample: getExample('checkout/default', ['jsx']), - related: getLinksByTag('targets'), - ...CHECKOUT_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-item.details.render.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-item.details.render.doc.ts deleted file mode 100644 index 945006d534..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-item.details.render.doc.ts +++ /dev/null @@ -1,26 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - SHIPPING_OPTION_ITEM_API, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.shipping-option-item.details.render', - description: ` -A static extension target that is rendered under the shipping method within the shipping method option list, for each option. - -> Note: -> - In split shipping scenarios, this target is duplicated for each delivery group (shipment), and its value is the selected shipping option for the delivery group. -> - If you are collecting information in this target, you should consider that it needs to be scoped to a specific delivery group in split shipping scenarios. Alternatively, you can move your extension to \`purchase.checkout.shipping-option-list.render-before\` or \`purchase.checkout.shipping-option-list.render-after\`, which are not duplicated for each delivery group. -`, - defaultExample: getExample( - 'purchase.checkout.shipping-option-item.details.render/default', - ['jsx'], - ), - related: getLinksByTag('targets'), - ...SHIPPING_OPTION_ITEM_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-item.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-item.render-after.doc.ts deleted file mode 100644 index 71bc81eaaf..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-item.render-after.doc.ts +++ /dev/null @@ -1,25 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - SHIPPING_OPTION_ITEM_API, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.shipping-option-item.render-after', - description: ` -A static extension target that is rendered after the shipping method details within the shipping method option list, for each option. - -> Note: -> In split shipping scenarios, this target will render within a Modal when \`renderMode.overlay\` is true. In this case, it is recommended to avoid using components that render an overlay such as Modals. -`, - defaultExample: getExample( - 'purchase.checkout.shipping-option-item.render-after/default', - ['jsx'], - ), - related: getLinksByTag('targets'), - ...SHIPPING_OPTION_ITEM_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-list.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-list.render-after.doc.ts deleted file mode 100644 index c27184c910..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-list.render-after.doc.ts +++ /dev/null @@ -1,21 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - SHIPPING_OPTION_LIST_API, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.shipping-option-list.render-after', - description: - 'A static extension target that is rendered after the shipping method options.', - defaultExample: getExample( - 'purchase.checkout.shipping-option-list.render-after/default', - ['jsx'], - ), - related: getLinksByTag('targets'), - ...SHIPPING_OPTION_LIST_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-list.render-before.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-list.render-before.doc.ts deleted file mode 100644 index 670094c9e7..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.checkout.shipping-option-list.render-before.doc.ts +++ /dev/null @@ -1,21 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - SHIPPING_OPTION_LIST_API, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.checkout.shipping-option-list.render-before', - description: - 'A static extension target that is rendered between the shipping method header and shipping method options.', - defaultExample: getExample( - 'purchase.checkout.shipping-option-list.render-before/default', - ['jsx'], - ), - related: getLinksByTag('targets'), - ...SHIPPING_OPTION_LIST_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.announcement.render.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.announcement.render.doc.ts deleted file mode 100644 index 4b073f6dcc..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.announcement.render.doc.ts +++ /dev/null @@ -1,17 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getExample, getLinksByTag, THANK_YOU_API} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.thank-you.announcement.render', - description: - 'A static extension target that is rendered on top of the **Thank you page** as a dismissable announcement.', - defaultExample: getExample('purchase.thank-you.announcement.render/default', [ - 'jsx', - ]), - subCategory: 'Announcement', - related: getLinksByTag('targets'), - ...THANK_YOU_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.block.render.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.block.render.doc.ts deleted file mode 100644 index 0d6e7b8d7d..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.block.render.doc.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getExample, getLinksByTag, THANK_YOU_API} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.thank-you.block.render', - description: `A [block extension target](/docs/api/checkout-ui-extensions/extension-targets-overview#block-extension-targets) that renders exclusively on the **Thank you** page. Unlike static extension targets, block extension targets render where the merchant sets them using the [checkout editor](/docs/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor). - - The [supported locations](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations) for block extension targets can be previewed during development by [using a URL parameter](/docs/apps/checkout/best-practices/testing-ui-extensions#block-extension-targets).`, - subCategory: 'Block', - defaultExample: getExample('generic', ['jsx']), - related: getLinksByTag('targets'), - ...THANK_YOU_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.cart-line-item.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.cart-line-item.render-after.doc.ts deleted file mode 100644 index 9d17218c87..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.cart-line-item.render-after.doc.ts +++ /dev/null @@ -1,21 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import { - getExample, - getLinksByTag, - THANK_YOU_CART_LINE_ITEM_API, -} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.thank-you.cart-line-item.render-after', - description: `A static extension target that renders on every line item, inside the details under the line item properties element. - - > Caution: - > This extension target will not be rendered if the line item is a custom line item belonging to a draft order invoice. - `, - defaultExample: getExample('cart-line-item/default', ['jsx']), - related: getLinksByTag('targets'), - ...THANK_YOU_CART_LINE_ITEM_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.cart-line-list.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.cart-line-list.render-after.doc.ts deleted file mode 100644 index 1dfbc0ac7b..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.cart-line-list.render-after.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getExample, getLinksByTag, THANK_YOU_API} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.thank-you.cart-line-list.render-after', - description: - 'A static extension target that is rendered after all line items on the **Thank you** page.', - subCategory: 'Order Summary', - defaultExample: getExample('generic', ['jsx']), - related: getLinksByTag('targets'), - ...THANK_YOU_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.customer-information.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.customer-information.render-after.doc.ts deleted file mode 100644 index 92cd9f2851..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.customer-information.render-after.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {getExample, getLinksByTag, THANK_YOU_API} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.thank-you.customer-information.render-after', - description: - 'A static extension target that is rendered after a purchase below the customer information on the **Thank you** page.', - subCategory: 'Information', - defaultExample: getExample('generic', ['jsx']), - related: getLinksByTag('targets'), - ...THANK_YOU_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.footer.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.footer.render-after.doc.ts deleted file mode 100644 index 44737c8786..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.footer.render-after.doc.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {THANK_YOU_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.thank-you.footer.render-after', - description: `A static extension target that is rendered below the footer on the **Thank you** page. - - > Tip: - > To prevent layout shifting, avoid dynamic data fetching & rendering in this target. If you need to render dynamic content, consider reserving space for your content while it is loading. - > See: [Spinner](https://shopify.dev/docs/api/checkout-ui-extensions/components/feedback/spinner), [SkeletonText](https://shopify.dev/docs/api/checkout-ui-extensions/components/feedback/skeletontext), or [BlockSpacer](https://shopify.dev/docs/api/checkout-ui-extensions/components/structure/blockspacer). - `, - defaultExample: getExample('generic', ['jsx']), - subCategory: 'Footer', - related: getLinksByTag('targets'), - ...THANK_YOU_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.header.render-after.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.header.render-after.doc.ts deleted file mode 100644 index 066d6b91bd..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/reference/targets/purchase.thank-you.header.render-after.doc.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {THANK_YOU_API, getExample, getLinksByTag} from '../helper.docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'purchase.thank-you.header.render-after', - description: `A static extension target that is rendered below the header on the **Thank you** page. - - > Tip: - > To prevent layout shifting, avoid dynamic data fetching & rendering in this target. If you need to render dynamic content, consider reserving space for your content while it is loading. - > See: [Spinner](https://shopify.dev/docs/api/checkout-ui-extensions/components/feedback/spinner), [SkeletonText](https://shopify.dev/docs/api/checkout-ui-extensions/components/feedback/skeletontext), or [BlockSpacer](https://shopify.dev/docs/api/checkout-ui-extensions/components/structure/blockspacer). - `, - defaultExample: getExample('generic', ['jsx']), - subCategory: 'Header', - related: getLinksByTag('targets'), - ...THANK_YOU_API, -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/screenshots/block-extension-targets.png b/packages/ui-extensions/docs/surfaces/checkout/screenshots/block-extension-targets.png new file mode 100644 index 0000000000..afed1946ca Binary files /dev/null and b/packages/ui-extensions/docs/surfaces/checkout/screenshots/block-extension-targets.png differ diff --git a/packages/ui-extensions/docs/surfaces/checkout/screenshots/placeholder-checkout.png b/packages/ui-extensions/docs/surfaces/checkout/screenshots/placeholder-checkout.png new file mode 100644 index 0000000000..20226fe338 Binary files /dev/null and b/packages/ui-extensions/docs/surfaces/checkout/screenshots/placeholder-checkout.png differ diff --git a/packages/ui-extensions/docs/surfaces/checkout/screenshots/static-extension-targets.png b/packages/ui-extensions/docs/surfaces/checkout/screenshots/static-extension-targets.png new file mode 100644 index 0000000000..a20d0faa7f Binary files /dev/null and b/packages/ui-extensions/docs/surfaces/checkout/screenshots/static-extension-targets.png differ diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/configuration.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/staticPages/configuration.doc.ts deleted file mode 100644 index 96bddd2ace..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/configuration.doc.ts +++ /dev/null @@ -1,512 +0,0 @@ -import type {LandingTemplateSchema} from '@shopify/generate-docs'; - -// Order of data shape mimics visual structure of page -// Anything in an array can have multiple objects - -const data: LandingTemplateSchema = { - title: 'Configuration', - description: ` -When you create a [checkout UI extension](/api/checkout-ui-extensions/), an [app extension configuration](/docs/apps/app-extensions/configuration) \`shopify.extension.toml\` file is automatically generated in your extension's directory. - -This guide describes [extension targeting](#targets), [capabilities](#capabilities), [metafields](#metafields), and the [settings](#settings-definition) you can configure in the app extension configuration. -`, - // The id for the page that is used for routing. If this documentation is for a primary landing page, confirm the id matches the reference name. - id: 'configuration', - sections: [ - { - type: 'Generic', - anchorLink: 'how-it-works', - title: 'How it works', - sectionContent: ` -You define properties for your checkout UI extension in the extension configuration file. The \`shopify.extension.toml\` file contains the extension's configuration, which includes the extension name, targets, metafields, capabilities, and settings. - -When an extension is published to Shopify, the contents of the settings file are pushed alongside the extension. -`, - codeblock: { - title: 'shopify.extension.toml', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/extended.example.toml', - language: 'toml', - }, - ], - }, - sectionNotice: [ - { - title: 'Tip', - sectionContent: ` -You can configure more than one type of extension within a configuration file. -`, - type: 'info', - }, - ], - sectionCard: [ - { - name: 'App extension configuration', - subtitle: 'Learn more', - url: '/docs/apps/app-extensions/configuration', - type: 'gear', - }, - ], - }, - { - type: 'GenericAccordion', - anchorLink: 'targets', - title: 'Targets', - sectionContent: ` -[Targets](/docs/api/checkout-ui-extensions/extension-targets-overview) represent where your checkout UI extension will be injected. You may have one or many targets defined in your app extension configuration using the \`targeting\` field. - -Along with the \`target\`, Shopify needs to know which code to execute for it. You specify the path to your code file by using the \`module\` property. - - - `, - accordionContent: [ - { - title: 'Supporting a single extension target', - description: ` - Your code should have a default export if it only supports a single extension target. - `, - codeblock: { - title: 'Single extension target', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/single-target.example.toml', - language: 'toml', - }, - ], - }, - }, - { - title: 'Supporting multiple extension targets', - description: ` - You can support multiple extension targets within a single configuration file. However, you must provide a separate file per extension target using the \`export default\` declaration. - `, - codeblock: { - title: 'Multiple extension targets', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/multiple-targets.example.toml', - language: 'toml', - }, - ], - }, - }, - ], - }, - { - type: 'Generic', - anchorLink: 'capabilities', - title: 'Capabilities', - sectionContent: ` -Defines the [capabilities](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-extension) associated with your extension. -| Property | Description | -|---|---| -| [\`api_access\`](#api-access) | Allows your extension to query the Storefront API. -| [\`network_access\`](#network-access) | Allows your extension make external network calls. -| [\`block_progress\`](#block-progress) | States that your extension might block the buyer's progress. -| [\`collect_buyer_consent\`](#collect-buyer-consent) | Allows your extension to collect buyer consent for specific policies such as SMS marketing. -`, - codeblock: { - title: 'Capabilities', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/capabilities.example.toml', - language: 'toml', - }, - ], - }, - }, - { - type: 'Generic', - anchorLink: 'api-access', - title: 'Storefront API access', - sectionContent: - 'The following section describes the use cases of the `api_access` capability and the [Storefront API](/api/storefront) access scopes.', - codeblock: { - title: 'Enable Storefront API access', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/api-access.example.toml', - language: 'toml', - }, - ], - }, - sectionCard: [ - { - name: 'API access examples', - subtitle: 'See', - url: '/docs/api/checkout-ui-extensions/apis/storefront-api#examples', - type: 'blocks', - }, - ], - sectionSubContent: [ - { - title: 'When to use Storefront API access', - sectionContent: `API access is used when your extension needs to retrieve data from the [Storefront API](/api/storefront). For example, you may need to [fetch product data](/apps/checkout/product-offers/add-product-offer), check the product tags on an item in the cart, or convert a product's price to another currency. - -> Tip: -> Shopify handles the authentication for all API calls from an extension. -`, - }, - { - title: 'Methods for accessing the Storefront API', - sectionContent: `Enabling the \`api_access\` capability allows you to use the Standard API [\`query\`](/docs/api/checkout-ui-extensions/apis/storefront-api) method and the global \`fetch\` to retrieve data from the [Storefront API](/api/storefront) without manually managing token aquisition and refresh. - -\`query\` lets you request a single GraphQL response from the Storefront API. - -If you prefer to construct GraphQL requests yourself or you would like to use a full-featured GraphQL client such as Apollo or urql, our custom \`fetch\` global automatically appends the required access tokens. - -The GraphQL client of your choice shouldn’t use any DOM APIs, as they aren’t available in a checkout UI extension's Web Worker. - -> Note: Both \`query\` and \`fetch\` will work for calling the Storefront API with the \`api_access\` capability enabled. If you are using \`fetch\` to get data external to Shopify, refer to the [\`network_access\`](/api/checkout-ui-extensions/configuration#network-access) capability.`, - }, - { - title: 'Storefront API access scopes', - sectionContent: ` -Your extensions will have the following unauthenticated access scopes to the Storefront API: - -- unauthenticated_read_product_publications -- unauthenticated_read_collection_publications -- unauthenticated_read_product_listings -- unauthenticated_read_product_tags -- unauthenticated_read_selling_plans -- unauthenticated_read_collection_listings -- unauthenticated_read_metaobjects -`, - }, - { - title: 'Protocol Links', - sectionContent: ` -Protocol links are an easy way for Shopify to infer the type of request you are trying to make. If you would like to make a request to the [Storefront GraphQL API](/docs/api/storefront), you can use our [Storefront Protocol](/docs/api/checkout-ui-extensions/latest/apis/storefront-api#examples) to infer your Storefront URL and API version. - `, - }, - ], - }, - { - type: 'Generic', - anchorLink: 'network-access', - title: 'Network access', - sectionContent: ` -The following section describes use cases for requesting network access, alternatives to requesting network access, and steps for completing a request for network access. -> Caution: -> If your extension specifies the \`network_access\` capability, you must request access in order to publish your extension. -`, - codeblock: { - title: 'Enable network access', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/network-access.example.toml', - language: 'toml', - }, - ], - }, - sectionSubContent: [ - { - title: 'When to request network access', - sectionContent: - "If you need to get data into checkout that you can't currently get from Shopify, then you should request network access. For example, you might need to fetch additional data to render loyalty points.", - }, - { - title: 'Alternatives to network access', - sectionContent: ` -Instead of fetching data with an external network call, consider retrieving the data from a metafield. Your app may be able to use the [Admin API](/docs/api/admin) to write [metafields](/api/admin-graphql/latest/objects/metafield) on the shop, product, or customer ahead of checkout. - -Retrieving data from [metafields](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-appmetafields) during checkout is faster since it won't introduce an external network call. This allows you to rely on Shopify for the uptime, scaling, and durability of the data storage. -`, - }, - { - title: 'Complete a request for network access', - sectionContent: ` -1. Go to your [Partner Dashboard](https://partners.shopify.com/current/apps). -2. Click the name of the app that you want to change. -3. Click **API access**. -4. Under **Allow network access in checkout UI extensions**, click **Allow network access** - - Your request is automatically approved and your app is immediately granted the approval scope that's required for your checkout UI extension to make external network calls. - -5. Add network_access = true to the [extensions.capabilities] section of your extension's configuration file.`, - }, - { - title: 'Required CORS headers', - sectionContent: ` -UI extensions run in a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) but the exact origin they run on may change without notice. When receiving network requests from extensions, your server must support [cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) for any origin by always returning this response header: - -Access-Control-Allow-Origin: * -`, - }, - { - title: 'Security considerations', - sectionContent: ` -When processing HTTP requests on your API server, you cannot guarantee that your own extension will have made every request. When responding with sensitive data, keep in mind that requests could originate from anywhere on the Internet. - -Your extension can pass a [session token](/docs/api/checkout-ui-extensions/latest/apis/session-token) to your API server but this only guarantees the integrity of its claims. It does not guarantee the request itself originated from Shopify. For example, your API server could trust the session token's \`sub\` claim (the customer ID) but it could not trust a \`?customer_id=\` query parameter. - -Consider a scenario where your extension retrieves a discount code from your API server and [applies it to the checkout](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-applydiscountcodechange). It would not be safe to expose an API endpoint named \`/get-discount-code\` if any buyer could make a direct HTTP request and obtain a discount code. -`, - }, - { - title: 'App Proxy', - sectionContent: ` -UI extensions can make fetch requests to [App Proxy](/docs/apps/online-store/app-proxies) URLs, but there are some differences and limitations related to the security context within which UI extensions run. - -UI extension requests made to the App Proxy will execute as CORS requests. See _Required CORS headers_ above for information about requirements related to CORS. - -UI extension requests made to the App Proxy will not assign the logged_in_customer_id query parameter. Instead use a [session token](/docs/api/checkout-ui-extensions/latest/apis/session-token) which provides the sub claim for the logged in customer. - -UI extension requests made to the App Proxy of password protected shops is not supported. Extension requests come from a web worker which does not share the same session as the parent window. - -The App Proxy doesn't handle all [HTTP request methods](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods). Specifically, CONNECT and TRACE are unsupported. -`, - }, - ], - }, - { - type: 'Generic', - anchorLink: 'block-progress', - title: 'Block progress', - sectionContent: - "The following section describes blocking the buyer's progress through checkout, and how you can detect whether the merchant has allowed it.", - sectionCard: [ - { - name: 'Blocking examples', - subtitle: 'See', - url: '/docs/api/checkout-ui-extensions/apis/buyer-journey#examples', - type: 'blocks', - }, - ], - codeblock: { - title: 'Enable progress blocking', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/block-progress.example.toml', - language: 'toml', - }, - ], - }, - sectionSubContent: [ - { - title: 'When to request blocking progress', - sectionContent: ` -If your extension relies on specific input then you might need to block the buyer's progress until they've provided all required information. You can do this with a [buyer journey](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-buyerjourney) intercept, by returning \`behavior: 'block'\`. - -For example, for some purchases you need to collect and verify a customer's age. For the order to be valid, you need to verify that an age is set and that it's greater than or equal to a minimum value. - -In order to block checkout progress, your extension must have the \`block_progress\` capability. -`, - }, - { - title: 'Granting the capability to block progress', - sectionContent: ` -Setting \`block_progress\` in the \`shopify.extension.toml\` file informs merchants that your extension blocks the buyer's progress for invalid orders. Merchants can allow or disallow this capability in the checkout editor. - -> Note: -> When running a local extension with the \`block_progress\` capability, it will be automatically granted. This simulates a scenario where the merchant has allowed the capability. -`, - }, - { - title: 'Detecting the ability to block progress', - sectionContent: ` -In your extension, look for \`block_progress\` in [extension.capabilities](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-extension) to see if the merchant has granted the blocking capability. - -If the merchant declined the permission for your app to block progress, the \`behavior: 'block'\` option in the [buyer journey](/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-buyerjourney) intercept will be treated as \`behavior: 'allow'\`, and checkout will proceed as normal. - -When developing a local extension, you can remove the \`block_progress\` capability from your \`shopify.extension.toml\` file to simulate a merchant disallowing the capability. - -> Tip: -> We recommend having some UI to cover cases where you can't block checkout progress. For example, you might want to show a warning rather than block checkout progress when an order doesn't pass validation.`, - }, - ], - }, - { - type: 'Generic', - anchorLink: 'collect-buyer-consent', - title: 'Collect buyer consent', - sectionContent: - 'If your extension utilizes the [ConsentCheckbox](/docs/api/checkout-ui-extensions/components/forms/consentcheckbox) or [ConsentPhoneField](/docs/api/checkout-ui-extensions/components/forms/consentphonefield) components to render a customized UI for collecting buyer consent, you must first declare that capability in your configuration file.', - sectionSubContent: [ - { - title: 'SMS Marketing', - sectionContent: - "In order to collect buyer consent for SMS marketing, you'll need to specifically declare this intent using `sms_marketing = true` in your toml configuration. This corresponds to the `policy` prop for the `Consent` components.", - }, - { - title: 'Customer Privacy', - sectionContent: - "In order to collect customer privacy consent, you'll need to add `customer_privacy = true` in your toml configuration. This will let you use our [Customer Privacy API](/docs/api/checkout-ui-extensions/latest/apis/customer-privacy).", - }, - ], - codeblock: { - title: 'Collect buyer consent', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/collect-buyer-consent.example.toml', - language: 'toml', - }, - ], - }, - }, - { - type: 'Generic', - anchorLink: 'metafields', - title: 'Metafields', - sectionContent: ` -Defines the [metafields](/docs/apps/custom-data/metafields) that are available to your extension. You retrieve these metafields in your extension by reading [\`appMetafields\`](/docs/api/checkout-ui-extensions/latest/apis/metafields#standardapi-propertydetail-appmetafields). - -Define the metafields your extension needs using \`[[extensions.metafields]]\` and \`[[extensions.targeting.metafields]]\`. - -You can use \`[[extensions.metafields]]\` for metafields that your extension always needs, while you can use \`[[extensions.targeting.metafields]]\` if you only want to fetch metafields when your extension is placed in a specific extension target. - -> Tip: -> You may write to \`cart\` metafields by using [\`applyMetafieldsChange\`](/docs/api/checkout-ui-extensions/apis/checkoutapi#properties-propertydetail-applymetafieldchange) with \`type: "updateCartMetafield"\`. - `, - sectionSubContent: [ - { - title: 'App owned metafields', - sectionContent: ` -[App owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) are supported. You can use app owned metafields when your app needs to control the data and visibility of the metafield. - -Your extension can access app owned metafields that are requested in its toml using the \`$app\` format. Your extension can only access app owned metafields that belong to its parent app. - -> Caution: -> When accessing app owned metafields, you must use the \`$app\` format. The fully qualified reserved namespace format such as \`app--{your-app-id}[--{optional-namespace}]\` is not supported. - `, - sectionCard: [ - { - name: 'App owned metafields', - subtitle: 'Learn more', - url: '/docs/apps/build/custom-data/ownership#reserved-prefixes', - type: 'tutorial', - }, - ], - }, - { - title: 'Supported resource metafield types', - sectionContent: ` -Supported resource metafield types include: - -| Resource | Description | -|---| --- | -| \`cart\` | The cart associated with the current checkout. | -| \`company\` | The company for B2B checkouts. | -| \`companyLocation\` | The company's location for B2B checkouts. | -| \`customer\` | The customer account that is interacting with the current checkout. | -| \`product\` | The products that the customer intends to purchase. | -| \`shop\` | The shop that is associated with the current checkout. | -| \`shopUser\` | The Shop App user that is associated with the current checkout if there is one. | -| \`variant\` | The product variants that the customer intends to purchase. | - -Other resource metafield types outside of the above list are not supported. - `, - }, - ], - codeblock: { - title: 'Metafields', - tabs: [ - { - title: 'Metafields', - code: './examples/configuration/metafields.example.toml', - language: 'toml', - }, - ], - }, - sectionCard: [ - { - name: 'useAppMetafields', - subtitle: 'Hook', - url: '/docs/api/checkout-ui-extensions/react-hooks/metafields/useappmetafields', - type: 'blocks', - }, - { - name: 'useApplyMetafieldsChange', - subtitle: 'Hook', - url: '/docs/api/checkout-ui-extensions/react-hooks/metafields/useapplymetafieldschange', - type: 'blocks', - }, - ], - }, - { - type: 'Markdown', - anchorLink: 'settings-definition', - title: 'Settings definition', - sectionContent: - "The settings for a checkout UI extension define a set of fields that the merchant can set a value for from the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor). You can use validation options to apply additional constraints to the data that the setting can store, such as a minimum or maximum value. \n\n Each settings definition can include up to 20 settings. \n\n > Note: \n > All setting inputs are optional. You should code the extension so that it still works if the merchant hasn't set a value for the setting.", - sectionSubContent: [ - { - title: 'Properties', - sectionContent: - 'The following table describes the properties that you can use to define a setting:\n\n | Property | Required? | Description | Example |\n|---|---|---|---|\n| `key` | Yes | The key of the setting. When a merchant configures a value for this setting, the value will be exposed under this `key` when running your extension |
"banner_title"
|\n| `type` | Yes | The [type](#supported-setting-types) of setting. |
"single_line_text_field"
|\n| `name` | Yes | The name of the setting. `name` is displayed to the merchant in the checkout editor. |
"Banner title"
|\n| `description` | No | The description of the setting. `description` is displayed to the merchant in the checkout editor. |
"Enter a title for the banner."
|\n| `validations` | No | Constraints on the setting input that Shopify validates. |
validations: 
name = "max",
value = "25"
|', - }, - { - title: 'Supported setting types', - sectionContent: - 'The setting type determines the type of information that the setting can store. The setting types have built-in validation on the setting input. \n\n Settings can have the following types: \n\n| Type | Description | Example value |\n|---|---|---|\n| `boolean` | A true or false value. |
true
|\n| `date` | A date in ISO 8601 format without a presumed time zone. |
2022-02-02
|\n| `date_time` | A date and time in ISO 8601 format without a presumed time zone. |
2022-01-01T12:30:00
|\n| `single_line_text_field` | A single line string. |
Canada
|\n| `multi_line_text_field` | A multi-line string. |
Canada
United States
Brazil
Australia
|\n| `number_integer` | A whole number in the range of +/-9,007,199,254,740,991. |
10
|\n| `number_decimal` | A number with decimal places in the range of +/-9,999,999,999,999.999999999. |
10.4
|\n| `variant_reference` | A globally-unique identifier (GID) for a product variant. |
gid://shopify/ProductVariant/1
 |',
-        },
-        {
-          title: 'Validation options',
-          sectionContent:
-            'Each setting can include validation options. Validation options enable you to apply additional constraints to the data that a setting can store, such as a minimum or maximum value, or a regular expression. The setting\'s `type` determines the available validation options. \n\n You can include a validation option for a setting using the validation `name` and a corresponding `value`. The appropriate value depends on the setting type to which the validation applies.\n\n The following table outlines the available validation options with supported types for applying constraints to a setting:\n\n | Validation option | Description | Supported types | Example |\n|---|---|---|---|\n| Minimum length | The minimum length of a text value. | 
  • single_line_text_field
  • multi_line_text_field
|
[[extensions.settings.fields.validations]]
name = "min"
value = "8"
|\n| Maximum length | The maximum length of a text value. |
  • single_line_text_field
  • multi_line_text_field
|
[[extensions.settings.fields.validations]]
name = "max"
value = "25"
|\n| Regular expression | A regular expression. Shopify supports [RE2](https://github.com/google/re2/wiki/Syntax). |
  • single_line_text_field
  • multi_line_text_field
|
[[extensions.settings.fields.validations]]
name = "regex"
value = "(@)(.+)$"
|\n| Choices | A list of up to 128 predefined options that limits the values allowed for the metafield. | `single_line_text_field` |
[[extensions.settings.fields.validations]]
name = "choices"
value = "[\\\\"red\\\\", \\\\"green\\\\", \\\\"blue\\\\"]"
|\n| Minimum date | The minimum date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. | `date` |
[[extensions.settings.fields.validations]]
name = "min"
value = "2022-01-01"
|\n| Maximum date | The maximum date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. | `date` |
[[extensions.settings.fields.validations]]
name = "max"
value = "2022-03-03"
|\n| Minimum datetime | The minimum date and time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. | `date_time` |
[[extensions.settings.fields.validations]]
name = "min"
value = "2022-03-03T16:30:00"
|\n| Maximum datetime | The maximum date and time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. | `date_time` |
[[extensions.settings.fields.validations]]
name = "max"
value = "2022-03-03T17:30:00"
|\n| Minimum integer | The minimum integer number. | `number_integer` |
[[extensions.settings.fields.validations]]
name = "min"
value = "9"
|\n| Maximum integer | The maximum integer number. | `number_integer` |
[[extensions.settings.fields.validations]]
name = "max"
value = "15"
|\n| Minimum decimal | The minimum decimal number. | `number_decimal` |
[[extensions.settings.fields.validations]]
name = "min"
value = "0.5"
|\n| Maximum decimal | The maximum decimal number. | `number_decimal` |
[[extensions.settings.fields.validations]]
name = "max"
value = "1.99"
|\n| Maximum precision | The maximum number of decimal places to store for a decimal number. | `number_decimal` |
[[extensions.settings.fields.validations]]
name = "max_precision"
value = "2"
|', - }, - ], - }, - { - type: 'Generic', - anchorLink: 'example-settings-definition', - title: 'Example settings definition', - sectionContent: - 'The following example shows a settings definition that defines a setting named `banner_title` of type `single_line_text_field`. When the merchant sets a value for this setting from the checkout editor, Shopify validates that the provided value is between 5 and 20 characters in length \n\n Learn more about the settings api by completing our [custom banners example](/apps/checkout/custom-banners/add-custom-banner).', - sectionCard: [ - { - name: 'Settings example code', - subtitle: 'See', - url: '/docs/api/checkout-ui-extensions/apis/standardapi#example-settings', - type: 'blocks', - }, - ], - codeblock: { - title: 'Example settings', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/settings.example.toml', - language: 'toml', - }, - ], - }, - }, - { - type: 'Generic', - anchorLink: 'preloads-definition', - title: 'Preloads definition', - sectionContent: ` -For specific targets, you must provide the URL of assets or pages loaded by UI components within its extension. This allows Shopify to preload them as early as possible and ensure a performant experience for buyers. Currently, the only supported property is \`chat\` for the [\`Chat\` component](/docs/api/checkout-ui-extensions/latest/components/overlays/chat). - -The \`chat\` property specifies the URL for the iframe used in this extension target. The URL can be absolute or relative. Relative URLs are resolved against the app URL defined in the app configuration. - -For example, - -* if the app URL is \`https://example.com\` and \`chat = "/my-chat-application"\`, the resolved URL will be \`https://example.com/my-chat-application\`. -* if \`chat = "https://my-chat-application.com"\`, the resolved URL will be \`https://my-chat-application.com\`. - `, - codeblock: { - title: 'Extension target preloads', - tabs: [ - { - title: 'shopify.extension.toml', - code: './examples/configuration/preloads.example.toml', - language: 'toml', - }, - ], - }, - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/error-handling.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/staticPages/error-handling.doc.ts deleted file mode 100644 index efa4cb558b..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/error-handling.doc.ts +++ /dev/null @@ -1,55 +0,0 @@ -import type {LandingTemplateSchema} from '@shopify/generate-docs'; - -const data: LandingTemplateSchema = { - title: 'Error handling', - description: - 'You can use standard web techniques to handle errors in [checkout UI extensions](/api/checkout-ui-extensions/) but you may need to account for how they run inside of a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API).', - id: 'error-handling', - sections: [ - { - type: 'Generic', - anchorLink: 'handling-any-error', - title: 'Handling any error', - sectionContent: - 'Add an `unhandledrejection` listener for promise rejections or an `error` listener for other exceptions like Javascript runtime errors or failures to load a resource.', - codeblock: { - title: 'Handling any error', - tabs: [ - { - code: './examples/error-handling/handling-any-error.example.ts', - language: 'ts', - }, - ], - }, - }, - { - type: 'Generic', - anchorLink: 'third-party-libraries', - title: 'Third party libraries', - sectionContent: ` -You can use error reporting libraries like [Sentry](https://sentry.io/). However, they might require extra configuration because UI extensions run inside of a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). You should also consider using [source maps](https://shopify.dev/docs/apps/build/checkout/test-checkout-ui-extensions#troubleshooting-with-source-maps) to help debug errors. - -> Tip: -> You must request [network access](/api/checkout-ui-extensions/configuration#network-access) to transmit errors to a third party service. -`, - }, - { - type: 'Generic', - anchorLink: 'sentry', - title: 'Sentry', - sectionContent: ` - Install and initialize Sentry following their [Browser JavaScript guide](https://docs.sentry.io/platforms/javascript/). We recommend disabling the default integrations to be sure it will run within a Web Worker. You'll need to add event listeners manually.`, - codeblock: { - title: 'Sentry', - tabs: [ - { - code: './examples/error-handling/sentry.example.tsx', - language: 'ts', - }, - ], - }, - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/default.example.toml b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/default.example.toml index 5a040e5217..43d68789d0 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/default.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/default.example.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] type = "ui_extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/extended.example.toml b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/extended.example.toml index 0a5f5125be..d85d4fad6a 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/extended.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/extended.example.toml @@ -1,4 +1,4 @@ -api_version ="2026-01" +api_version ="2026-04" [[extensions]] type = "ui_extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/settings.example.toml b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/settings.example.toml index 12e475ad94..cc5ee16226 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/settings.example.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/configuration/settings.example.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] type = "ui_extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/package-json-new.json b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/package-json-new.json index 0ced37545f..927f35435d 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/package-json-new.json +++ b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/package-json-new.json @@ -2,6 +2,6 @@ "dependencies": { "preact": "^10.10.x", "@preact/signals": "^2.3.x", - "@shopify/ui-extensions": "2026.1.0" + "@shopify/ui-extensions": "2026.4.0-rc.0" } } diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/shopify.extension-new.toml b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/shopify.extension-new.toml index 59168bb501..d2948f4e6b 100644 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/shopify.extension-new.toml +++ b/packages/ui-extensions/docs/surfaces/checkout/staticPages/examples/upgrading-to-2025-10/shopify.extension-new.toml @@ -1,4 +1,4 @@ -api_version = "2026-01" +api_version = "2026-04" [[extensions]] name = "your-extension" diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/extension-overview.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/staticPages/extension-overview.doc.ts deleted file mode 100644 index 4f1fa2a6a8..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/extension-overview.doc.ts +++ /dev/null @@ -1,202 +0,0 @@ -import type {LandingTemplateSchema} from '@shopify/generate-docs'; - -// Order of data shape mimics visual structure of page -// Anything in an array can have multiple objects - -const data: LandingTemplateSchema = { - // The title of the page. - title: 'Targets Overview', - // A short description of the page. Appears in the hero section below the title. - description: ` -A [target](/docs/apps/app-extensions/configuration#targets) represents where your checkout UI extension will appear. - -You register for targets in your [configuration file](/docs/api/checkout-ui-extensions/configuration), and you include a JavaScript function that will run at that location in checkout. - `, - // The id for the page that is used for routing. If this documentation is for a primary landing page, confirm id matches the reference name. - id: 'extension-targets-overview', - // Basic content for the page and Hero section. - sections: [ - { - type: 'GenericAccordion', - title: 'Checkout locations', - anchorLink: 'supported-locations', - sectionContent: - 'Checkout is where buyers go to purchase goods. Checkout consists of the information, shipping, and payment steps in addition to the order summary and Shop Pay. Learn more about building [custom functionality for checkout](/docs/api/checkout-ui-extensions).', - accordionContent: [ - { - title: 'Information', - description: ` -This is the first step in the checkout process where the buyer enters contact information and a delivery address. - -Review [all extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-information.png', - }, - { - title: 'Shipping', - description: ` -Point in checkout where the buyer selects a shipping method. - -Review [all extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-shipping.png', - }, - { - title: 'Payment', - description: ` -Point in checkout where the buyer enters their payment information. - -Review [all extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-payment.png', - }, - { - title: 'Order summary', - description: ` -Summary of the cart contents, discounts, and order totals. - -Review [all extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-order-summary.png', - }, - { - title: 'Shop Pay', - description: ` -Accelerated checkout where Shopify pre-fills buyer information using their Shop Pay account. - -Review [all extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-shop-pay.png', - }, - { - title: 'Split shipping', - description: ` -When multiple shipments are expected, a checkout will render split shipping options. - -Review [all extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-split-shipping.png', - }, - { - title: 'Local Pickup', - description: ` -Point in checkout where the buyer can select a store location to pick up their purchase. - -Review [all extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-local-pickup.png', - }, - { - title: 'Pickup Points', - description: ` -Point in checkout where the buyer can select a pickup point to have their purchase delivered to. - -Review [all extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-pickup-points.png', - }, - { - title: 'Overlays', - description: ` -Static extension targets that floats above the checkout. - -Review [all extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-chat.png', - }, - { - title: 'One-page checkout', - description: ` -All checkout pages (information, shipping, and payment) are combined into a single page with the order summary. - -Get started testing extensions on [one-page checkout](/docs/apps/checkout/best-practices/testing-ui-extensions#one-page-checkout). -`, - image: 'supported-locations-one-page-checkout.png', - }, - ], - }, - { - type: 'GenericAccordion', - title: 'Thank you locations', - anchorLink: 'supported-typ-locations', - sectionContent: - 'The **Thank you** page is shown to buyers immediately after a checkout is successfully submitted. Learn more about building for [the **Thank you** page](/docs/apps/checkout/thank-you-order-status).', - accordionContent: [ - { - title: 'Order details', - description: ` -Displays all order information to buyers. - -Review [all **Thank you** page extension targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-thank-you.png', - }, - { - title: 'Order summary', - description: ` -Summary of the cart contents, discounts, and order totals. - -Review [all **Thank you** page extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-order-summary-thank-you.png', - }, - { - title: 'Overlays', - description: ` -Static extension targets that floats above the Thank you page. - -Review [all **Thank you** page extensions targets](/docs/api/checkout-ui-extensions/targets). -`, - image: 'supported-locations-chat-thank-you.png', - }, - ], - }, - { - type: 'Generic', - // Anchor link for the section. - anchorLink: 'static-extension-targets', - // The title of the section. - title: 'Static extension targets', - // Content for the section. - image: 'static-extension-targets.png', - sectionContent: `Static extension targets render immediately before or after most core checkout features such as contact information, shipping methods, and order summary line items. Merchants use the [checkout editor](/apps/checkout/test-ui-extensions#test-the-extension-in-the-checkout-editor) to activate and place the extension in the checkout experience. - \n\nWhen a core checkout feature isn't rendered, neither are the static extension targets tied to it. For example, shipping methods aren't shown when customers select the option for store pickup and the UI extensions that load before or after the shipping method aren't rendered. - \n\nChoose static extension targets when your content and functionality is closely related to a core checkout feature. An example is a shipping delay notice. - `, - sectionCard: [ - { - name: 'Extension targets', - subtitle: 'API reference', - url: '/docs/api/checkout-ui-extensions/targets', - type: 'blocks', - }, - ], - }, - { - type: 'Generic', - anchorLink: 'block-extension-targets', - title: 'Block extension targets', - sectionContent: `Block extension targets render between core checkout features. Merchants can use the [checkout and accounts editor](/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor) to place the extension in the [**checkout**](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-locations), [**Thank you**](/docs/api/checkout-ui-extensions/extension-targets-overview#supported-typ-locations) pages. - \n\nBlock extensions are always rendered, regardless of what other checkout elements are present. For example, an extension placed above the shipping address will still render even for digital products which don't require a shipping address.\n\nChoose block extension targets when your content and functionality works independently of a core checkout feature. This is useful for custom content, like a field to capture order notes from the customer. - \n\nBlock extension targets always support multiple placements. Each placement has an associated placement reference that represents its location on the page. For example, the block extension target \`purchase.checkout.block.render\` supports fourteen placements. The placement references include \`INFORMATION1\`, \`DELIVERY1\`, \`PAYMENT1\`, and more. - \n\nYou can use placement references as URL parameters to [test block extensions](/docs/apps/build/checkout/test-checkout-ui-extensions#block-targets) in all supported placements on a page. You can also use placement references to [define the default placement](/docs/apps/build/app-extensions/configure-app-extensions#checkout-ui-extensions) of an extension for merchants.`, - image: 'block-extension-targets.png', - sectionCard: [ - { - name: 'Extension targets', - subtitle: 'API reference', - url: '/docs/api/checkout-ui-extensions/targets', - type: 'blocks', - }, - { - name: 'Placement references', - subtitle: 'Learn more', - url: '/docs/apps/build/checkout/test-checkout-ui-extensions#placement-references', - type: 'resource', - }, - ], - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/docs/surfaces/checkout/staticPages/overview.doc.ts b/packages/ui-extensions/docs/surfaces/checkout/staticPages/overview.doc.ts deleted file mode 100644 index a7ff66bbd0..0000000000 --- a/packages/ui-extensions/docs/surfaces/checkout/staticPages/overview.doc.ts +++ /dev/null @@ -1,297 +0,0 @@ -import type {LandingTemplateSchema} from '@shopify/generate-docs'; - -const data: LandingTemplateSchema = { - title: 'Checkout UI extensions', - description: `Checkout UI extensions let app developers build custom functionality that merchants can install - at defined points in the checkout flow, including product information, shipping, payment, - order summary, and Shop Pay. - \n\n > Shopify Plus: \n>Checkout UI extensions for the information, shipping and payment step are available only to stores on a [Shopify Plus](https://www.shopify.com/plus) plan.`, - id: 'checkout-ui-extensions', - image: - '/assets/landing-pages/templated-apis/checkout-ui-extensions/checkout-ui.png', - darkImage: - '/assets/landing-pages/templated-apis/checkout-ui-extensions/checkout-ui-dark.png', - mobileImage: - '/assets/landing-pages/templated-apis/checkout-ui-extensions/checkout-ui-mobile.png', - mobileDarkImage: - '/assets/landing-pages/templated-apis/checkout-ui-extensions/checkout-ui-mobile-dark.png', - sections: [ - { - type: 'Generic', - anchorLink: 'scaffolding-extension', - title: 'Scaffolding an extension', - sectionContent: `Use the Shopify CLI to [generate a new extension](/docs/api/shopify-cli/app/app-generate-extension) in the directory of your app. - -Make sure you’re using Shopify CLI \`v3.85.3\` or higher. You can check your version by running \`shopify version\`. - `, - codeblock: { - title: 'Shopify CLI', - tabs: [ - { - code: './examples/scaffolding.example.bash', - language: 'bash', - }, - ], - }, - initialLanguage: 'bash', - }, - { - type: 'Generic', - anchorLink: 'eslint-configuration', - title: 'Optional ESLint configuration', - sectionContent: ` -If your app is using ESLint, update your configuration to include the new global \`shopify\` object. - `, - codeblock: { - title: '.eslintrc.cjs', - tabs: [ - { - code: './examples/eslint-configuration.example.ts', - language: 'js', - }, - ], - }, - initialLanguage: 'js', - }, - { - type: 'Generic', - anchorLink: 'configuration-file', - title: 'Configuration file', - sectionContent: `When you create a UI extension, the \`shopify.extension.toml\` file is generated in your extension directory. Use this file to configure your extension name, extension targets, metafields, capabilities, and settings definition. - -Extension targets provide locations where merchants can insert custom content. Static extension targets are tied to core checkout features like contact information, shipping methods, and order summary line items. Block targets can display at any point in the checkout process and will always render regardless of which checkout features are available. An example is a field to capture order notes from the customer.`, - sectionCard: [ - { - name: 'Configuration guide', - subtitle: 'Learn more', - url: '/docs/api/checkout-ui-extensions/configuration', - type: 'gear', - }, - { - name: 'Extension targets', - subtitle: 'Overview', - url: '/docs/api/checkout-ui-extensions/extension-targets-overview', - type: 'blocks', - }, - ], - codeblock: { - title: 'shopify.extension.toml', - tabs: [ - { - code: './examples/configuration/default.example.toml', - language: 'toml', - }, - ], - }, - initialLanguage: 'yaml', - }, - { - type: 'Generic', - anchorLink: 'extension-functions', - title: 'Extension functions', - sectionContent: `Checkout will execute the module’s default export so it can render a user interface. - -Extension UIs are powered by [Remote DOM](https://github.com/Shopify/remote-dom/), a fast and secure environment for custom [(non-DOM)](#security) UIs.`, - sectionCard: [], - codeblock: { - title: 'Extension.jsx', - tabs: [ - { - code: './examples/extension-functions.example.tsx', - language: 'tsx', - }, - ], - }, - initialLanguage: 'tsx', - }, - { - type: 'Generic', - title: 'Preact by default', - sectionContent: `UI Extensions are scaffolded with [Preact](https://preactjs.com/) by default. This means you can use Preact patterns and principles within your extension. - -Since Preact is included as a standard dependency, you have access to all of its features including [hooks](https://preactjs.com/guide/v10/hooks/) like \`useState\` and \`useEffect\` for managing component state and side effects. - -You can also use [Preact Signals](https://preactjs.com/guide/v10/signals/) for reactive state management, and take advantage of standard web APIs just like you would in a regular Preact application. - `, - anchorLink: 'preact-by-default', - codeblock: { - title: 'Extension.jsx', - tabs: [ - { - code: './examples/preact-by-default.jsx', - language: 'jsx', - }, - ], - }, - }, - { - type: 'Generic', - anchorLink: 'extension-apis', - title: 'Extension APIs', - sectionContent: `The platform defines a global \`shopify\` object that contains all properties and methods available to UI extensions. - -These APIs enable UI extensions to get information about the checkout or related objects and to perform actions. For example, you can retrieve what’s in customer carts and offer related products. - -APIs with a \`value\` property are [Preact Signals](https://preactjs.com/guide/v10/signals/). Preact will automatically re-render your extension as values change. -`, - sectionCard: [ - { - name: 'Checkout extensions API', - subtitle: 'API reference', - url: '/docs/api/checkout-ui-extensions/apis', - type: 'blocks', - }, - ], - codeblock: { - title: 'Extension.jsx', - tabs: [ - { - code: './examples/extension-apis.example.tsx', - language: 'tsx', - }, - ], - }, - initialLanguage: 'tsx', - }, - { - type: 'Generic', - anchorLink: 'ui-components', - title: 'UI components', - sectionContent: `Checkout UI extensions declare their interface using [Polaris web components](/docs/api/checkout-ui-extensions/using-polaris-components). Shopify renders the UI natively, so it’s performant, accessible, and works in all of checkout’s supported browsers. - -Checkout components are designed to be flexible, enabling you to layer and mix them to create highly-customized app extensions that feel seamless within the checkout experience. All components inherit a merchant’s brand settings and the CSS cannot be altered or overridden.`, - sectionCard: [ - { - name: 'Component library', - subtitle: 'API reference', - url: '/docs/api/checkout-ui-extensions/latest/polaris-web-components', - type: 'blocks', - }, - { - name: 'Figma UI kit', - subtitle: 'UI Reference', - url: 'https://www.figma.com/community/file/1554582792754361051', - type: 'setting', - }, - ], - codeblock: { - title: 'Extension.jsx', - tabs: [ - { - code: './examples/ui-components.example.tsx', - language: 'tsx', - }, - ], - }, - initialLanguage: 'tsx', - }, - { - type: 'Generic', - anchorLink: 'security', - title: 'Security', - sectionContent: ` -Checkout UI extensions are a safe and secure way to customize the appearance and functionality of the checkout page without compromising the security of checkout or customer data. -- They run in an isolated sandbox, separate from the checkout page and other UI extensions. -- They don't have access to sensitive payment information or the checkout page itself (HTML or other assets). -- They are limited to specific UI components and APIs that are exposed by the platform. -- They have limited access to [global web APIs](https://github.com/Shopify/ui-extensions/blob/2025-10/documentation/runtime-environment.md). -- Apps that wish to access [protected customer data](/docs/apps/store/data-protection/protected-customer-data), must submit an application and are subject to strict security guidelines and review proccesses by Shopify. -`, - sectionNotice: [ - { - title: 'Constraints', - sectionContent: ` -You can’t override the CSS for UI components. The checkout UI will always render the merchant’s own branding. - -Checkout UI extensions don’t have access to the real checkout DOM and can’t render arbitrary HTML such as \`
\` elements or \` diff --git a/packages/ui-extensions/src/surfaces/admin/components/DropZone/examples/with-accessibility-options.jsx b/packages/ui-extensions/src/surfaces/admin/components/DropZone/examples/with-accessibility-options.jsx deleted file mode 100644 index 47578299ab..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/DropZone/examples/with-accessibility-options.jsx +++ /dev/null @@ -1,6 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/DropZone/examples/with-error-state.jsx b/packages/ui-extensions/src/surfaces/admin/components/DropZone/examples/with-error-state.jsx deleted file mode 100644 index 63ffbcd383..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/DropZone/examples/with-error-state.jsx +++ /dev/null @@ -1,4 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField.d.ts b/packages/ui-extensions/src/surfaces/admin/components/EmailField.d.ts index 8086c1c1f4..5ffc176491 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/EmailField.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -9,59 +9,213 @@ import type { TextFieldProps, EmailFieldProps$1, - PreactCustomElement, - RenderImpl, + ComponentChildren, } from './shared.d.ts'; +/** + * An event with a strongly-typed currentTarget property for a specific HTML element. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event listener is attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * A callback function that receives a strongly-typed event for a specific HTML element. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; +/** + * The React-style event callback props for form field components. + * @publicDocs + */ export interface FieldReactProps { + /** + * A callback that's invoked when the user makes any changes in the field. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). + */ onInput?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). + */ onChange?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). + */ onFocus?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). + */ onBlur?: ((event: CallbackEvent) => void) | null; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles for the component's shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a Preact component in a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's Preact elements into the shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * The properties from an event that indicate how the user activated an element. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was held down when the event occurred. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on macOS) was held down when the event occurred. + */ + metaKey: boolean; + /** + * Whether the Control key was held down when the event occurred. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed when the event occurred. A value of 0 indicates the primary button (usually left), 1 indicates the middle button, and 2 indicates the secondary button (usually right). + */ + button: number; +} +/** + * The options for influencing a programmatic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The base properties for an input element that participates in form submission. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** @private */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the user makes any changes in the field. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the field is disabled, disallowing any interaction. + * + * @default false + */ accessor disabled: PreactInputProps['disabled']; + /** + * An identifier for the field. + */ accessor id: PreactInputProps['id']; + /** + * An identifier for the field that's unique within the nearest containing form. + */ accessor name: PreactInputProps['name']; + /** + * The current value for the field. + */ get value(): PreactInputProps['value']; set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * The base properties for form field elements that support labels, validation, and autocomplete. + * @publicDocs + */ export type PreactFieldProps = PreactInputProps & Required< @@ -81,10 +235,10 @@ export type PreactFieldProps = * 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 + * autofill, but you don't have any more semantic information on the intended * contents. * - * When set to `off`, you are indicating that this field contains sensitive + * When set to `off`, you're 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 @@ -99,20 +253,58 @@ export type PreactFieldProps = */ autocomplete: Autocomplete; }; +/** @private */ declare class PreactFieldElement extends PreactInputElement implements PreactFieldProps { + /** + * A callback that's invoked when the field loses focus. + */ accessor onblur: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the field receives focus. + */ accessor onfocus: CallbackEventListener<'input'>; + /** + * A hint as to the intended content of the field for autocomplete purposes. + */ accessor autocomplete: PreactFieldProps['autocomplete']; + /** + * The initial value for the field when it's first rendered. + */ accessor defaultValue: PreactFieldProps['defaultValue']; + /** + * Additional descriptive text to display below the field that provides supplementary information. + */ accessor details: PreactFieldProps['details']; + /** + * An error message to display below the field, indicating validation failure or other issues. + */ accessor error: PreactFieldProps['error']; + /** + * The text label to display for the field, describing what the user should enter. + */ accessor label: PreactFieldProps['label']; + /** + * Controls the visibility of the label for accessibility purposes. + */ accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility']; + /** + * The placeholder text that's displayed inside the field when it's empty, providing a hint about expected input. + */ accessor placeholder: PreactFieldProps['placeholder']; + /** + * Whether the field is read-only, preventing edits while still allowing focus and selection. + * + * @default false + */ accessor readOnly: PreactFieldProps['readOnly']; + /** + * Whether the field must be filled out before form submission. + * + * @default false + */ accessor required: PreactFieldProps['required']; /** * Global keyboard event handlers for things like key bindings typically @@ -141,18 +333,41 @@ declare class PreactFieldElement constructor(renderImpl: RenderImpl); } +/** + * The properties for the email field component. These properties configure a specialized text input field for entering email addresses with built-in validation and appropriate keyboard support. + * @publicDocs + */ export type EmailFieldProps = PreactFieldProps< Required['autocomplete'] > & Required>; +/** + * The email field custom element class that renders an email input field in the Shopify admin interface. This component allows merchants to enter email addresses with automatic validation and optimized mobile keyboard layouts. + */ declare class EmailField extends PreactFieldElement implements EmailFieldProps { + /** + * A hint as to the intended content of the field for autocomplete purposes. + * + * @default 'email' + */ accessor autocomplete: EmailFieldProps['autocomplete']; + /** + * The maximum number of characters the user can enter in the field. + */ accessor maxLength: EmailFieldProps['maxLength']; + /** + * The minimum number of characters required in the field for validation. + */ accessor minLength: EmailFieldProps['minLength']; + /** + * The current email address value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as an email address format when the user finishes editing. + */ + get value(): string; + set value(value: string); constructor(); } declare global { @@ -169,6 +384,10 @@ declare module 'preact' { } declare const tagName = 's-email-field'; +/** + * The JSX props for the email field component. These properties extend `EmailFieldProps` with JSX-specific event callbacks for React-style event handling. + * @publicDocs + */ export interface EmailFieldJSXProps extends Partial>, Pick, diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/EmailField.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/EmailField/EmailField.doc.ts deleted file mode 100644 index ec0d22f6e9..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/EmailField.doc.ts +++ /dev/null @@ -1,160 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/EmailField'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/emailfield.png', - isVisualComponent: true, - definitions: [ - { - title: 'Properties', - description: '', - type: 'EmailField', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'EmailFieldEvents', - }, - ], - defaultExample: { - image: 'emailfield-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple email field with a label and required attribute, showing the most fundamental way to use the EmailField component.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Showcases an email field with additional details and an error message, illustrating how to provide contextual information and validation feedback.', - codeblock: { - title: 'With error and help text', - tabs: [ - { - code: './examples/with-error-and-help-text.html', - language: 'html', - }, - - { - code: './examples/with-error-and-help-text.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates an optional email field with a placeholder text and help text, demonstrating a common pattern for collecting alternative contact information.', - codeblock: { - title: 'Optional field with placeholder', - tabs: [ - { - code: './examples/optional-field-with-placeholder.html', - language: 'html', - }, - - { - code: './examples/optional-field-with-placeholder.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how to render an email field in a read-only state, useful for displaying existing email addresses that cannot be modified.', - codeblock: { - title: 'Read-only display', - tabs: [ - { - code: './examples/read-only-display.html', - language: 'html', - }, - - { - code: './examples/read-only-display.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates setting minimum and maximum length constraints for the email input, providing additional validation beyond the standard email format check.', - codeblock: { - title: 'With length constraints', - tabs: [ - { - code: './examples/with-length-constraints.html', - language: 'html', - }, - - { - code: './examples/with-length-constraints.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - { - title: 'Form validation', - examples: [ - { - description: - 'Interactive example showing real-time email validation with error messages that update as the user types.', - codeblock: { - title: 'Email validation', - tabs: [ - { - code: './examples/validation-example.jsx', - language: 'preview-jsx', - layout: 'formWrapper', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/basic-usage.html deleted file mode 100644 index 79bd267f18..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/basic-usage.html +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/basic-usage.jsx deleted file mode 100644 index f5878b1bf8..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/basic-usage.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/default.jsx deleted file mode 100644 index eb3caa8e70..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/default.jsx +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/disabled-state.html b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/disabled-state.html new file mode 100644 index 0000000000..705387e286 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/disabled-state.html @@ -0,0 +1,5 @@ + diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.html b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.html deleted file mode 100644 index c864af8319..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.html +++ /dev/null @@ -1,7 +0,0 @@ - - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.jsx b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.jsx deleted file mode 100644 index abc87eaa72..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/optional-field-with-placeholder.jsx +++ /dev/null @@ -1,7 +0,0 @@ - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/read-only-display.jsx b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/read-only-display.jsx deleted file mode 100644 index ce66f271dd..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/read-only-display.jsx +++ /dev/null @@ -1,7 +0,0 @@ - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/validation-example.jsx b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/validation-example.jsx deleted file mode 100644 index 7a7f43178d..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/validation-example.jsx +++ /dev/null @@ -1,21 +0,0 @@ -const [email, setEmail] = useState('invalid-email'); -const [error, setError] = useState('Please enter a valid email address'); - -return ( - - - - { - setEmail(e.currentTarget.value); - setError(/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(e.currentTarget.value) ? '' : 'Please enter a valid email address'); - }} - /> - - -) \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/with-error-and-help-text.jsx b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/with-error-and-help-text.jsx deleted file mode 100644 index 37fd87249d..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/with-error-and-help-text.jsx +++ /dev/null @@ -1,8 +0,0 @@ - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/with-length-constraints.jsx b/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/with-length-constraints.jsx deleted file mode 100644 index 3137d4d750..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/EmailField/examples/with-length-constraints.jsx +++ /dev/null @@ -1,8 +0,0 @@ - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Form.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Form.d.ts index b05e4eaf15..6eea6ca729 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Form.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Form.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -8,22 +8,43 @@ import type { ExtendableEvent, FormProps$1, - PreactCustomElement, - RenderImpl, + ComponentChildren, } from './shared.d.ts'; +/** + * A callback event with a strongly-typed `currentTarget` property that corresponds to a specific HTML element. This provides better type safety when handling events from custom elements. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event listener is attached to, strongly typed based on the element's tag name. + */ currentTarget: HTMLElementTagNameMap[T]; }; + +/** + * An event listener function type for callback events with a strongly-typed `currentTarget`. This ensures the event handler receives the correct element type. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; + +/** + * A callback event that includes the `waitUntil` method for extending asynchronous operations. This allows you to delay form submission until promises resolve, enabling async validation or data processing before the form completes its action. + * @publicDocs + */ export interface CallbackExtendableEvent< TTagName extends keyof HTMLElementTagNameMap, > extends CallbackEvent, Pick {} + +/** + * An event listener function type for extendable callback events. This combines strong typing with the ability to extend the event lifecycle using `waitUntil`. + * @publicDocs + */ export type CallbackExtendableEventListener< TTagName extends keyof HTMLElementTagNameMap, > = @@ -32,32 +53,136 @@ export type CallbackExtendableEventListener< }) | null; +/** + * The properties for the form component. These properties configure the form's identifier for targeting and referencing within the admin extension. + * @publicDocs + */ export interface FormProps extends Pick {} declare const tagName = 's-form'; + +/** + * The JSX props for the form component. These properties extend `FormProps` with event callbacks for form submission and reset actions in JSX rendering. + * @publicDocs + */ export interface FormJSXProps extends Partial { /** - * A callback that is run when the form is submitted. + * A callback that's invoked when the form is submitted. Use the event's `waitUntil` method to perform async operations like validation or data processing before the submission completes. */ onSubmit?: ((event: CallbackExtendableEvent) => void) | null; /** - * A callback that is run when the form is reset. + * A callback that's invoked when the form is reset, restoring all form fields to their initial values. */ onReset?: ((event: CallbackEvent) => void) | null; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * The CSS styles as a string, used for styling web components within their shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The render function that returns Preact/JSX elements to display in the component's shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The optional CSS styles to inject into the component's shadow DOM. + */ + styles?: Styles; +}; +/** + * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the activation event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the activation event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the activation event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the activation event. `0` for primary button (left click), `1` for auxiliary button (middle click), `2` for secondary button (right click). + */ + button: number; +} +/** + * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs. + * @publicDocs + */ +export interface ClickOptions { + /** + * The activation event (such as a click or keyboard event) whose modifier key state and button information should influence the synthetic click behavior. For example, passing an event with `metaKey: true` will cause links to open in a new tab. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } -declare class Form extends PolarisCustomElement implements FormProps { +/** + * The form custom element class that renders a form container in the Shopify admin interface. This component manages form submission, validation, and reset behavior for collecting merchant input. + */ +declare class Form extends PreactCustomElement implements FormProps { constructor(); + /** - * A callback that is run when the form is submitted. + * A callback that's invoked when the form is submitted. Use the event's `waitUntil` method to perform async operations like validation, data processing, or API calls before the submission completes. */ accessor onsubmit: CallbackExtendableEventListener | null; + /** - * A callback that is run when the form is reset. + * A callback that's invoked when the form is reset, restoring all form fields to their initial values. */ accessor onreset: CallbackEventListener | null; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Form/Form.ext.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Form/Form.ext.doc.ts deleted file mode 100644 index 63c93a411b..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Form/Form.ext.doc.ts +++ /dev/null @@ -1,30 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; -import shared from '../../../../docs/shared/components/Form'; - -const data: ReferenceEntityTemplateSchema = { - ...shared, - category: 'Polaris web components', - thumbnail: '/assets/templated-apis-screenshots/admin/components/form.png', - isVisualComponent: true, - definitions: [ - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'FormEvents', - }, - ], - defaultExample: { - codeblock: { - title: '', - tabs: [ - { - code: '../../../../../docs/surfaces/admin/staticPages/examples/form-default-value.jsx', - language: 'preview-jsx', - }, - ], - }, - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Form/examples/default.html b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/default.html index 94a7b5beed..57a6200811 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Form/examples/default.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/default.html @@ -1,4 +1,4 @@ - Submit + Submit diff --git a/packages/ui-extensions/src/surfaces/admin/components/Form/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/default.jsx deleted file mode 100644 index 6e21098b84..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Form/examples/default.jsx +++ /dev/null @@ -1,6 +0,0 @@ - - - - Submit - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-choice-fields.html b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-choice-fields.html new file mode 100644 index 0000000000..7e51a08f81 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-choice-fields.html @@ -0,0 +1,12 @@ + + + + + Percentage + Fixed amount + Free shipping + + + Create discount + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-multiple-fields.html b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-multiple-fields.html new file mode 100644 index 0000000000..f8566b6f6e --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-multiple-fields.html @@ -0,0 +1,12 @@ + + + + + + + + Create campaign + Reset + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-sections.html b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-sections.html new file mode 100644 index 0000000000..ac9868d3a2 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-sections.html @@ -0,0 +1,21 @@ + + + + + + + + + + + + Standard (5–7 days) + Express (2–3 days) + Overnight + + + + + Save preferences + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-validation.html b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-validation.html new file mode 100644 index 0000000000..5d54ec52ac --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/Form/examples/with-validation.html @@ -0,0 +1,7 @@ + + + + + Create product + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/FormExtensionComponents.ts b/packages/ui-extensions/src/surfaces/admin/components/FormExtensionComponents.ts index 6850eca740..18d927c851 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/FormExtensionComponents.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/FormExtensionComponents.ts @@ -1,5 +1,8 @@ import {StandardComponents} from './StandardComponents'; +/** + * The components available for building form-based extensions. Includes all standard components plus the form component for creating structured data collection interfaces with submission handling and validation. + */ export type FormExtensionComponents = StandardComponents | 'Form'; export default FormExtensionComponents; diff --git a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings.d.ts b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings.d.ts index e8a910fc69..e482de9ee3 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -8,17 +8,34 @@ import type { FunctionSettingsProps$1, ExtendableEvent, - PreactCustomElement, + ComponentChildren, } from './shared.d.ts'; +/** + * A callback event with a strongly-typed `currentTarget` property that corresponds to a specific HTML element. This provides better type safety when handling events from custom elements. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event listener is attached to, strongly typed based on the element's tag name. + */ currentTarget: HTMLElementTagNameMap[T]; }; + +/** + * An event listener function type for callback events with a strongly-typed `currentTarget`. This ensures the event handler receives the correct element type. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; + +/** + * An event listener function type for error events that includes an `error` property. This is used for handling validation errors and submission failures in forms. + * @publicDocs + */ export type CallbackErrorEventListener< TTagName extends keyof HTMLElementTagNameMap, TError extends Error = Error, @@ -26,15 +43,28 @@ export type CallbackErrorEventListener< | (EventListener & { ( event: CallbackEvent & { + /** + * The error that occurred during the operation. + */ error: TError; }, ): void; }) | null; + +/** + * A callback event that includes the `waitUntil` method for extending asynchronous operations. This allows you to delay event completion until promises resolve, enabling async operations during event handling. + * @publicDocs + */ export interface CallbackExtendableEvent< TTagName extends keyof HTMLElementTagNameMap, > extends CallbackEvent, Pick {} + +/** + * An event listener function type for extendable callback events. This combines strong typing with the ability to extend the event lifecycle using `waitUntil`. + * @publicDocs + */ export type CallbackExtendableEventListener< TTagName extends keyof HTMLElementTagNameMap, > = @@ -43,16 +73,25 @@ export type CallbackExtendableEventListener< }) | null; +/** + * The properties for the function settings component. These properties configure the form's identifier for configuring Shopify Function settings in the admin interface. + * @publicDocs + */ export interface FunctionSettingsProps extends Pick {} declare const tagName = 's-function-settings'; + +/** + * The JSX props for the function settings component. These properties extend `FunctionSettingsProps` with event callbacks for form submission, reset, and error handling in JSX rendering. + * @publicDocs + */ export interface FunctionSettingsJSXProps extends Partial< FunctionSettingsProps & Pick > { /** - * An optional callback function that will be run by the admin when the user + * An optional callback function that'll be run by the admin when the user * commits their changes in the admin-rendered part of the function settings * experience. If `event.waitUntil` is called with a promise, the admin will wait for the * promise to resolve before committing any changes to Shopify’s servers. If @@ -61,21 +100,123 @@ export interface FunctionSettingsJSXProps */ onSubmit?: ((event: CallbackExtendableEvent) => void) | null; /** - * A callback that is run when the function settings form is reset. + * A callback that's invoked when the function settings form is reset, restoring all form fields to their initial values. */ onReset?: ((event: CallbackEvent) => void) | null; } +/** + * The CSS styles as a string, used for styling web components within their shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The render function that returns Preact/JSX elements to display in the component's shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The optional CSS styles to inject into the component's shadow DOM. + */ + styles?: Styles; +}; +/** + * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the activation event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the activation event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the activation event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the activation event. `0` for primary button (left click), `1` for auxiliary button (middle click), `2` for secondary button (right click). + */ + button: number; +} +/** + * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs. + * @publicDocs + */ +export interface ClickOptions { + /** + * The activation event (such as a click or keyboard event) whose modifier key state and button information should influence the synthetic click behavior. For example, passing an event with `metaKey: true` will cause links to open in a new tab. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The error event type that's passed to the `onError` callback of function settings. This event contains validation errors that occurred when committing function settings to Shopify's servers. + * @publicDocs + */ export type FunctionSettingsErrorEvent = Parameters< NonNullable >[0]; + +/** + * The function settings custom element class that renders a specialized form for configuring Shopify Function settings in the admin interface. This component manages function configuration submission, validation, and error handling. + */ declare class FunctionSettings extends PreactCustomElement implements FunctionSettingsProps { constructor(); /** - * An optional callback function that will be run by the admin when the user + * An optional callback function that'll be run by the admin when the user * commits their changes in the admin-rendered part of the function settings * experience. If `event.waitUntil` is called with a promise, the admin will wait for the * promise to resolve before committing any changes to Shopify’s servers. If @@ -83,12 +224,13 @@ declare class FunctionSettings * using the `message` property of the error you reject with. */ accessor onsubmit: CallbackExtendableEventListener | null; + /** - * An optional callback function that will be run by the admin when + * An optional callback function that'll be run by the admin when * committing the changes to Shopify’s servers fails. The error event you receive includes - * an `error` property that is an `AggregateError` object. This object includes + * an `error` property that's an `AggregateError` object. This object includes * an array of errors that were caused by data your extension provided. - * Network errors and user errors that are out of your control will not be reported here. + * Network errors and user errors that are out of your control won't be reported here. * * In the `onError` callback, you should update your extension’s UI to * highlight the fields that caused the errors, and display the error messages @@ -100,7 +242,7 @@ declare class FunctionSettings > | null; /** - * A callback that is run when the function settings form is reset. + * A callback that's invoked when the function settings form is reset, restoring all form fields to their initial values. */ accessor onreset: CallbackEventListener | null; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.ts deleted file mode 100644 index 568200b622..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.ts +++ /dev/null @@ -1,31 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; -import shared from '../../../../docs/shared/components/FunctionSettings'; - -const data: ReferenceEntityTemplateSchema = { - ...shared, - category: 'Polaris web components', - thumbnail: '/assets/templated-apis-screenshots/admin/components/form.png', - isVisualComponent: true, - definitions: [ - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'FormEvents', - }, - ], - defaultExample: { - codeblock: { - title: '', - tabs: [ - { - title: 'JSX', - code: './examples/default.tsx', - language: 'jsx', - }, - ], - }, - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/default.html b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/default.html new file mode 100644 index 0000000000..b28b65b866 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/default.html @@ -0,0 +1,9 @@ + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/default.tsx b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/default.tsx deleted file mode 100644 index a8ab57db74..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/default.tsx +++ /dev/null @@ -1,38 +0,0 @@ -import {render} from 'preact'; -import {useState} from 'preact/hooks'; - -export default async () => { - render(, document.body); -}; - -function Extension() { - const [percentage, setPercentage] = useState( - shopify.data.metafields[0].value, - ); - - async function applyExtensionMetafieldChange() { - await shopify.applyMetafieldChange({ - type: 'updateMetafield', - namespace: '$app:discounts-percentage', - key: 'function-configuration', - value: percentage, - valueType: 'integer', - }); - } - - return ( - e.waitUntil(applyExtensionMetafieldChange())} - onReset={resetForm} - > - setPercentage(event.currentTarget.value)} - /> - - ); -} diff --git a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-multiple-settings.html b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-multiple-settings.html new file mode 100644 index 0000000000..f5ff44d398 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-multiple-settings.html @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-select-options.html b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-select-options.html new file mode 100644 index 0000000000..92d95ae8ee --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-select-options.html @@ -0,0 +1,10 @@ + + + + All products + Specific collection + Products with tag + + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-toggle.html b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-toggle.html new file mode 100644 index 0000000000..0c0942cad4 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-toggle.html @@ -0,0 +1,13 @@ + + + + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-validation.html b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-validation.html new file mode 100644 index 0000000000..ab060201e3 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettings/examples/with-validation.html @@ -0,0 +1,23 @@ + + + + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettingsComponents.ts b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettingsComponents.ts index 835ff43e42..cebb3a9fa9 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/FunctionSettingsComponents.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/FunctionSettingsComponents.ts @@ -1,5 +1,8 @@ import {FormExtensionComponents} from './FormExtensionComponents'; +/** + * The components available for building function settings extensions. Includes all form components plus the function settings component required for function settings configuration. + */ export type FunctionSettingsComponents = | FormExtensionComponents | 'FunctionSettings'; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Grid.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Grid.d.ts index 38730f41c8..30c3d95d3f 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Grid.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Grid.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -17,10 +17,12 @@ import type { JustifyItemsKeyword, AlignContentKeyword, JustifyContentKeyword, - PreactCustomElement, - RenderImpl, } from './shared.d.ts'; +/** + * A type that allows a value to be responsive using container query syntax. + * @publicDocs + */ export type MakeResponsive = T | `@container${string}`; /** * Makes a property's value potentially responsive. @@ -37,12 +39,21 @@ export type MakeResponsive = T | `@container${string}`; * margin: string | `@container${string}`; * padding: number | `@container${string}`; * } + * @publicDocs */ export type MakeResponsivePick = { [P in TProperty]: MakeResponsive; }; +/** + * A version of the box properties with all fields required. + * @publicDocs + */ export type RequiredBoxProps = Required; +/** + * The allowed border radius values for a box component. + * @publicDocs + */ export type BoxBorderRadii = Extract< RequiredBoxProps['borderRadius'], | 'none' @@ -54,10 +65,18 @@ export type BoxBorderRadii = Extract< | 'large-100' | 'large-200' >; +/** + * The allowed border style values for a box component. + * @publicDocs + */ export type BoxBorderStyles = Extract< RequiredBoxProps['borderStyle'], 'none' | 'solid' | 'dashed' | 'auto' >; +/** + * The box properties that support responsive values through container queries. + * @publicDocs + */ export type ResponsiveBoxProps = MakeResponsivePick< RequiredBoxProps, | 'padding' @@ -90,7 +109,7 @@ export interface BoxProps | 'overflow' > { /** - * Adjust the background of the component. + * The background color of the grid container. * * @default 'transparent' */ @@ -99,7 +118,10 @@ export interface BoxProps 'transparent' | 'base' | 'subdued' | 'strong' >; /** - * Adjust the width of the border. + * Controls the thickness of the border on all sides. + * + * When set, this overrides the width value specified in the `border` property. + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side. * * @default '' - meaning no override */ @@ -112,7 +134,10 @@ export interface BoxProps > | Extract; /** - * Adjust the style of the border. + * Controls the visual style of the border on all sides (solid, dashed, auto, or none). + * + * When set, this overrides the style value specified in the `border` property. + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side. * * @default '' - meaning no override */ @@ -120,7 +145,10 @@ export interface BoxProps | MaybeAllValuesShorthandProperty | Extract; /** - * Adjust the color of the border. + * Controls the color of the border using the design system's color scale. + * + * When set, this overrides the color value specified in the `border` property. + * Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed. * * @default '' - meaning no override */ @@ -129,13 +157,15 @@ export interface BoxProps 'subdued' | 'base' | 'strong' | '' >; /** - * Adjust the radius of the border. + * Controls the roundedness of the element's corners using the design system's radius scale. + * + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different radii per corner. Use this to create rounded corners or fully rounded elements. * * @default 'none' */ borderRadius: MaybeAllValuesShorthandProperty; /** - * Adjust the padding of all edges. + * The padding applied to all edges of the grid container. * * [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: * @@ -151,71 +181,71 @@ export interface BoxProps * * 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. + * `padding` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default 'none' */ padding: ResponsiveBoxProps['padding']; /** - * Adjust the block-padding. + * The padding applied to the block axis (top and bottom in horizontal writing modes). * * - `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. + * `paddingBlock` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlock: ResponsiveBoxProps['paddingBlock']; /** - * Adjust the block-start padding. + * The padding applied to the block-start edge (top in horizontal writing modes). * * 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. + * `paddingBlockStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlockStart: ResponsiveBoxProps['paddingBlockStart']; /** - * Adjust the block-end padding. + * The padding applied to the block-end edge (bottom in horizontal writing modes). * * 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. + * `paddingBlockEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlockEnd: ResponsiveBoxProps['paddingBlockEnd']; /** - * Adjust the inline padding. + * The padding applied to the inline axis (left and right in horizontal writing modes). * * - `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. + * `paddingInline` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingInline: ResponsiveBoxProps['paddingInline']; /** - * Adjust the inline-start padding. + * The padding applied to the inline-start edge (left in left-to-right languages). * * 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. + * `paddingInlineStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingInlineStart: ResponsiveBoxProps['paddingInlineStart']; /** - * Adjust the inline-end padding. + * The padding applied to the inline-end edge (right in left-to-right languages). * * 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. + * `paddingInlineEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ @@ -230,48 +260,65 @@ export interface BoxProps */ display: ResponsiveBoxProps['display']; /** - * Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). + * The vertical size of the grid in standard layouts (height in left-to-right or right-to-left writing modes). + * + * Block size adjusts based on the writing direction: in horizontal layouts, it controls the height; + * in vertical layouts, it controls the width. This ensures consistent behavior across different text directions. + * + * Learn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). * * @default 'auto' */ blockSize: SizeUnitsOrAuto; /** - * Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size). + * The [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size) (minimum height in horizontal writing modes) of the grid container. * * @default '0' */ minBlockSize: SizeUnits; /** - * Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size). + * The [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size) (maximum height in horizontal writing modes) of the grid container. * * @default 'none' */ maxBlockSize: SizeUnitsOrNone; /** - * Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size). + * The [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size) (width in horizontal writing modes) of the grid container. * * @default 'auto' */ inlineSize: SizeUnitsOrAuto; /** - * Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size). + * The [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size) (minimum width in horizontal writing modes) of the grid container. * * @default '0' */ minInlineSize: SizeUnits; /** - * Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size). + * The [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size) (maximum width in horizontal writing modes) of the grid container. * * @default 'none' */ maxInlineSize: SizeUnitsOrNone; } +/** + * A version of the grid properties with all fields required. + * @publicDocs + */ export type RequiredAlignedProps = Required; +/** + * The grid properties that support responsive values through container queries. + * @publicDocs + */ export type ResponsiveGridProps = MakeResponsivePick< RequiredAlignedProps, 'rowGap' | 'columnGap' | 'gap' | 'gridTemplateColumns' | 'gridTemplateRows' >; +/** + * The properties for the grid component. A grid provides precise control over rows and columns, with powerful alignment and sizing options for both individual items and the entire grid structure. + * @publicDocs + */ export interface GridProps extends BoxProps, Required< @@ -286,41 +333,37 @@ export interface GridProps > > { /** - * Aligns the grid items along the block axis. + * The alignment of grid items along the block axis (vertical in horizontal writing modes). You can choose values like `'start'`, `'center'`, `'end'`, or `'stretch'` to control how items are positioned within their grid areas. * * @default '' - meaning no override */ alignItems: AlignItemsKeyword | ''; /** - * Aligns the grid items along the inline axis. + * The alignment of grid items along the inline axis (horizontal in left-to-right languages). You can choose values like `'start'`, `'center'`, or `'end'` to control how items are positioned within their grid areas. * * @default '' - meaning no override */ justifyItems: JustifyItemsKeyword | ''; /** - * A shorthand property for `justify-items` and `align-items`. + * A shorthand property for setting both `justifyItems` and `alignItems` at once. You can provide either a single value (which applies to both axes) or two values separated by a space (the first for `alignItems`, the second for `justifyItems`). * * @default 'normal normal' */ placeItems: `${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword; /** - * Aligns the grid along the block axis. - * - * This overrides the block value of `placeContent`. + * The alignment of the entire grid along the block axis when there's extra space in the grid container. This property overrides the block-axis value set by the `placeContent` property. * * @default '' - meaning no override */ alignContent: AlignContentKeyword | ''; /** - * Aligns the grid along the inline axis. - * - * This overrides the inline value of `placeContent`. + * The alignment of the entire grid along the inline axis when there's extra space in the grid container. This property overrides the inline-axis value set by the `placeContent` property. * * @default '' - meaning no override */ justifyContent: JustifyContentKeyword | ''; /** - * A shorthand property for `justify-content` and `align-content`. + * A shorthand property for setting both `justifyContent` and `alignContent` at once. You can provide either a single value (which applies to both axes) or two values separated by a space (the first for `alignContent`, the second for `justifyContent`). * * @default 'normal normal' */ @@ -328,117 +371,320 @@ export interface GridProps | `${AlignContentKeyword} ${JustifyContentKeyword}` | AlignContentKeyword; /** - * 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. + * The spacing between grid rows and columns. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value to apply the same spacing to both axes (for example, `'large-100'`), or a pair of values (for example, `'large-100 large-500'`) to set different spacing for rows and columns. This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax. * * @default 'none' */ gap: ResponsiveGridProps['gap']; /** - * 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. + * The spacing between grid rows. This property overrides the row spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax. * * @default '' - meaning no override */ rowGap: ResponsiveGridProps['rowGap']; /** - * 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. + * The spacing between grid columns. This property overrides the column spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax. * * @default '' - meaning no override */ columnGap: ResponsiveGridProps['columnGap']; /** - * 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. + * The number of columns and their sizes. You can use [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) (for example, `'1fr auto'` or `'repeat(3, 1fr)'`) to define the grid structure. This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax. * * @default 'none' */ gridTemplateColumns: ResponsiveGridProps['gridTemplateColumns']; /** - * 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. + * The number of rows and their sizes. You can use [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) (for example, `'1fr auto'` or `'repeat(3, 100px)'`) to define the grid structure. This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax. * * @default 'none' */ gridTemplateRows: ResponsiveGridProps['gridTemplateRows']; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles for a custom element. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with Preact. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The optional CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * An interface representing the properties of an activation event, such as a click or keypress. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta key (Command on Mac, Windows key on PC) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; } +/** + * The options for triggering a synthetic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * The base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +/** + * An abstract base class for creating custom elements that render with Preact. + */ +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -declare class BoxElement extends PolarisCustomElement implements BoxProps { + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base element class for Box components with all Box properties as accessors. + */ +declare class BoxElement extends PreactCustomElement implements BoxProps { constructor(renderImpl: RenderImpl); + /** + * The ARIA role that defines the semantic meaning of the grid for assistive technologies. + */ accessor accessibilityRole: BoxProps['accessibilityRole']; + /** + * The background color of the grid using the design system's color scale. Choose from `transparent`, `subdued`, `base`, or `strong`. + */ accessor background: BoxProps['background']; + /** + * The height of the grid in horizontal writing modes, or width in vertical writing modes. + * Use this for flow-relative sizing that adapts to text direction. + */ accessor blockSize: BoxProps['blockSize']; + /** + * The minimum height of the grid in horizontal writing modes, or minimum width in vertical writing modes. + * Prevents the grid from shrinking below this size. + */ accessor minBlockSize: BoxProps['minBlockSize']; + /** + * The maximum height of the grid in horizontal writing modes, or maximum width in vertical writing modes. + * Prevents the grid from growing beyond this size. + */ accessor maxBlockSize: BoxProps['maxBlockSize']; + /** + * The width of the grid in horizontal writing modes, or height in vertical writing modes. + * Use this for flow-relative sizing that adapts to text direction. + */ accessor inlineSize: BoxProps['inlineSize']; + /** + * The minimum width of the grid in horizontal writing modes, or minimum height in vertical writing modes. + * Prevents the grid from shrinking below this size. + */ accessor minInlineSize: BoxProps['minInlineSize']; + /** + * The maximum width of the grid in horizontal writing modes, or maximum height in vertical writing modes. + * Prevents the grid from growing beyond this size. + */ accessor maxInlineSize: BoxProps['maxInlineSize']; + /** + * Controls how content that exceeds the grid's boundaries is displayed. Use `hidden` to clip overflow or `visible` to allow content to extend beyond boundaries. + */ accessor overflow: BoxProps['overflow']; + /** + * The padding on all sides of the grid. + */ accessor padding: BoxProps['padding']; + /** + * The vertical padding (top and bottom) in horizontal writing modes. + * Use this for flow-relative padding that adapts to text direction. + */ accessor paddingBlock: BoxProps['paddingBlock']; + /** + * The padding at the top in horizontal writing modes, or at the start edge in vertical writing modes. + */ accessor paddingBlockStart: BoxProps['paddingBlockStart']; + /** + * The padding at the bottom in horizontal writing modes, or at the end edge in vertical writing modes. + */ accessor paddingBlockEnd: BoxProps['paddingBlockEnd']; + /** + * The horizontal padding (left and right) in horizontal writing modes. + * Use this for flow-relative padding that adapts to text direction. + */ accessor paddingInline: BoxProps['paddingInline']; + /** + * The padding at the left in left-to-right languages, or at the right in right-to-left languages. + */ accessor paddingInlineStart: BoxProps['paddingInlineStart']; + /** + * The padding at the right in left-to-right languages, or at the left in right-to-left languages. + */ accessor paddingInlineEnd: BoxProps['paddingInlineEnd']; + /** + * Applies a border using shorthand syntax to specify width, color, and style in a single property. + */ accessor border: BoxProps['border']; + /** + * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property. + */ accessor borderWidth: BoxProps['borderWidth']; + /** + * Controls the visual style of the border on all sides (solid, dashed, auto, or none). When set, this overrides the style value specified in the `border` property. + */ accessor borderStyle: BoxProps['borderStyle']; + /** + * Controls the color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property. + */ accessor borderColor: BoxProps['borderColor']; + /** + * Controls the roundedness of the element's corners using the design system's radius scale. + */ accessor borderRadius: BoxProps['borderRadius']; + /** + * A text description of the grid for screen readers, used when the visual context isn't sufficient for understanding. + */ accessor accessibilityLabel: BoxProps['accessibilityLabel']; + /** + * Controls the visibility of the grid for both visual and assistive technology users. Use `hidden` to hide from screen readers or `exclusive` to hide visually but announce to screen readers. + */ accessor accessibilityVisibility: BoxProps['accessibilityVisibility']; + /** + * Controls how the grid is displayed in the layout, such as block, inline, or none. + */ accessor display: BoxProps['display']; } +/** + * A grid is a layout component that arranges its children in rows and columns with precise control over sizing and alignment. + */ declare class Grid extends BoxElement implements GridProps { constructor(); + /** + * The template that defines the grid columns. + */ accessor gridTemplateColumns: GridProps['gridTemplateColumns']; + /** + * The template that defines the grid rows. + */ accessor gridTemplateRows: GridProps['gridTemplateRows']; + /** + * The alignment of grid items along the inline axis. + */ accessor justifyItems: GridProps['justifyItems']; + /** + * The alignment of grid items along the block axis. + */ accessor alignItems: GridProps['alignItems']; + /** + * A shorthand for setting both `alignItems` and `justifyItems`. + */ accessor placeItems: GridProps['placeItems']; + /** + * The alignment of the grid along the inline axis. + */ accessor justifyContent: GridProps['justifyContent']; + /** + * The alignment of the grid along the block axis. + */ accessor alignContent: GridProps['alignContent']; + /** + * A shorthand for setting both `alignContent` and `justifyContent`. + */ accessor placeContent: GridProps['placeContent']; + /** + * The spacing between grid rows and columns. + */ accessor gap: GridProps['gap']; + /** + * The spacing between grid rows. + */ accessor rowGap: GridProps['rowGap']; + /** + * The spacing between grid columns. + */ accessor columnGap: GridProps['columnGap']; } declare global { @@ -455,11 +701,15 @@ declare module 'preact' { } declare const tagName = 's-grid'; +/** + * The properties for the grid component when it's used in JSX. + * @publicDocs + */ export interface GridJSXProps extends Partial, Pick { /** - * The content of the Grid. + * The child elements to render inside the grid. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Grid/Grid.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Grid/Grid.doc.ts deleted file mode 100644 index 864596c367..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Grid/Grid.doc.ts +++ /dev/null @@ -1,140 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Grid'; -import gridItemSharedContent from '../../../../docs/shared/components/GridItem'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - subSections: [ - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Always configure layout properties when using Grid. At minimum, set gridTemplateColumns to define your column structure (e.g., repeat(12, 1fr) for a 12-column grid) -- Use gap to add spacing between grid items rather than adding margins to individual items -- Combine gridTemplateColumns with gridColumn on GridItem components to control how items span across columns`, - }, - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Building form layouts where you want more than one field on the same row. -- Organizing content into a grid-like layout with columns and rows with consistent alignment and spacing. -- Creating responsive layouts with consistent spacing.`, - }, - { - title: 'Considerations', - type: 'Generic' as const, - anchorLink: 'considerations', - sectionContent: `- Grid doesn't include any padding by default. If you need padding around your grid, use \`base\` to apply the default padding. -- Grid will allow children to overflow unless template rows/columns are properly set. -- Grid will always wrap children to a new line. If you need to control the wrapping behavior, use \`s-stack\` or \`s-box\`.`, - }, - ], - thumbnail: '/assets/templated-apis-screenshots/admin/components/grid.png', - isVisualComponent: true, - definitions: [ - { - title: 'Properties', - description: '', - type: 'Grid', - }, - { - title: 'Slots', - description: '', - type: 'GridSlots', - }, - { - title: gridItemSharedContent.name, - description: gridItemSharedContent.description, - type: 'GridItem', - }, - { - title: 'Slots', - description: '', - type: 'GridItemSlots', - }, - ], - defaultExample: { - image: 'grid-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Simple 12-column grid system with equal-width left and right columns.', - codeblock: { - title: 'Basic two-column layout', - tabs: [ - { - code: './examples/basic-two-column-layout.html', - language: 'html', - }, - - { - code: './examples/basic-two-column-layout.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Grid layout with full-width, half-width, and third-width column arrangements.', - codeblock: { - title: 'Layout with spans', - tabs: [ - { - code: './examples/col-span-layouts.html', - language: 'html', - }, - - { - code: './examples/col-span-layouts.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Adaptive grid that automatically adjusts column count based on screen size.', - codeblock: { - title: 'Responsive grid', - tabs: [ - { - code: './examples/mobile-first-responsive-grid.html', - language: 'html', - }, - - { - code: './examples/mobile-first-responsive-grid.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/basic-two-column-layout.jsx b/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/basic-two-column-layout.jsx deleted file mode 100644 index f040a51736..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/basic-two-column-layout.jsx +++ /dev/null @@ -1,12 +0,0 @@ - - - - Left column - - - - - Right column - - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/col-span-layouts.jsx b/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/col-span-layouts.jsx deleted file mode 100644 index 49604fbe5a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/col-span-layouts.jsx +++ /dev/null @@ -1,34 +0,0 @@ - - - - - Full width field - - - - - Half width field - - - - - Half width field - - - - - Third width field - - - - - Third width field - - - - - Third width field - - - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/default.jsx deleted file mode 100644 index e451f56379..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/default.jsx +++ /dev/null @@ -1,15 +0,0 @@ - - - Summary of sales - - - Orders - - - Customers - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/mobile-first-responsive-grid.jsx b/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/mobile-first-responsive-grid.jsx deleted file mode 100644 index 6cc5f0e25a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Grid/examples/mobile-first-responsive-grid.jsx +++ /dev/null @@ -1,53 +0,0 @@ - - Narrow container (375px) - - - - - - Item 1 - - - - - Item 2 - - - - - Item 3 - - - - - - - Wide container (450px) - - - - - - Item 1 - - - - - Item 2 - - - - - Item 3 - - - - - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/GridItem.d.ts b/packages/ui-extensions/src/surfaces/admin/components/GridItem.d.ts index 8d885905d2..935472b66c 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/GridItem.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/GridItem.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -14,10 +14,12 @@ import type { SizeUnitsOrAuto, SizeUnits, SizeUnitsOrNone, - PreactCustomElement, - RenderImpl, } from './shared.d.ts'; +/** + * A type that allows a value to be responsive using container query syntax. + * @publicDocs + */ export type MakeResponsive = T | `@container${string}`; /** * Makes a property's value potentially responsive. @@ -34,12 +36,21 @@ export type MakeResponsive = T | `@container${string}`; * margin: string | `@container${string}`; * padding: number | `@container${string}`; * } + * @publicDocs */ export type MakeResponsivePick = { [P in TProperty]: MakeResponsive; }; +/** + * A version of the box properties with all fields required. + * @publicDocs + */ export type RequiredBoxProps = Required; +/** + * The allowed border radius values for a box component. + * @publicDocs + */ export type BoxBorderRadii = Extract< RequiredBoxProps['borderRadius'], | 'none' @@ -51,10 +62,18 @@ export type BoxBorderRadii = Extract< | 'large-100' | 'large-200' >; +/** + * The allowed border style values for a box component. + * @publicDocs + */ export type BoxBorderStyles = Extract< RequiredBoxProps['borderStyle'], 'none' | 'solid' | 'dashed' | 'auto' >; +/** + * The box properties that support responsive values through container queries. + * @publicDocs + */ export type ResponsiveBoxProps = MakeResponsivePick< RequiredBoxProps, | 'padding' @@ -87,7 +106,7 @@ export interface BoxProps | 'overflow' > { /** - * Adjust the background of the component. + * The background color of the grid item. * * @default 'transparent' */ @@ -96,7 +115,16 @@ export interface BoxProps 'transparent' | 'base' | 'subdued' | 'strong' >; /** - * Adjust the width of the border. + * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property. + * + * - `small`: Thin border for subtle definition. + * - `small-100`: Extra thin border for minimal emphasis. + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `none`: No border. + * + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side. * * @default '' - meaning no override */ @@ -109,7 +137,7 @@ export interface BoxProps > | Extract; /** - * Adjust the style of the border. + * The visual style of the border (solid, dashed, auto, or none). * * @default '' - meaning no override */ @@ -117,7 +145,7 @@ export interface BoxProps | MaybeAllValuesShorthandProperty | Extract; /** - * Adjust the color of the border. + * The color of the border using the design system's color scale. * * @default '' - meaning no override */ @@ -126,13 +154,13 @@ export interface BoxProps 'subdued' | 'base' | 'strong' | '' >; /** - * Adjust the radius of the border. + * The roundedness of the corners using the design system's radius scale. * * @default 'none' */ borderRadius: MaybeAllValuesShorthandProperty; /** - * Adjust the padding of all edges. + * The padding applied to all edges of the grid item. * * [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: * @@ -148,71 +176,71 @@ export interface BoxProps * * 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. + * `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default 'none' */ padding: ResponsiveBoxProps['padding']; /** - * Adjust the block-padding. + * The padding applied to the block axis (top and bottom in horizontal writing modes). * * - `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. + * `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlock: ResponsiveBoxProps['paddingBlock']; /** - * Adjust the block-start padding. + * The padding applied to the block-start edge (top in horizontal writing modes). * * 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. + * `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlockStart: ResponsiveBoxProps['paddingBlockStart']; /** - * Adjust the block-end padding. + * The padding applied to the block-end edge (bottom in horizontal writing modes). * * 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. + * `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlockEnd: ResponsiveBoxProps['paddingBlockEnd']; /** - * Adjust the inline padding. + * The padding applied to the inline axis (left and right in horizontal writing modes). * * - `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. + * `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingInline: ResponsiveBoxProps['paddingInline']; /** - * Adjust the inline-start padding. + * The padding applied to the inline-start edge (left in left-to-right languages). * * 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. + * `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingInlineStart: ResponsiveBoxProps['paddingInlineStart']; /** - * Adjust the inline-end padding. + * The padding applied to the inline-end edge (right in left-to-right languages). * * 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. + * `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ @@ -227,100 +255,316 @@ export interface BoxProps */ display: ResponsiveBoxProps['display']; /** - * Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). + * The vertical size of the grid item in standard layouts (height in left-to-right or right-to-left writing modes). + * + * Block size adjusts based on the writing direction: in horizontal layouts, it controls the height; + * in vertical layouts, it controls the width. This ensures consistent behavior across different text directions. + * + * Learn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). * * @default 'auto' */ blockSize: SizeUnitsOrAuto; /** - * Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size). + * The [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size) (minimum height in horizontal writing modes) of the grid item. * * @default '0' */ minBlockSize: SizeUnits; /** - * Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size). + * The [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size) (maximum height in horizontal writing modes) of the grid item. * * @default 'none' */ maxBlockSize: SizeUnitsOrNone; /** - * Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size). + * The [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size) (width in horizontal writing modes) of the grid item. * * @default 'auto' */ inlineSize: SizeUnitsOrAuto; /** - * Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size). + * The [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size) (minimum width in horizontal writing modes) of the grid item. * * @default '0' */ minInlineSize: SizeUnits; /** - * Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size). + * The [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size) (maximum width in horizontal writing modes) of the grid item. * * @default 'none' */ maxInlineSize: SizeUnitsOrNone; } +/** + * A version of the grid item properties with all fields required. + * @publicDocs + */ export type RequiredGridItemProps = Required; +/** + * The properties for the grid item component. A grid item can be positioned within specific rows and columns of a grid, with control over how many rows or columns it spans. + * @publicDocs + */ export interface GridItemProps extends BoxProps, Required> { + /** + * The column position and span of the grid item. You can specify a starting column number, an ending column number, or both (for example, `'1 / 3'` starts at column 1 and ends before column 3, spanning 2 columns). You can also use `'span 2'` to make the item span 2 columns. + */ gridColumn: RequiredGridItemProps['gridColumn']; + /** + * The row position and span of the grid item. You can specify a starting row number, an ending row number, or both (for example, `'1 / 3'` starts at row 1 and ends before row 3, spanning 2 rows). You can also use `'span 2'` to make the item span 2 rows. + */ gridRow: RequiredGridItemProps['gridRow']; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles for a custom element. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with Preact. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The optional CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * An interface representing the properties of an activation event, such as a click or keypress. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta key (Command on Mac, Windows key on PC) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * The options for triggering a synthetic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; } +/** + * The base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +/** + * An abstract base class for creating custom elements that render with Preact. + */ +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -declare class BoxElement extends PolarisCustomElement implements BoxProps { + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base element class for Box components with all Box properties as accessors. + */ +declare class BoxElement extends PreactCustomElement implements BoxProps { constructor(renderImpl: RenderImpl); + /** + * The ARIA role that defines the semantic meaning of the grid item for assistive technologies. + */ accessor accessibilityRole: BoxProps['accessibilityRole']; + /** + * The background color of the grid item using the design system's color scale. Choose from `transparent`, `subdued`, `base`, or `strong`. + */ accessor background: BoxProps['background']; + /** + * The height of the grid item in horizontal writing modes, or width in vertical writing modes. + * Use this for flow-relative sizing that adapts to text direction. + */ accessor blockSize: BoxProps['blockSize']; + /** + * The minimum height of the grid item in horizontal writing modes, or minimum width in vertical writing modes. + * Prevents the grid item from shrinking below this size. + */ accessor minBlockSize: BoxProps['minBlockSize']; + /** + * The maximum height of the grid item in horizontal writing modes, or maximum width in vertical writing modes. + * Prevents the grid item from growing beyond this size. + */ accessor maxBlockSize: BoxProps['maxBlockSize']; + /** + * The width of the grid item in horizontal writing modes, or height in vertical writing modes. + * Use this for flow-relative sizing that adapts to text direction. + */ accessor inlineSize: BoxProps['inlineSize']; + /** + * The minimum width of the grid item in horizontal writing modes, or minimum height in vertical writing modes. + * Prevents the grid item from shrinking below this size. + */ accessor minInlineSize: BoxProps['minInlineSize']; + /** + * The maximum width of the grid item in horizontal writing modes, or maximum height in vertical writing modes. + * Prevents the grid item from growing beyond this size. + */ accessor maxInlineSize: BoxProps['maxInlineSize']; + /** + * Controls how content that exceeds the grid item's boundaries is displayed. Use `hidden` to clip overflow or `visible` to allow content to extend beyond boundaries. + */ accessor overflow: BoxProps['overflow']; + /** + * The spacing applied inside the grid item on all sides, creating distance between the item's edges and its content. + */ accessor padding: BoxProps['padding']; + /** + * The vertical padding (top and bottom) in horizontal writing modes. + * Use this for flow-relative padding that adapts to text direction. + */ accessor paddingBlock: BoxProps['paddingBlock']; + /** + * The padding at the top in horizontal writing modes, or at the start edge in vertical writing modes. + */ accessor paddingBlockStart: BoxProps['paddingBlockStart']; + /** + * The padding at the bottom in horizontal writing modes, or at the end edge in vertical writing modes. + */ accessor paddingBlockEnd: BoxProps['paddingBlockEnd']; + /** + * The horizontal padding (left and right) in horizontal writing modes. + * Use this for flow-relative padding that adapts to text direction. + */ accessor paddingInline: BoxProps['paddingInline']; + /** + * The padding at the left in left-to-right languages, or at the right in right-to-left languages. + */ accessor paddingInlineStart: BoxProps['paddingInlineStart']; + /** + * The padding at the right in left-to-right languages, or at the left in right-to-left languages. + */ accessor paddingInlineEnd: BoxProps['paddingInlineEnd']; + /** + * Applies a border using shorthand syntax to specify width, color, and style in a single property. + */ accessor border: BoxProps['border']; + /** + * The width of the border. + */ accessor borderWidth: BoxProps['borderWidth']; + /** + * The style of the border. + */ accessor borderStyle: BoxProps['borderStyle']; + /** + * The color of the border. + */ accessor borderColor: BoxProps['borderColor']; + /** + * The radius of the border corners. + */ accessor borderRadius: BoxProps['borderRadius']; + /** + * A text description of the grid item for screen readers, used when the visual context isn't sufficient for understanding. + */ accessor accessibilityLabel: BoxProps['accessibilityLabel']; + /** + * Controls the visibility of the grid item for both visual and assistive technology users. Use `hidden` to hide from screen readers or `exclusive` to hide visually but announce to screen readers. + */ accessor accessibilityVisibility: BoxProps['accessibilityVisibility']; + /** + * Controls how the grid item is displayed in the layout, such as block, inline, or none. + */ accessor display: BoxProps['display']; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } +/** + * A grid item is a child of a grid that can be positioned within specific rows and columns. + */ declare class GridItem extends BoxElement implements GridItemProps { + /** + * The column position and span of the grid item. + */ accessor gridColumn: GridItemProps['gridColumn']; + /** + * The row position and span of the grid item. + */ accessor gridRow: GridItemProps['gridRow']; constructor(); } @@ -339,11 +583,15 @@ declare module 'preact' { } declare const tagName = 's-grid-item'; +/** + * The properties for the grid item component when it's used in JSX. + * @publicDocs + */ export interface GridItemJSXProps extends Partial, Pick { /** - * The content of the GridItem. + * The child elements to render inside the grid item. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Heading.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Heading.d.ts index c7a8356bba..f013a2971d 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Heading.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Heading.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,13 +6,12 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - HeadingProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, HeadingProps$1} from './shared.d.ts'; +/** + * The properties for the heading component. These properties define hierarchical section titles and headings with appropriate semantic meaning and visual hierarchy. + * @publicDocs + */ export interface HeadingProps extends Required< Pick< @@ -21,40 +20,144 @@ export interface HeadingProps > > {} -/** Used when an element does not have children. */ +/** + * A string containing CSS styles. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with a shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow DOM content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * Optional CSS styles to apply to the shadow DOM. + */ + styles?: Styles; +}; +/** + * An object that represents the state of modifier keys and mouse button + * during an activation event like a click. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta (Command on Mac, Windows key on PC) key was pressed. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * Options for customizing click behavior on an element. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); -} - -declare abstract class HeadingBase - extends PolarisCustomElement - implements - Pick< - HeadingProps, - 'accessibilityRole' | 'accessibilityVisibility' | 'lineClamp' - > -{ +/** + * A custom element for displaying hierarchical section titles and headings with appropriate semantic meaning and visual styling. Use Heading to structure your content with proper heading levels for both visual hierarchy and accessibility. + */ +declare class Heading extends PreactCustomElement implements HeadingProps { + /** + * The ARIA role for the heading. Set to `'heading'` (the default) for standard heading semantics, or `'presentation'` / `'none'` to remove heading semantics for decorative use. + */ accessor accessibilityRole: HeadingProps['accessibilityRole']; + /** + * The maximum number of lines to display before the text is truncated with an ellipsis. + */ accessor lineClamp: HeadingProps['lineClamp']; + /** + * The visibility of the element to assistive technologies. + */ accessor accessibilityVisibility: HeadingProps['accessibilityVisibility']; - constructor(renderImpl: RenderImpl); -} - -declare class Heading extends HeadingBase implements HeadingProps { constructor(); } declare global { @@ -71,11 +174,15 @@ declare module 'preact' { } declare const tagName = 's-heading'; +/** + * The JSX properties for the heading component. These properties define how a heading is rendered in Preact or JSX. + * @publicDocs + */ export interface HeadingJSXProps extends Partial, Pick { /** - * The content of the Heading. + * The content of the heading. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Heading/Heading.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Heading/Heading.doc.ts deleted file mode 100644 index eccd40229c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Heading/Heading.doc.ts +++ /dev/null @@ -1,147 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Heading'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/heading.png', - isVisualComponent: true, - subSections: [ - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Creating titles and subtitles for your content that are consistent across your app. -- Helping users with visual impairments navigate through content effectively using assistive technologies like screen readers.`, - }, - { - title: 'Considerations', - type: 'Generic' as const, - anchorLink: 'considerations', - sectionContent: `- The level of the heading is automatically determined by how deeply it's nested inside other components, starting from h2. -- Default to using the \`heading\` property in \`s-section\`. The \`s-heading\` component should only be used if you need to implement a custom layout for your heading in the UI.`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use short headings to make your content scannable. -- Use plain and clear terms. -- Don't use jargon or technical language. -- Don't use different terms to describe the same thing. -- Don't duplicate content.`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Heading', - }, - { - title: 'Slots', - description: '', - type: 'HeadingSlots', - }, - ], - defaultExample: { - image: 'heading-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Standard heading for section titles and page content organization that creates a simple, clean title for a content section.', - codeblock: { - title: 'Basic heading', - tabs: [ - { - code: './examples/basic-heading.html', - language: 'html', - }, - - { - code: './examples/basic-heading.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Truncated heading that limits text to a specified number of lines, using ellipsis to indicate additional content for long product names or constrained layouts.', - codeblock: { - title: 'Heading with line clamping', - tabs: [ - { - code: './examples/heading-with-line-clamping.html', - language: 'html', - }, - - { - code: './examples/heading-with-line-clamping.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Heading configured with custom ARIA roles and visibility settings to meet specific accessibility requirements or design constraints.', - codeblock: { - title: 'Heading with custom accessibility', - tabs: [ - { - code: './examples/heading-with-custom-accessibility.html', - language: 'html', - }, - - { - code: './examples/heading-with-custom-accessibility.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates nested heading structure that automatically adjusts heading levels (h2, h3, h4) based on the current section depth, ensuring proper semantic document structure.', - codeblock: { - title: 'Heading within section hierarchy', - tabs: [ - { - code: './examples/heading-within-section-hierarchy.html', - language: 'html', - }, - - { - code: './examples/heading-within-section-hierarchy.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/basic-heading.html b/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/basic-heading.html deleted file mode 100644 index 5e8a56b931..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/basic-heading.html +++ /dev/null @@ -1 +0,0 @@ -Product details diff --git a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/basic-heading.jsx b/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/basic-heading.jsx deleted file mode 100644 index 40d49f0e26..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/basic-heading.jsx +++ /dev/null @@ -1 +0,0 @@ -Product details \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/default.jsx deleted file mode 100644 index ead20f29d4..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/default.jsx +++ /dev/null @@ -1 +0,0 @@ -Online store dashboard \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/heading-with-custom-accessibility.jsx b/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/heading-with-custom-accessibility.jsx deleted file mode 100644 index e345248e37..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/heading-with-custom-accessibility.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Sale badge - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/heading-with-line-clamping.jsx b/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/heading-with-line-clamping.jsx deleted file mode 100644 index f5bbc32a87..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/heading-with-line-clamping.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - - Premium organic cotton t-shirt with sustainable manufacturing practices - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/heading-within-section-hierarchy.jsx b/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/heading-within-section-hierarchy.jsx deleted file mode 100644 index 0909214ff3..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Heading/examples/heading-within-section-hierarchy.jsx +++ /dev/null @@ -1,12 +0,0 @@ - - Order information - {/* Renders as h2 */} - - Shipping details - {/* Renders as h3 */} - - Tracking updates - {/* Renders as h4 */} - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Icon.d.ts index d3381a32ce..0169812a82 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Icon.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,58 +6,180 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - IconProps$1, - IconType, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {IconProps$1, IconType, ComponentChildren} from './shared.d.ts'; export interface IconProps - extends Required< - Pick + extends Pick< + IconProps$1, + 'type' | 'tone' | 'color' | 'size' | 'interestFor' > { /** - * Specifies the type of icon that will be displayed. + * The type of icon that will be displayed. You can specify an icon name from the available icon set, or use an empty string to show no icon. */ type: '' | IconType | 'empty'; + /** + * The color tone of the icon based on its semantic meaning. Choose from `'auto'` to let the icon inherit its context, `'neutral'` for standard icons, `'info'` for informational content, `'success'` for positive actions, `'caution'` or `'warning'` for warnings, or `'critical'` for errors. + * + * @default 'auto' + */ tone: Extract< IconProps$1['tone'], 'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical' >; + /** + * The color emphasis of the icon. Use `'base'` for the standard color intensity, or `'subdued'` for a lighter, less prominent appearance. + * + * @default 'base' + */ color: Extract; + /** + * The size of the icon. Use `'small'` for compact layouts, or `'base'` for standard sizing. + * + * @default 'base' + */ size: Extract; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles for the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a custom element with Preact. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * Optional CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * The properties of an activation event, such as a click or keypress. These properties capture which modifier keys were pressed and which mouse button was used during the event. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during activation. + */ + shiftKey: boolean; + /** + * Whether the meta key (Command on Mac, Windows key on Windows) was pressed during activation. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during activation. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during activation. + */ + button: number; } +/** + * The options for customizing synthetic click behavior. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * The base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of `HTMLElement` to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +/** + * An abstract base class for creating custom elements that render with Preact. + */ +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -declare abstract class IconBase - extends PolarisCustomElement - implements Pick -{ - accessor color: IconProps['color']; - accessor size: IconProps['size']; - accessor interestFor: IconProps['interestFor']; - abstract tone: string; - abstract type: string; - constructor(renderImpl: RenderImpl); + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queues a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to `@property` values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in a background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class Icon extends IconBase implements IconProps { +/** + * An icon displays a graphical symbol from the icon library. + */ +declare class Icon extends PreactCustomElement implements IconProps { + /** + * The color emphasis of the icon. + */ + accessor color: IconProps['color']; + /** + * The color tone of the icon based on its semantic meaning. + */ accessor tone: IconProps['tone']; + /** + * The type of icon to display. + */ accessor type: IconProps['type']; + /** + * The size of the icon. + */ + accessor size: IconProps['size']; + /** + * The element that this icon should show interest for when activated. + */ + accessor interestFor: string; constructor(); } declare global { @@ -74,6 +196,10 @@ declare module 'preact' { } declare const tagName = 's-icon'; +/** + * The properties for the icon component when it's used in JSX. + * @publicDocs + */ export interface IconJSXProps extends Partial, Pick {} diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/Icon.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Icon/Icon.doc.ts deleted file mode 100644 index f794f9ca2f..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/Icon.doc.ts +++ /dev/null @@ -1,217 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Icon'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/icon.png', - isVisualComponent: true, - subSections: [ - { - title: 'Available icons', - type: 'Generic' as const, - anchorLink: 'available-icons', - sectionContent: - 'Search and filter across all the available icons: {{ICON_PREVIEW_IFRAME}}', - }, - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Orienting themselves and understanding available actions -- Quickly identifying information and recognizing patterns`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `Icons should: -- Use the same icon consistently for the same meaning -- Appear next to related text labels -- Only be used when their meaning is clear`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Icon', - }, - ], - defaultExample: { - image: 'icon-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - layout: 'inline', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Standard icons for common merchant interface actions and navigation. Demonstrates rendering multiple icons in an inline stack, showing different types of icons used for navigation and actions.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Icons with color-coded tones to convey status and semantic meaning.', - codeblock: { - title: 'With semantic tone', - tabs: [ - { - code: './examples/with-semantic-tone.html', - language: 'html', - }, - - { - code: './examples/with-semantic-tone.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Compact icon sizing for space-constrained interfaces and inline usage. Shows how to render a small-sized icon that takes up minimal space while maintaining clarity.', - codeblock: { - title: 'Small size', - tabs: [ - { - code: './examples/small-size.html', - language: 'html', - }, - - { - code: './examples/small-size.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Lower contrast icon for secondary actions and supporting information.', - codeblock: { - title: 'Subdued color', - tabs: [ - { - code: './examples/subdued-color.html', - language: 'html', - }, - - { - code: './examples/subdued-color.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Icon with unique identifier for JavaScript targeting and styling. Demonstrates adding a specific ID to an icon, which can be used for JavaScript interactions, CSS styling, or accessibility purposes.', - codeblock: { - title: 'With id property', - tabs: [ - { - code: './examples/with-id-property.html', - language: 'html', - }, - - { - code: './examples/with-id-property.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Icon associated with interactive elements for enhanced accessibility context.', - codeblock: { - title: 'With interest relationship', - tabs: [ - { - code: './examples/with-interest-relationship.html', - language: 'html', - }, - - { - code: './examples/with-interest-relationship.jsx', - language: 'preview-jsx', - customStyles: { - minHeight: '200px', - }, - }, - ], - }, - }, - { - description: - "Icons integrated within button components for clear action identification. Shows how icons can be added to buttons to visually reinforce the button's action, using both positive (add) and negative (delete) tones.", - codeblock: { - title: 'In button components', - tabs: [ - { - code: './examples/in-button-components.html', - language: 'html', - }, - - { - code: './examples/in-button-components.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Icons combined with badges to enhance status communication and visual hierarchy. Demonstrates using icons with badges to provide visual status indicators, using success and warning tones to convey different states.', - codeblock: { - title: 'In badge components', - tabs: [ - { - code: './examples/in-badge-components.html', - language: 'html', - }, - - { - code: './examples/in-badge-components.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/basic-usage.jsx deleted file mode 100644 index 156b90bf1c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/basic-usage.jsx +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/default.jsx deleted file mode 100644 index 7204990fa0..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/default.jsx +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/in-badge-components.jsx b/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/in-badge-components.jsx deleted file mode 100644 index 9cec5bd7a1..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/in-badge-components.jsx +++ /dev/null @@ -1,8 +0,0 @@ - - - Active - - - Pending - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/in-button-components.jsx b/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/in-button-components.jsx deleted file mode 100644 index 01eaccfe50..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/in-button-components.jsx +++ /dev/null @@ -1,8 +0,0 @@ - - - Add product - - - Delete - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/small-size.jsx b/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/small-size.jsx deleted file mode 100644 index 72abbbd057..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/small-size.jsx +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/subdued-color.jsx b/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/subdued-color.jsx deleted file mode 100644 index bd8c73a4c4..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/subdued-color.jsx +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/with-id-property.jsx b/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/with-id-property.jsx deleted file mode 100644 index 3a58bd1cfe..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/with-id-property.jsx +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/with-interest-relationship.jsx b/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/with-interest-relationship.jsx deleted file mode 100644 index 8e31a93e54..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/with-interest-relationship.jsx +++ /dev/null @@ -1,6 +0,0 @@ -<> - - SKU must be unique across all products and cannot be changed after creation - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/with-semantic-tone.jsx b/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/with-semantic-tone.jsx deleted file mode 100644 index 922f5374dd..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/examples/with-semantic-tone.jsx +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Icon/icon-data.json b/packages/ui-extensions/src/surfaces/admin/components/Icon/icon-data.json deleted file mode 100644 index 3cd3c20686..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Icon/icon-data.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "iconPreviewData": { - "jsxFile": "./templates/icon-renderer/icon-preview.jsx", - "icons": "__AUTO_GENERATED_ICONS__", - "bodyContent": "
", - "customStyles": "padding: 0px; margin: 0px; margin-top: 8px; max-width: 584px; overflow: hidden; background: #FFF, border: 1px solid #ccc; border-radius: 8px;", - "hashes": "__AUTO_GENERATED_HASHES__" - } -} diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Image.d.ts index f1247f29ac..638f688c5e 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Image.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Image.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -13,28 +13,51 @@ import type { SizeUnitsOrAuto, SizeUnits, SizeUnitsOrNone, - PreactCustomElement, - RenderImpl, + ComponentChildren, } from './shared.d.ts'; +/** + * A callback event that's typed to a specific HTML element. This type provides access to the element that triggered the event. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that currently has the event listener attached. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * An event listener for callback events, typed to a specific HTML element. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } +/** + * Makes a type value responsive by allowing container query strings. + * @publicDocs + */ export type MakeResponsive = T | `@container${string}`; /** * Makes a property's value potentially responsive. @@ -51,12 +74,21 @@ export type MakeResponsive = T | `@container${string}`; * margin: string | `@container${string}`; * padding: number | `@container${string}`; * } + * @publicDocs */ export type MakeResponsivePick = { [P in TProperty]: MakeResponsive; }; +/** + * The box properties with all fields marked as required. + * @publicDocs + */ export type RequiredBoxProps = Required; +/** + * The available border radius values for Box components. + * @publicDocs + */ export type BoxBorderRadii = Extract< RequiredBoxProps['borderRadius'], | 'none' @@ -68,10 +100,18 @@ export type BoxBorderRadii = Extract< | 'large-100' | 'large-200' >; +/** + * The available border style values for Box components. + * @publicDocs + */ export type BoxBorderStyles = Extract< RequiredBoxProps['borderStyle'], 'none' | 'solid' | 'dashed' | 'auto' >; +/** + * The box properties that support responsive values through container queries. + * @publicDocs + */ export type ResponsiveBoxProps = MakeResponsivePick< RequiredBoxProps, | 'padding' @@ -104,7 +144,7 @@ export interface BoxProps | 'overflow' > { /** - * Adjust the background of the component. + * The background color of the image container. * * @default 'transparent' */ @@ -113,7 +153,16 @@ export interface BoxProps 'transparent' | 'base' | 'subdued' | 'strong' >; /** - * Adjust the width of the border. + * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property. + * + * - `small`: Thin border for subtle definition. + * - `small-100`: Extra thin border for minimal emphasis. + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `none`: No border. + * + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side. * * @default '' - meaning no override */ @@ -126,7 +175,7 @@ export interface BoxProps > | Extract; /** - * Adjust the style of the border. + * The visual style of the border (solid, dashed, auto, or none). * * @default '' - meaning no override */ @@ -134,7 +183,7 @@ export interface BoxProps | MaybeAllValuesShorthandProperty | Extract; /** - * Adjust the color of the border. + * The color of the border using the design system's color scale. * * @default '' - meaning no override */ @@ -143,13 +192,13 @@ export interface BoxProps 'subdued' | 'base' | 'strong' | '' >; /** - * Adjust the radius of the border. + * The roundedness of the corners using the design system's radius scale. * * @default 'none' */ borderRadius: MaybeAllValuesShorthandProperty; /** - * Adjust the padding of all edges. + * The padding applied to all edges of the image container. * * [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: * @@ -165,71 +214,71 @@ export interface BoxProps * * 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. + * `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default 'none' */ padding: ResponsiveBoxProps['padding']; /** - * Adjust the block-padding. + * The padding applied to the block axis (top and bottom in horizontal writing modes). * * - `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. + * `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlock: ResponsiveBoxProps['paddingBlock']; /** - * Adjust the block-start padding. + * The padding applied to the block-start edge (top in horizontal writing modes). * * 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. + * `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlockStart: ResponsiveBoxProps['paddingBlockStart']; /** - * Adjust the block-end padding. + * The padding applied to the block-end edge (bottom in horizontal writing modes). * * 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. + * `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlockEnd: ResponsiveBoxProps['paddingBlockEnd']; /** - * Adjust the inline padding. + * The padding applied to the inline axis (left and right in horizontal writing modes). * * - `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. + * `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingInline: ResponsiveBoxProps['paddingInline']; /** - * Adjust the inline-start padding. + * The padding applied to the inline-start edge (left in left-to-right languages). * * 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. + * `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingInlineStart: ResponsiveBoxProps['paddingInlineStart']; /** - * Adjust the inline-end padding. + * The padding applied to the inline-end edge (right in left-to-right languages). * * 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. + * `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ @@ -244,43 +293,52 @@ export interface BoxProps */ display: ResponsiveBoxProps['display']; /** - * Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). + * The vertical size of the image in standard layouts (height in left-to-right or right-to-left writing modes). + * + * Block size adjusts based on the writing direction: in horizontal layouts, it controls the height; + * in vertical layouts, it controls the width. This ensures consistent behavior across different text directions. + * + * Learn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). * * @default 'auto' */ blockSize: SizeUnitsOrAuto; /** - * Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size). + * The [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size) (minimum height in horizontal writing modes) of the image. * * @default '0' */ minBlockSize: SizeUnits; /** - * Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size). + * The [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size) (maximum height in horizontal writing modes) of the image. * * @default 'none' */ maxBlockSize: SizeUnitsOrNone; /** - * Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size). + * The [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size) (width in horizontal writing modes) of the image. * * @default 'auto' */ inlineSize: SizeUnitsOrAuto; /** - * Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size). + * The [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size) (minimum width in horizontal writing modes) of the image. * * @default '0' */ minInlineSize: SizeUnits; /** - * Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size). + * The [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size) (maximum width in horizontal writing modes) of the image. * * @default 'none' */ maxInlineSize: SizeUnitsOrNone; } +/** + * The properties for the image component. An image displays pictures with configurable sizing, loading behavior, and borders. Properties include `src` for the image URL, `alt` for accessibility text, `aspectRatio` for sizing, `loading` for lazy loading, and border styling options. + * @publicDocs + */ export interface ImageProps extends Required< Pick< @@ -305,28 +363,229 @@ export interface ImageProps | 'borderStyle' | 'borderWidth' > - > {} + > { + /** + * The URL of the image to display. You can provide an absolute or relative URL pointing to the image file. + */ + src: ImageProps$1['src']; + /** + * A set of source images with different sizes for responsive loading. Use this to provide multiple image sizes for different screen resolutions (for example, `'image-320w.jpg 320w, image-640w.jpg 640w'`). + */ + srcSet: ImageProps$1['srcSet']; + /** + * The sizes of the image at different viewport widths. Use this with `srcSet` to tell the browser which image to load (for example, `'(max-width: 320px) 280px, 640px'`). + */ + sizes: ImageProps$1['sizes']; + /** + * Alternative text that describes the image for screen readers. This text should convey the meaning or content of the image to users who can't see it. + */ + alt: ImageProps$1['alt']; + /** + * The aspect ratio of the image as a width-to-height ratio (for example, `'16/9'` or `'1'`). This helps prevent layout shifts while the image loads. + */ + aspectRatio: ImageProps$1['aspectRatio']; + /** + * How the image should be resized to fit its container. Choose `'cover'` to fill the container while maintaining aspect ratio (cropping if needed), or `'contain'` to fit the entire image within the container. + */ + objectFit: ImageProps$1['objectFit']; + /** + * When the image should be loaded. Use `'lazy'` to defer loading until the image is near the viewport, or `'eager'` to load immediately. + */ + loading: ImageProps$1['loading']; + /** + * The accessibility role for the image. Set this to provide semantic meaning for screen readers. + */ + accessibilityRole: ImageProps$1['accessibilityRole']; + /** + * The inline size (width in horizontal writing modes) of the image. You can use size units like `'100px'` or `'50%'`. + */ + inlineSize: ImageProps$1['inlineSize']; + /** + * Whether to show a border around the image. Set to `true` to display a border, or `false` to hide it. + */ + border: BoxProps['border']; + /** + * The width of the border around the image. You can use a single value to apply the same width to all sides, or use the 1-to-4-value syntax to control individual sides. + */ + borderWidth: BoxProps['borderWidth']; + /** + * The style of the border around the image. You can use a single value to apply the same style to all sides, or use the 1-to-4-value syntax to control individual sides. + */ + borderStyle: BoxProps['borderStyle']; + /** + * The color of the border around the image. Choose from `'subdued'`, `'base'`, or `'strong'` to control the visual emphasis. + */ + borderColor: BoxProps['borderColor']; + /** + * The radius of the border corners around the image. You can use a single value to apply the same radius to all corners, or use the 1-to-4-value syntax to control individual corners. + */ + borderRadius: BoxProps['borderRadius']; +} + +/** + * A string containing CSS styles for a custom element. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with Preact. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The optional CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * The properties of an activation event, such as a click or keypress. These properties capture which modifier keys were pressed and which mouse button was used during the event. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * The options for triggering a synthetic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * The base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of `HTMLElement` to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +/** + * An abstract base class for creating custom elements that render with Preact. + */ +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queues a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to `@property` values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in a background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } -declare class Image extends PolarisCustomElement implements ImageProps { +/** + * An image displays pictures with configurable sizing, loading behavior, and borders. + */ +declare class Image extends PreactCustomElement implements ImageProps { + /** + * The URL of the image to display. + */ accessor src: ImageProps['src']; + /** + * A set of source images with different sizes for responsive loading. + */ accessor srcSet: ImageProps['srcSet']; + /** + * The sizes of the image at different viewport widths. + */ accessor sizes: ImageProps['sizes']; + /** + * Alternative text that describes the image for screen readers. + */ accessor alt: ImageProps['alt']; + /** + * The aspect ratio of the image as a width-to-height ratio. + */ accessor aspectRatio: ImageProps['aspectRatio']; + /** + * How the image should be resized to fit its container. + */ accessor objectFit: ImageProps['objectFit']; + /** + * When the image should be loaded. + */ accessor loading: ImageProps['loading']; + /** + * The accessibility role for the image. + */ accessor accessibilityRole: ImageProps['accessibilityRole']; + /** + * The inline size (width in horizontal writing modes) of the image. + */ accessor inlineSize: ImageProps['inlineSize']; + /** + * Whether to show a border around the image. + */ accessor border: ImageProps['border']; + /** + * The width of the border around the image. + */ accessor borderWidth: ImageProps['borderWidth']; + /** + * The style of the border around the image. + */ accessor borderStyle: ImageProps['borderStyle']; + /** + * The color of the border around the image. + */ accessor borderColor: ImageProps['borderColor']; + /** + * The radius of the border corners around the image. + */ accessor borderRadius: ImageProps['borderRadius']; + /** + * A callback that's fired when the image has loaded successfully. + */ accessor onload: CallbackEventListener | null; + /** + * A callback that's fired when the image fails to load. + */ accessor onerror: OnErrorEventHandler; constructor(); } @@ -344,10 +603,20 @@ declare module 'preact' { } declare const tagName = 's-image'; +/** + * The properties for the image component when it's used in JSX. + * @publicDocs + */ export interface ImageJSXProps extends Partial, Pick { + /** + * A callback that's fired when the image fails to load. + */ onError?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's fired when the image has loaded successfully. + */ onLoad?: ((event: CallbackEvent) => void) | null; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/Image.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Image/Image.doc.ts deleted file mode 100644 index 1a165bc9af..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/Image.doc.ts +++ /dev/null @@ -1,199 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Image'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/image.png', - isVisualComponent: true, - subSections: [ - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Adding illustrations and photos.`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use high-resolution, optimized images -- Use intentionally to add clarity and guide users`, - }, - { - title: 'Content guidelines', - type: 'Generic' as const, - anchorLink: 'content-guidelines', - sectionContent: `Alt text should be accurate, concise, and descriptive: -- Indicate it's an image: "Image of", "Photo of" -- Focus on description: "Image of a woman with curly brown hair smiling"`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Image', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'ImageEvents', - }, - ], - defaultExample: { - image: 'image-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates the simplest implementation of an image component with a source and alt text.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how to create a responsive image with a fixed 16:9 aspect ratio, set to cover the container, and loaded lazily.', - codeblock: { - title: 'Responsive layout with aspect ratio', - tabs: [ - { - code: './examples/responsive-layout-with-aspect-ratio.html', - language: 'html', - }, - - { - code: './examples/responsive-layout-with-aspect-ratio.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates how to provide multiple image sources for different screen sizes and resolutions using srcSet and sizes attributes.', - codeblock: { - title: 'Responsive images with srcset', - tabs: [ - { - code: './examples/responsive-images-with-srcset.html', - language: 'html', - }, - - { - code: './examples/responsive-images-with-srcset.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates how to apply border styling to an image, including width, style, color, and radius, using border-related properties.', - codeblock: { - title: 'With border styling', - tabs: [ - { - code: './examples/with-border-styling.html', - language: 'html', - }, - - { - code: './examples/with-border-styling.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how to mark an image as decorative, which will make screen readers ignore the image by setting an empty alt text and presentation role.', - codeblock: { - title: 'Decorative image', - tabs: [ - { - code: './examples/decorative-image.html', - language: 'html', - }, - - { - code: './examples/decorative-image.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - "Demonstrates an image with auto-sizing, which allows the image to adjust its size based on its container's width.", - codeblock: { - title: 'Auto-sized image', - tabs: [ - { - code: './examples/auto-sized-image.html', - language: 'html', - }, - - { - code: './examples/auto-sized-image.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how to use images within a grid layout, creating a consistent grid of images with equal size, aspect ratio, and styling.', - codeblock: { - title: 'Within layout components', - tabs: [ - { - code: './examples/within-layout-components.html', - language: 'html', - }, - - { - code: './examples/within-layout-components.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/auto-sized-image.html b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/auto-sized-image.html deleted file mode 100644 index dd7acbadb4..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/auto-sized-image.html +++ /dev/null @@ -1,5 +0,0 @@ - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/auto-sized-image.jsx b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/auto-sized-image.jsx deleted file mode 100644 index 83f586adbc..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/auto-sized-image.jsx +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/basic-usage.html index 94ee599509..e886ea2769 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/basic-usage.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/basic-usage.html @@ -1,4 +1,15 @@ - + + + + Indoor Plant + SKU: PLT-001 + In stock + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/basic-usage.jsx deleted file mode 100644 index 0efad0653f..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/basic-usage.jsx +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/decorative-image.jsx b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/decorative-image.jsx deleted file mode 100644 index 681301249d..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/decorative-image.jsx +++ /dev/null @@ -1,6 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/default.jsx deleted file mode 100644 index c418b6de75..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/default.jsx +++ /dev/null @@ -1,6 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/responsive-images-with-srcset.jsx b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/responsive-images-with-srcset.jsx deleted file mode 100644 index 2512acb43d..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/responsive-images-with-srcset.jsx +++ /dev/null @@ -1,9 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/responsive-layout-with-aspect-ratio.jsx b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/responsive-layout-with-aspect-ratio.jsx deleted file mode 100644 index 191b3ef76b..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/responsive-layout-with-aspect-ratio.jsx +++ /dev/null @@ -1,7 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/with-border-styling.jsx b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/with-border-styling.jsx deleted file mode 100644 index 63dcd27883..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/with-border-styling.jsx +++ /dev/null @@ -1,12 +0,0 @@ - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/within-layout-components.jsx b/packages/ui-extensions/src/surfaces/admin/components/Image/examples/within-layout-components.jsx deleted file mode 100644 index bde0b458ca..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Image/examples/within-layout-components.jsx +++ /dev/null @@ -1,26 +0,0 @@ - - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Link.d.ts index 0df5dfcfe1..d2d2d883c8 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Link.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Link.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -10,8 +10,6 @@ import type { ComponentChildren, LinkProps$1, InteractionProps, - PreactCustomElement, - RenderImpl, } from './shared.d.ts'; export type CallbackEvent = Event & { @@ -22,21 +20,34 @@ export type CallbackEventListener = (event: CallbackEvent): void; }) | null; -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } - +/** * @publicDocs + */ export type RequiredLinkProps = Required; export type LinkBaseProps = Required< Pick< @@ -52,25 +63,96 @@ export type LinkBaseProps = Required< | 'tone' > >; +/** + * The properties for the link component. These properties define a clickable link that navigates users to different pages or sections with customizable visual styles and semantic meaning. + * @publicDocs + */ export interface LinkProps extends LinkBaseProps { + /** + * The visual appearance and semantic meaning of the link. Links rely on the tone system for semantic meaning, so using custom styling might not clearly convey intent to merchants. Available options: + * - `'auto'` - The system automatically chooses the appropriate tone based on context. + * - `'neutral'` - Standard styling for general navigation without specific semantic meaning. + * - `'critical'` - Red styling for links that lead to destructive actions or important warnings. + * + * @default 'auto' + */ tone: Extract; } - -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** * @publicDocs + */ +export type Styles = string; +export type RenderImpl = Omit & { + ShadowRoot: (element: any) => ComponentChildren; + styles?: Styles; +}; +export interface ActivationEventEsque { + shiftKey: boolean; + metaKey: boolean; + ctrlKey: boolean; + button: number; +} +/** * + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; } +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} +/** * @publicDocs + */ export interface PreactOverlayControlProps extends Pick { /** - * Sets the action the [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this clickable is activated. - * - * See the documentation of particular components for the actions they support. + * The action the [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated. The supported actions vary by target component type. * - * - `--auto`: a default action for the target component. - * - `--show`: shows the target component. - * - `--hide`: hides the target component. - * - `--toggle`: toggles the target component. + * - `--auto`: Performs the default action appropriate for the target component. + * - `--show`: Displays the target component if it's currently hidden. + * - `--hide`: Conceals the target component from view. + * - `--toggle`: Alternates the target component between visible and hidden states. * * @default '--auto' */ @@ -79,39 +161,27 @@ export interface PreactOverlayControlProps '--show' | '--hide' | '--toggle' | '--auto' >; /** - * Sets the element the [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this clickable is activated. + * Sets the element the [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated. */ commandFor: Extract; /** - * Sets the element the [interestFor](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code) should act on when this clickable is activated. + * Sets the element the [interestFor](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code) should act on when this component is activated. */ interestFor: Extract; } -declare const LinkBase_base: (abstract new ( - renderImpl: Omit, -) => PolarisCustomElement & PreactOverlayControlProps) & - Pick; -declare abstract class LinkBase - extends LinkBase_base - implements - Pick< - LinkProps, - 'accessibilityLabel' | 'href' | 'target' | 'download' | 'lang' - > -{ +declare const Link_base: (abstract new ( + args_0: RenderImpl, +) => PreactCustomElement & PreactOverlayControlProps) & + Pick; +declare class Link extends Link_base implements LinkProps { + accessor tone: LinkProps['tone']; accessor accessibilityLabel: LinkProps['accessibilityLabel']; accessor href: LinkProps['href']; accessor target: LinkProps['target']; accessor download: LinkProps['download']; accessor lang: LinkProps['lang']; - accessor onclick: CallbackEventListener | null; - abstract tone: string; - constructor(renderImpl: RenderImpl); -} - -declare class Link extends LinkBase implements LinkProps { - accessor tone: LinkProps['tone']; + accessor onclick: CallbackEventListener | null; constructor(); } declare global { @@ -128,14 +198,56 @@ declare module 'preact' { } declare const tagName = 's-link'; +/** + * The JSX properties for the link component. These properties define how a link is rendered in Preact or JSX. + * @publicDocs + */ export interface LinkJSXProps extends Partial, Pick { /** - * The content of the Link. + * The text or content to display inside the link. This typically describes the destination or action the link performs. */ children?: ComponentChildren; + /** + * A callback function that's invoked when the link is clicked. It receives the click event as an argument. + */ onClick?: ((event: CallbackEvent) => void) | null; + /** + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. + * + * @default '' + */ + accessibilityLabel?: string; + /** + * The URL that the link navigates to when clicked. This is the primary property that defines where the link leads. + * + * @default '' + */ + href?: LinkProps['href']; + /** + * Where to open the linked document. Available options: + * - `''` - Opens in the same frame (default behavior). + * - `'_blank'` - Opens in a new window or tab. + * - `'_self'` - Opens in the same frame (explicit version of default). + * - `'_parent'` - Opens in the parent frame. + * - `'_top'` - Opens in the full body of the window. + * + * @default '' + */ + target?: LinkProps['target']; + /** + * The filename to save the linked URL as when downloaded. When provided, clicking the link will download the resource instead of navigating to it. + * + * @default '' + */ + download?: LinkProps['download']; + /** + * The language of the link's content, specified as a BCP 47 language tag (such as `'en'` or `'fr'`). This helps assistive technologies pronounce content correctly. + * + * @default '' + */ + lang?: string; } export {Link}; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/Link.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Link/Link.doc.ts deleted file mode 100644 index 200bee3c3a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/Link.doc.ts +++ /dev/null @@ -1,262 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Link'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/link.png', - isVisualComponent: true, - subSections: [ - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use links for navigation and buttons for actions -- Use default links whenever possible to avoid disorienting merchants -- Open external links in a new tab only when merchants are performing a task or navigating outside the Shopify admin`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Link', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'LinkEvents', - }, - { - title: 'Slots', - description: '', - type: 'LinkSlots', - }, - ], - defaultExample: { - image: 'link-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Links automatically inherit the tone from their surrounding paragraph context.', - codeblock: { - title: 'Basic Links in Paragraph', - tabs: [ - { - code: './examples/basic-links-in-paragraph.html', - language: 'html', - }, - - { - code: './examples/basic-links-in-paragraph.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates links within subdued paragraph, showing how links can be used in less prominent paragraph contexts for additional guidance or support.', - codeblock: { - title: 'Links in Subdued Paragraph', - tabs: [ - { - code: './examples/links-in-subdued-paragraph.html', - language: 'html', - }, - - { - code: './examples/links-in-subdued-paragraph.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates how links can be used in critical or urgent text contexts, drawing attention to important actions that require immediate user intervention.', - codeblock: { - title: 'Critical Context Links', - tabs: [ - { - code: './examples/critical-context-links.html', - language: 'html', - }, - - { - code: './examples/critical-context-links.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how links automatically adapt their tone to the surrounding text context, maintaining visual consistency while providing navigation.', - codeblock: { - title: 'Links with Auto Tone', - tabs: [ - { - code: './examples/links-with-auto-tone.html', - language: 'html', - }, - - { - code: './examples/links-with-auto-tone.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates how links can be integrated within banner components to highlight important information and provide direct action paths.', - codeblock: { - title: 'Links in Banner', - tabs: [ - { - code: './examples/links-in-banner.html', - language: 'html', - }, - - { - code: './examples/links-in-banner.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates using links within a box container to provide contextual navigation and additional information in a visually contained area.', - codeblock: { - title: 'Links in Box Container', - tabs: [ - { - code: './examples/links-in-box-container.html', - language: 'html', - }, - - { - code: './examples/links-in-box-container.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how links can be used within warning banners to provide immediate actions related to critical notifications.', - codeblock: { - title: 'Links in Banner Context', - tabs: [ - { - code: './examples/links-in-banner-context.html', - language: 'html', - }, - - { - code: './examples/links-in-banner-context.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates how to create links that trigger file downloads, useful for exporting data or providing downloadable resources.', - codeblock: { - title: 'Download Links', - tabs: [ - { - code: './examples/download-links.html', - language: 'html', - }, - - { - code: './examples/download-links.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates linking to external resources with different targets, showing how to open links in new tabs and provide navigation to external documentation.', - codeblock: { - title: 'External Links', - tabs: [ - { - code: './examples/external-links.html', - language: 'html', - }, - - { - code: './examples/external-links.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how to use the `lang` attribute to specify the language of a link, supporting internationalization and proper screen reader pronunciation.', - codeblock: { - title: 'Links with Language Attribute', - tabs: [ - { - code: './examples/links-with-language-attribute.html', - language: 'html', - }, - - { - code: './examples/links-with-language-attribute.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates how links can have different visual tones, including default, neutral, and critical, allowing for varied contextual styling.', - codeblock: { - title: 'Links with Different Tones', - tabs: [ - { - code: './examples/links-with-different-tones.html', - language: 'html', - }, - - { - code: './examples/links-with-different-tones.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/basic-links-in-paragraph.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/basic-links-in-paragraph.jsx deleted file mode 100644 index aba876b059..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/basic-links-in-paragraph.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Your product catalog is empty. Start by adding your first product or importing existing inventory. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/critical-context-links.html b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/critical-context-links.html deleted file mode 100644 index 5221cc801a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/critical-context-links.html +++ /dev/null @@ -1,3 +0,0 @@ - - Your store will be suspended in 24 hours due to unpaid balance. Update payment method to avoid service interruption. - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/critical-context-links.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/critical-context-links.jsx deleted file mode 100644 index bf6bb30c06..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/critical-context-links.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Your store will be suspended in 24 hours due to unpaid balance. Update payment method to avoid service interruption. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/default.html b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/default.html index fbb5b57b54..4ae2685161 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/default.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/default.html @@ -1 +1 @@ -fufilling orders +fulfilling orders \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/default.jsx deleted file mode 100644 index 2ff4812f97..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/default.jsx +++ /dev/null @@ -1 +0,0 @@ -fufilling orders \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/download-links.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/download-links.jsx deleted file mode 100644 index d984b73e91..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/download-links.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Export your customer data for marketing analysis. Download customer list - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/external-links.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/external-links.jsx deleted file mode 100644 index ea12342afa..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/external-links.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - - Need help with policies? Read our billing docs or review the terms of service. - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-banner-context.html b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-banner-context.html deleted file mode 100644 index 6afd5cf4d6..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-banner-context.html +++ /dev/null @@ -1,5 +0,0 @@ - - - Your inventory for "Vintage t-shirt" is running low (3 remaining). Restock inventory - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-banner-context.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-banner-context.jsx deleted file mode 100644 index 1090e67562..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-banner-context.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - - Your inventory for "Vintage t-shirt" is running low (3 remaining). Restock inventory - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-banner.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-banner.jsx deleted file mode 100644 index bcad9634b9..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-banner.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - - Black Friday campaigns are now available! Create your campaign - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-box-container.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-box-container.jsx deleted file mode 100644 index fe714dfd0c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-box-container.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - - Boost your store's conversion with professional themes. Browse theme store or customize your current theme. - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.html b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.html deleted file mode 100644 index 9d1cc904ed..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.html +++ /dev/null @@ -1,3 +0,0 @@ - - Need help setting up shipping rates? View shipping guide or contact merchant support. - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.jsx deleted file mode 100644 index 4a859976db..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-in-subdued-paragraph.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Need help setting up shipping rates? View shipping guide or contact merchant support. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-auto-tone.html b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-auto-tone.html deleted file mode 100644 index d44fd5bf20..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-auto-tone.html +++ /dev/null @@ -1,3 +0,0 @@ - - You have 15 pending orders to fulfill. Review unfulfilled orders to keep customers happy. - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-auto-tone.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-auto-tone.jsx deleted file mode 100644 index 4d91fefc7c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-auto-tone.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - You have 15 pending orders to fulfill. Review unfulfilled orders to keep customers happy. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-different-tones.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-different-tones.jsx deleted file mode 100644 index ce4a6c765c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-different-tones.jsx +++ /dev/null @@ -1,25 +0,0 @@ - - - Default tone: View orders - - - - Success tone: Inventory help - - - - Critical tone: Close store - - - - Warning tone: Update billing info - - - - Info tone: Learn more about reports - - - - Caution tone: View archived products - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-language-attribute.jsx b/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-language-attribute.jsx deleted file mode 100644 index cfb48c5aa5..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Link/examples/links-with-language-attribute.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Voir en français: Gérer les produits - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/ListItem.d.ts b/packages/ui-extensions/src/surfaces/admin/components/ListItem.d.ts index 044cdd0a37..97aa9cec52 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/ListItem.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/ListItem.d.ts @@ -1,39 +1,146 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - ListItemProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, ListItemProps$1} from './shared.d.ts'; +/** + * The properties that you can set on a list item component. + * @publicDocs + */ export interface ListItemProps extends ListItemProps$1 {} -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string that contains CSS styles. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with a shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow DOM content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the shadow DOM. + */ + styles?: Styles; +}; +/** + * An object that represents the state of modifier keys and mouse button + * during an activation event like a click. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; +} +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class ListItem extends PolarisCustomElement implements ListItemProps { +/** + * A component that represents a single item within an ordered list or unordered list. + * + * Use list item as a child of ordered list or unordered list to create properly structured and accessible list content. + */ +declare class ListItem extends PreactCustomElement implements ListItemProps { constructor(); } declare global { @@ -51,11 +158,15 @@ declare module 'preact' { } declare const tagName = 's-list-item'; +/** + * The JSX properties you can set on a list item component. + * @publicDocs + */ export interface ListItemJSXProps extends Partial, Pick { /** - * The content of the ListItem. + * The content to display inside the list item. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Menu.d.ts index f866867d68..c712bf293b 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Menu.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -9,39 +9,147 @@ import type { ComponentChildren, MenuProps$1, - PreactCustomElement, - RenderImpl, InteractionProps, } from './shared.d.ts'; +/** + * The properties you can set on a menu component. + * @publicDocs + */ export interface MenuProps extends Required> {} -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; +} +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } +/** + * The properties for controlling overlay elements like popovers, tooltips, and menus through command interactions. + * @publicDocs + */ export interface PreactOverlayControlProps extends Pick { /** - * Sets the action the [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this clickable is activated. + * The action that the [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated. * - * See the documentation of particular components for the actions they support. + * See the documentation of specific components for the actions they support. * * - `--auto`: a default action for the target component. * - `--show`: shows the target component. @@ -55,11 +163,11 @@ export interface PreactOverlayControlProps '--show' | '--hide' | '--toggle' | '--auto' >; /** - * Sets the element the [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this clickable is activated. + * The element that the [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated. */ commandFor: Extract; /** - * Sets the element the [interestFor](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code) should act on when this clickable is activated. + * The element that the [interestFor](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code) should act on when this component is activated. */ interestFor: Extract; } @@ -67,29 +175,43 @@ export interface PreactOverlayControlProps /** * Shared symbols for overlay control functionality. * These symbols are used by components that implement overlay behavior - * (like Popover, Tooltip, Modal, etc.) to communicate with the overlay control system. - */ -/** - * Symbol used to track the open or closed state of the overlay. + * (such as Popover, Tooltip, and Modal) to communicate with the overlay control system. */ +/** @private */ declare const overlayHidden: unique symbol; -/** - * Symbol used to track the element that opened the overlay. In some cases, like tooltips and popovers, the overlay is positioned against this element. In all cases, focus should be restored to this element when the overlay is closed. - */ +/** @private */ declare const overlayActivator: unique symbol; +/** @private */ declare const overlayHideFrameId: unique symbol; +/** + * The initialization object for creating a polyfill command event. + * @publicDocs + */ export type PolyfillCommandEventInit = EventInit & { + /** + * The element that triggered the command. + */ source: HTMLElement | null | undefined; + /** + * The command action that should be performed. + */ command: PreactOverlayControlProps['command']; - rootActivator?: HTMLElement | null; }; +/** + * A polyfill event for the command interaction pattern, which is used to control overlay elements. + * @publicDocs + */ export type PolyfillCommandEvent = Event & { + /** + * The element that triggered the command. + */ source: PolyfillCommandEventInit['source']; + /** + * The command action that should be performed. + */ command: PolyfillCommandEventInit['command']; - /** Have to use `_s_shadowSource` because `source` is retargeted to the shadow host by browsers */ + /** You have to use `_s_shadowSource` because `source` is retargeted to the shadow host by browsers. */ _s_shadowSource: PolyfillCommandEventInit['source']; - /** Root activator for nested overlays (e.g., menu button when modal opened from menu item) */ - _s_rootActivator?: HTMLElement | null; }; declare global { interface GlobalEventHandlersEventMap { @@ -97,7 +219,13 @@ declare global { } } -declare class PreactOverlayElement extends PolarisCustomElement { +/** + * The base class for overlay elements that can be shown and hidden through command interactions. + */ +declare class PreactOverlayElement extends PreactCustomElement { + /** + * Creates a new overlay element with the given render implementation. + */ constructor(renderImpl: RenderImpl); /** @private */ [overlayHidden]: boolean; @@ -107,8 +235,17 @@ declare class PreactOverlayElement extends PolarisCustomElement { [overlayHideFrameId]?: number; } +/** + * A component that displays a contextual list of actions or options, which is typically triggered by a button or other activator element. + */ declare class Menu extends PreactOverlayElement implements MenuProps { + /** + * A label that describes the menu for assistive technologies. + */ accessor accessibilityLabel: string; + /** + * Creates a new Menu instance. + */ constructor(); /** @private */ connectedCallback(): void; @@ -128,14 +265,19 @@ declare module 'preact' { } } +/** + * The custom element tag name for the menu component. + */ declare const tagName = 's-menu'; +/** + * The JSX properties you can set on a menu component. + * @publicDocs + */ export interface MenuJSXProps extends Partial, Pick { /** - * The Menu items. - * - * Only accepts `Button` and `Section` components. + * The menu items to display, which should include button and section components. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/Menu.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Menu/Menu.doc.ts deleted file mode 100644 index 67f4e87e14..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/Menu.doc.ts +++ /dev/null @@ -1,213 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Menu'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/menu.png', - isVisualComponent: true, - subSections: [ - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Presenting a set of actions or selectable options to merchants -- Creating dropdown menus with related actions -- Organizing actions into logical groupings using sections`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use for secondary or less important actions since they're hidden until merchants open them -- Contain actions that are related to each other`, - }, - { - title: 'Content guidelines', - type: 'Generic' as const, - anchorLink: 'content-guidelines', - sectionContent: `- Each item should be clear and predictable -- Lead with a strong verb using the {verb}+{noun} format (e.g., "Buy shipping label", "Edit HTML") -- Avoid unnecessary words and articles like "the", "an", or "a"`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Menu', - }, - { - title: 'Slots', - description: '', - type: 'MenuSlots', - }, - ], - defaultExample: { - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - layout: 'alignStart', - customStyles: { - minHeight: '300px', - }, - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple menu with basic action buttons and shows how to link it to a trigger button.', - codeblock: { - title: 'Basic Menu', - tabs: [ - { - code: './examples/basic-menu.html', - language: 'html', - }, - - { - code: './examples/basic-menu.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - { - description: - 'Illustrates a menu with icons for each action, providing visual context for different menu items and showing how to use the caret-down icon on the trigger button.', - codeblock: { - title: 'Menu with Icons', - tabs: [ - { - code: './examples/menu-with-icons.html', - language: 'html', - }, - - { - code: './examples/menu-with-icons.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - { - description: - 'Shows how to organize menu items into logical sections with headings, helping to group related actions and improve menu readability.', - codeblock: { - title: 'Menu with Sections', - tabs: [ - { - code: './examples/menu-with-sections.html', - language: 'html', - }, - - { - code: './examples/menu-with-sections.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '400px', - }, - }, - ], - }, - }, - { - description: - "Demonstrates a menu with a mix of link-based buttons, standard buttons, and a disabled button, showcasing the menu's flexibility in handling different interaction states.", - codeblock: { - title: 'Menu with Links and Disabled Items', - tabs: [ - { - code: './examples/menu-with-links-and-disabled-items.html', - language: 'html', - }, - - { - code: './examples/menu-with-links-and-disabled-items.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - { - description: - "Presents a comprehensive menu showing how to create sections with different action groups and include a critical action at the menu's root level.", - codeblock: { - title: 'Actions menu with sections', - tabs: [ - { - code: './examples/customer-actions-menu.html', - language: 'html', - }, - - { - code: './examples/customer-actions-menu.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - { - description: - 'Illustrates a complex menu with nested sections, demonstrating how to organize multiple related actions with icons.', - codeblock: { - title: 'Menu with nested sections', - tabs: [ - { - code: './examples/settings-menu.html', - language: 'html', - }, - - { - code: './examples/settings-menu.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '350px', - }, - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/basic-menu.html b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/basic-menu.html deleted file mode 100644 index 4db91c4c47..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/basic-menu.html +++ /dev/null @@ -1,7 +0,0 @@ -Product actions - - - Edit product - Duplicate product - Archive product - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/basic-menu.jsx b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/basic-menu.jsx deleted file mode 100644 index 0f941b0c03..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/basic-menu.jsx +++ /dev/null @@ -1,9 +0,0 @@ -<> - Product actions - - - Edit product - Duplicate product - Archive product - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/customer-actions-menu.jsx b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/customer-actions-menu.jsx deleted file mode 100644 index 78075f10af..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/customer-actions-menu.jsx +++ /dev/null @@ -1,18 +0,0 @@ -<> - Edit customer - - - - Edit customer - Send email - View orders - - - Reset password - Disable account - - - Delete customer - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/default.jsx deleted file mode 100644 index f56576b87a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/default.jsx +++ /dev/null @@ -1,11 +0,0 @@ -<> - Edit customer - - - Merge customer - Request customer data - - Delete customer - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/icon-only-trigger.html b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/icon-only-trigger.html new file mode 100644 index 0000000000..aacf8ba74e --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/icon-only-trigger.html @@ -0,0 +1,13 @@ + + + + Edit product + Duplicate product + Archive product + Delete product + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-icons.html b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-icons.html deleted file mode 100644 index 7f31330ef2..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-icons.html +++ /dev/null @@ -1,8 +0,0 @@ -More actions - - - Edit product - Duplicate product - Archive product - Delete product - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-icons.jsx b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-icons.jsx deleted file mode 100644 index 57c897c4cd..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-icons.jsx +++ /dev/null @@ -1,14 +0,0 @@ -<> - - More actions - - - - Edit product - Duplicate product - Archive product - - Delete product - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-links-and-disabled-items.jsx b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-links-and-disabled-items.jsx deleted file mode 100644 index 8b00b58c58..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-links-and-disabled-items.jsx +++ /dev/null @@ -1,13 +0,0 @@ -<> - Options - - - - View product page - - Unavailable action - - Download report - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-sections.jsx b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-sections.jsx deleted file mode 100644 index 4ef7ca082b..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/menu-with-sections.jsx +++ /dev/null @@ -1,15 +0,0 @@ -<> - Bulk actions - - - - Edit selected - Duplicate selected - Archive selected - - - Export as CSV - Print barcodes - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/settings-menu.jsx b/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/settings-menu.jsx deleted file mode 100644 index beb5e6d6b2..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Menu/examples/settings-menu.jsx +++ /dev/null @@ -1,19 +0,0 @@ -<> - - Settings - - - - - Profile settings - Security - Billing information - - - Store settings - Payment providers - Shipping rates - - Sign out - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Modal.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Modal.d.ts index 59d00f1abc..df93219efe 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Modal.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Modal.d.ts @@ -22,7 +22,8 @@ export type CallbackEventListener = (event: CallbackEvent): void; }) | null; -/** Used when an element does not have children. */ +/** Used when an element does not have children. * @publicDocs + */ export interface PreactBaseElementProps { /** Assigns a unique key to this element. */ key?: preact.Key; @@ -31,12 +32,14 @@ export interface PreactBaseElementProps { /** Assigns this element to a parent's slot. */ slot?: Lowercase; } -/** Used when an element has children. */ +/** Used when an element has children. * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } - +/** * @publicDocs + */ export type RequiredAlignedModalProps = Required; export interface ModalProps extends Pick< @@ -61,7 +64,8 @@ export interface ModalProps declare class PolarisCustomElement extends PreactCustomElement { constructor(renderImpl: Omit); } - +/** * @publicDocs + */ export interface PreactOverlayControlProps extends Pick { /** diff --git a/packages/ui-extensions/src/surfaces/admin/components/Modal/Modal.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Modal/Modal.ab.doc.ts deleted file mode 100644 index f2110ab98b..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Modal/Modal.ab.doc.ts +++ /dev/null @@ -1,211 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Modal'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/modal.png', - isVisualComponent: true, - subSections: [ - { - title: 'Usage', - type: 'Generic' as const, - anchorLink: 'usage', - sectionContent: `Modals are closed by default and should be triggered by a button using the \`commandFor\` attribute. The button's \`commandFor\` value should match the modal's \`id\`.`, - }, - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Focusing on a specific task or piece of information -- Completing a flow that needs dedicated attention -- Confirming a significant action before proceeding -- Viewing information that's only temporarily relevant`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use for focused, specific tasks that require merchants to make a decision or acknowledge critical information -- Include a prominent and clear call to action -- Don't nest modals (avoid launching one modal from another) -- Have concise and descriptive title and button text -- Use thoughtfully and sparingly—don't create unnecessary interruptions -- Use as a last resort for important decisions, not for contextual tools or actions that could happen on the page directly`, - }, - { - title: 'Content guidelines', - type: 'Generic' as const, - anchorLink: 'content-guidelines', - sectionContent: `- Use 1-3 word titles in sentence case without punctuation -- Keep body content to 1-2 short sentences -- For destructive actions, explain the consequences -- Use clear action verbs for buttons (e.g., "Delete", "Edit") instead of vague language like "Yes" or "OK"`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Modal', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'ModalEvents', - }, - { - title: 'Slots', - description: '', - type: 'ModalSlots', - }, - ], - defaultExample: { - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - customStyles: { - minHeight: '300px', - }, - }, - { - code: './examples/default.jsx', - language: 'preview-jsx', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Simple modal with heading and basic content for displaying information. Click the button to open the modal.', - codeblock: { - title: 'Basic modal', - tabs: [ - { - code: './examples/basic-modal.html', - language: 'preview', - customStyles: { - minHeight: '300px', - }, - }, - { - code: './examples/basic-modal.jsx', - language: 'preview-jsx', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - { - description: - 'Modal with primary and secondary action buttons. Click the button to open the confirmation modal.', - codeblock: { - title: 'Modal with actions', - tabs: [ - { - code: './examples/confirmation-modal-with-actions.html', - language: 'preview', - customStyles: { - minHeight: '300px', - }, - }, - { - code: './examples/confirmation-modal-with-actions.jsx', - language: 'preview-jsx', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - { - description: - 'Modal containing form fields demonstrating how to structure input fields within a modal. Click the button to open the modal.', - codeblock: { - title: 'Modal with form fields', - tabs: [ - { - code: './examples/form-modal.html', - language: 'preview', - customStyles: { - minHeight: '300px', - }, - }, - { - code: './examples/form-modal.jsx', - language: 'preview-jsx', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - { - description: - 'Demonstrates various modal sizes for different content requirements. Click each button to see different modal sizes.', - codeblock: { - title: 'Different modal sizes', - tabs: [ - { - code: './examples/different-modal-sizes.html', - language: 'preview', - customStyles: { - minHeight: '300px', - }, - }, - { - code: './examples/different-modal-sizes.jsx', - language: 'preview-jsx', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - { - description: - 'Modal with no padding for full-width content. Click to view the modal.', - codeblock: { - title: 'Modal without padding', - tabs: [ - { - code: './examples/modal-without-padding.html', - language: 'preview', - customStyles: { - minHeight: '300px', - }, - }, - { - code: './examples/modal-without-padding.jsx', - language: 'preview-jsx', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/MoneyField.d.ts b/packages/ui-extensions/src/surfaces/admin/components/MoneyField.d.ts index 2dc8001507..83709220ae 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/MoneyField.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/MoneyField.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -9,59 +9,213 @@ import type { TextFieldProps, MoneyFieldProps$1, - PreactCustomElement, - RenderImpl, + ComponentChildren, } from './shared.d.ts'; +/** + * An event with a strongly-typed currentTarget property for a specific HTML element. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event listener is attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * A callback function that receives a strongly-typed event for a specific HTML element. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; +/** + * The React-style event callback props for form field components. + * @publicDocs + */ export interface FieldReactProps { + /** + * A callback that's invoked when the user makes any changes in the field. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). + */ onInput?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). + */ onChange?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). + */ onFocus?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). + */ onBlur?: ((event: CallbackEvent) => void) | null; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles for the component's shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a Preact component in a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's Preact elements into the shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * The properties from an event that indicate how the user activated an element. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was held down when the event occurred. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on macOS) was held down when the event occurred. + */ + metaKey: boolean; + /** + * Whether the Control key was held down when the event occurred. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed when the event occurred. A value of 0 indicates the primary button (usually left), 1 indicates the middle button, and 2 indicates the secondary button (usually right). + */ + button: number; +} +/** + * The options for influencing a programmatic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The base properties for an input element that participates in form submission. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** @private */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the user makes any changes in the field. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the field is disabled, disallowing any interaction. + * + * @default false + */ accessor disabled: PreactInputProps['disabled']; + /** + * An identifier for the field. + */ accessor id: PreactInputProps['id']; + /** + * An identifier for the field that's unique within the nearest containing form. + */ accessor name: PreactInputProps['name']; + /** + * The current value for the field. + */ get value(): PreactInputProps['value']; set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * The base properties for form field elements that support labels, validation, and autocomplete. + * @publicDocs + */ export type PreactFieldProps = PreactInputProps & Required< @@ -81,10 +235,10 @@ export type PreactFieldProps = * 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 + * autofill, but you don't have any more semantic information on the intended * contents. * - * When set to `off`, you are indicating that this field contains sensitive + * When set to `off`, you're 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 @@ -99,20 +253,58 @@ export type PreactFieldProps = */ autocomplete: Autocomplete; }; +/** @private */ declare class PreactFieldElement extends PreactInputElement implements PreactFieldProps { + /** + * A callback that's invoked when the field loses focus. + */ accessor onblur: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the field receives focus. + */ accessor onfocus: CallbackEventListener<'input'>; + /** + * A hint as to the intended content of the field for autocomplete purposes. + */ accessor autocomplete: PreactFieldProps['autocomplete']; + /** + * The initial value for the field when it's first rendered. + */ accessor defaultValue: PreactFieldProps['defaultValue']; + /** + * Additional descriptive text to display below the field that provides supplementary information. + */ accessor details: PreactFieldProps['details']; + /** + * An error message to display below the field, indicating validation failure or other issues. + */ accessor error: PreactFieldProps['error']; + /** + * The text label to display for the field, describing what the user should enter. + */ accessor label: PreactFieldProps['label']; + /** + * Controls the visibility of the label for accessibility purposes. + */ accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility']; + /** + * The placeholder text that's displayed inside the field when it's empty, providing a hint about expected input. + */ accessor placeholder: PreactFieldProps['placeholder']; + /** + * Whether the field is read-only, preventing edits while still allowing focus and selection. + * + * @default false + */ accessor readOnly: PreactFieldProps['readOnly']; + /** + * Whether the field must be filled out before form submission. + * + * @default false + */ accessor required: PreactFieldProps['required']; /** * Global keyboard event handlers for things like key bindings typically @@ -141,19 +333,42 @@ declare class PreactFieldElement constructor(renderImpl: RenderImpl); } +/** + * The required properties from the `MoneyFieldProps$1` definition. This type ensures all properties from the shared definition are marked as required. + * @publicDocs + */ export type RequiredMoneyFieldProps = Required; +/** + * The properties for the money field component. These properties configure a specialized input field for entering monetary amounts with automatic currency formatting, decimal handling, and range validation. + * @publicDocs + */ export interface MoneyFieldProps extends Omit, Pick { + /** + * The current monetary value for the field, represented as a string. + */ value: Required['value']; } +/** + * The money field custom element class that renders a monetary input field in the Shopify admin interface. This component allows merchants to enter currency amounts with automatic formatting, decimal precision, and validation against minimum and maximum values. + */ declare class MoneyField extends PreactFieldElement implements MoneyFieldProps { + /** + * The maximum monetary value allowed in the field. + */ accessor max: MoneyFieldProps['max']; + /** + * The minimum monetary value allowed in the field. + */ accessor min: MoneyFieldProps['min']; + /** + * The current monetary value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string representing the amount in the store's currency. + */ get value(): string; set value(value: string); constructor(); @@ -172,6 +387,10 @@ declare module 'preact' { } declare const tagName = 's-money-field'; +/** + * The JSX props for the money field component. These properties extend `MoneyFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact. + * @publicDocs + */ export interface MoneyFieldJSXProps extends Partial, FieldReactProps, diff --git a/packages/ui-extensions/src/surfaces/admin/components/MoneyField/MoneyField.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/MoneyField/MoneyField.doc.ts deleted file mode 100644 index 7dac278079..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/MoneyField/MoneyField.doc.ts +++ /dev/null @@ -1,142 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/MoneyField'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/moneyfield.png', - isVisualComponent: true, - definitions: [ - { - title: 'Properties', - description: '', - type: 'MoneyField', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'MoneyFieldEvents', - }, - ], - defaultExample: { - image: 'moneyfield-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple money field with a label, initial value, and numeric constraints.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Showcases a money field with explicit minimum and maximum value limits, and a detailed description for user guidance.', - codeblock: { - title: 'With validation limits', - tabs: [ - { - code: './examples/with-validation-limits.html', - language: 'html', - }, - - { - code: './examples/with-validation-limits.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates a money field demonstrating basic error handling and validation.', - codeblock: { - title: 'Basic field', - tabs: [ - { - code: './examples/basic-field.html', - language: 'html', - }, - - { - code: './examples/basic-field.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Displays multiple money fields in a vertical stack, showing how to integrate multiple currency inputs in a form with varied details and constraints.', - codeblock: { - title: 'Currency formatting with form integration', - tabs: [ - { - code: './examples/currency-formatting-with-form-integration.html', - language: 'html', - }, - - { - code: './examples/currency-formatting-with-form-integration.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - { - title: 'Form validation', - examples: [ - { - description: - 'Interactive example showing real-time validation with min/max limits and dynamic error messages.', - codeblock: { - title: 'Money field validation', - tabs: [ - { - code: './examples/validation-example.jsx', - language: 'preview-jsx', - layout: 'formWrapper', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/MoneyField/examples/basic-field.html b/packages/ui-extensions/src/surfaces/admin/components/MoneyField/examples/basic-field.html index 2c886abd8e..c6e6baff08 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/MoneyField/examples/basic-field.html +++ b/packages/ui-extensions/src/surfaces/admin/components/MoneyField/examples/basic-field.html @@ -1,6 +1,5 @@ diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField.d.ts b/packages/ui-extensions/src/surfaces/admin/components/NumberField.d.ts index 99ae4321e8..270ef3a9de 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/NumberField.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/NumberField.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -9,59 +9,213 @@ import type { TextFieldProps, NumberFieldProps$1, - PreactCustomElement, - RenderImpl, + ComponentChildren, } from './shared.d.ts'; +/** + * An event with a strongly-typed currentTarget property for a specific HTML element. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event listener is attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * A callback function that receives a strongly-typed event for a specific HTML element. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; +/** + * The React-style event callback props for form field components. + * @publicDocs + */ export interface FieldReactProps { + /** + * A callback that's invoked when the user makes any changes in the field. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). + */ onInput?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). + */ onChange?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). + */ onFocus?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). + */ onBlur?: ((event: CallbackEvent) => void) | null; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles for the component's shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a Preact component in a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's Preact elements into the shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * The properties from an event that indicate how the user activated an element. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was held down when the event occurred. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on macOS) was held down when the event occurred. + */ + metaKey: boolean; + /** + * Whether the Control key was held down when the event occurred. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed when the event occurred. A value of 0 indicates the primary button (usually left), 1 indicates the middle button, and 2 indicates the secondary button (usually right). + */ + button: number; +} +/** + * The options for influencing a programmatic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The base properties for an input element that participates in form submission. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** @private */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the user makes any changes in the field. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the field is disabled, disallowing any interaction. + * + * @default false + */ accessor disabled: PreactInputProps['disabled']; + /** + * An identifier for the field. + */ accessor id: PreactInputProps['id']; + /** + * An identifier for the field that's unique within the nearest containing form. + */ accessor name: PreactInputProps['name']; + /** + * The current value for the field. + */ get value(): PreactInputProps['value']; set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * The base properties for form field elements that support labels, validation, and autocomplete. + * @publicDocs + */ export type PreactFieldProps = PreactInputProps & Required< @@ -81,10 +235,10 @@ export type PreactFieldProps = * 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 + * autofill, but you don't have any more semantic information on the intended * contents. * - * When set to `off`, you are indicating that this field contains sensitive + * When set to `off`, you're 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 @@ -99,20 +253,58 @@ export type PreactFieldProps = */ autocomplete: Autocomplete; }; +/** @private */ declare class PreactFieldElement extends PreactInputElement implements PreactFieldProps { + /** + * A callback that's invoked when the field loses focus. + */ accessor onblur: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the field receives focus. + */ accessor onfocus: CallbackEventListener<'input'>; + /** + * A hint as to the intended content of the field for autocomplete purposes. + */ accessor autocomplete: PreactFieldProps['autocomplete']; + /** + * The initial value for the field when it's first rendered. + */ accessor defaultValue: PreactFieldProps['defaultValue']; + /** + * Additional descriptive text to display below the field that provides supplementary information. + */ accessor details: PreactFieldProps['details']; + /** + * An error message to display below the field, indicating validation failure or other issues. + */ accessor error: PreactFieldProps['error']; + /** + * The text label to display for the field, describing what the user should enter. + */ accessor label: PreactFieldProps['label']; + /** + * Controls the visibility of the label for accessibility purposes. + */ accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility']; + /** + * The placeholder text that's displayed inside the field when it's empty, providing a hint about expected input. + */ accessor placeholder: PreactFieldProps['placeholder']; + /** + * Whether the field is read-only, preventing edits while still allowing focus and selection. + * + * @default false + */ accessor readOnly: PreactFieldProps['readOnly']; + /** + * Whether the field must be filled out before form submission. + * + * @default false + */ accessor required: PreactFieldProps['required']; /** * Global keyboard event handlers for things like key bindings typically @@ -141,6 +333,10 @@ declare class PreactFieldElement constructor(renderImpl: RenderImpl); } +/** + * The properties for the number field component. These properties configure a specialized input field for entering numeric values with support for validation, formatting, range constraints, and optimized mobile input modes. + * @publicDocs + */ export interface NumberFieldProps extends Omit< PreactFieldProps['autocomplete']>, @@ -152,20 +348,50 @@ export interface NumberFieldProps 'inputMode' | 'max' | 'min' | 'prefix' | 'step' | 'suffix' > > { + /** + * The current value for the field, represented as a string. + */ value: Required['value']; } +/** + * The number field custom element class that renders a numeric input field in the Shopify admin interface. This component allows merchants to enter numbers with automatic validation and prefix/suffix display. + */ declare class NumberField extends PreactFieldElement implements NumberFieldProps { + /** + * The current numeric value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value should be a numeric string (decimal or integer). + */ get value(): string; set value(value: string); + /** + * The input mode hint for mobile keyboards. Available values include: + * - `numeric`: Shows a numeric keypad optimized for entering numbers + * - `decimal`: Shows a numeric keypad with decimal point support + * - `tel`: Shows a telephone keypad + */ accessor inputMode: NumberFieldProps['inputMode']; + /** + * The granularity that the value must adhere to, or the keyword `any`. This controls the increment/decrement step size. + */ accessor step: NumberFieldProps['step']; + /** + * The maximum numeric value allowed in the field. + */ accessor max: NumberFieldProps['max']; + /** + * The minimum numeric value allowed in the field. + */ accessor min: NumberFieldProps['min']; + /** + * Text or content to display before the user's input, such as a currency symbol. + */ accessor prefix: NumberFieldProps['prefix']; + /** + * Text or content to display after the user's input, such as a unit of measurement. + */ accessor suffix: NumberFieldProps['suffix']; constructor(); } @@ -183,6 +409,10 @@ declare module 'preact' { } declare const tagName = 's-number-field'; +/** + * The JSX props for the number field component. These properties extend `NumberFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact. + * @publicDocs + */ export interface NumberFieldJSXProps extends Partial, Pick, diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField/NumberField.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/NumberField/NumberField.doc.ts deleted file mode 100644 index 09b23e8811..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/NumberField/NumberField.doc.ts +++ /dev/null @@ -1,104 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/NumberField'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/numberfield.png', - isVisualComponent: true, - definitions: [ - { - title: 'Properties', - description: '', - type: 'NumberField', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'NumberFieldEvents', - }, - ], - defaultExample: { - image: 'numberfield-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple number field for entering order quantity with a predefined range and step value.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates a number field for entering product prices with currency prefix and suffix, using decimal input mode.', - codeblock: { - title: 'With prefix and suffix', - tabs: [ - { - code: './examples/with-prefix-and-suffix.html', - language: 'html', - }, - - { - code: './examples/with-prefix-and-suffix.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Showcases multiple number fields for different use cases: inventory tracking, percentage discount, and shipping weight, demonstrating various input modes and configurations.', - codeblock: { - title: 'Multiple examples', - tabs: [ - { - code: './examples/multiple-examples.html', - language: 'html', - }, - - { - code: './examples/multiple-examples.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/basic-usage.html deleted file mode 100644 index a9fa9724ef..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/basic-usage.html +++ /dev/null @@ -1,7 +0,0 @@ - diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/basic-usage.jsx deleted file mode 100644 index 7c9a9e8e46..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/basic-usage.jsx +++ /dev/null @@ -1,7 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/default.jsx deleted file mode 100644 index 8c60ba91e2..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/default.jsx +++ /dev/null @@ -1,8 +0,0 @@ - diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/disabled-and-read-only.html b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/disabled-and-read-only.html new file mode 100644 index 0000000000..906710e07a --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/disabled-and-read-only.html @@ -0,0 +1,15 @@ + + + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/multiple-examples.html b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/multiple-examples.html deleted file mode 100644 index 6658f6881b..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/multiple-examples.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/multiple-examples.jsx b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/multiple-examples.jsx deleted file mode 100644 index 76cd3e106a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/multiple-examples.jsx +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/with-error-state.html b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/with-error-state.html new file mode 100644 index 0000000000..15a101c68d --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/with-error-state.html @@ -0,0 +1,9 @@ + diff --git a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/with-prefix-and-suffix.jsx b/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/with-prefix-and-suffix.jsx deleted file mode 100644 index bb0aed5cd7..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/NumberField/examples/with-prefix-and-suffix.jsx +++ /dev/null @@ -1,9 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Option.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Option.d.ts index 594cc066bc..e93938a1ee 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Option.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Option.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,41 +6,153 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - OptionProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, OptionProps$1} from './shared.d.ts'; +/** + * Properties for rendering a single option within a select dropdown that users can choose from. + * @publicDocs + */ export interface OptionProps extends Required< Pick > {} -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * CSS styles that will be applied to the component's shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * Configuration for rendering a custom element with Preact and shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * A function that renders the component's content inside the shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * CSS styles that will be applied to the shadow DOM. + */ + styles?: Styles; +}; +/** + * Information about modifier keys and mouse buttons that were active during an interaction. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was held down during the interaction. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on PC) was held down during the interaction. + */ + metaKey: boolean; + /** + * Whether the Control key was held down during the interaction. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the interaction. + */ + button: number; } +/** + * Options for influencing how a programmatic click behaves. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -/** Used when an element does not have children. */ + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** Used when an element does not have children. * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** Used when an element has children. * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class Option extends PolarisCustomElement implements OptionProps { +/** + * A single option within a select dropdown that users can choose. + */ +declare class Option extends PreactCustomElement implements OptionProps { + /** + * Whether the option is currently selected. + */ accessor selected: OptionProps['selected']; + /** + * Whether the option should be selected when it's first rendered. + */ accessor defaultSelected: OptionProps['defaultSelected']; + /** + * The value that's submitted with the form when this option is selected. + */ accessor value: OptionProps['value']; + /** + * Whether the option is disabled and can't be selected. + */ accessor disabled: OptionProps['disabled']; constructor(); } @@ -58,11 +170,15 @@ declare module 'preact' { } declare const tagName = 's-option'; +/** + * Properties for using the option component in JSX with React-style props. + * @publicDocs + */ export interface OptionJSXProps extends Partial, Pick { /** - * The content to use as the label. + * The content that's used as the option label, displayed in the dropdown list. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/OptionGroup.d.ts b/packages/ui-extensions/src/surfaces/admin/components/OptionGroup.d.ts index d28f7fe76f..48a02513bc 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/OptionGroup.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/OptionGroup.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,40 +6,146 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - OptionGroupProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, OptionGroupProps$1} from './shared.d.ts'; +/** + * Properties for rendering a group of related options within a select dropdown, organized under a shared label. + * @publicDocs + */ export interface OptionGroupProps extends Required> {} -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * CSS styles that will be applied to the component's shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * Configuration for rendering a custom element with Preact and shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * A function that renders the component's content inside the shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * CSS styles that will be applied to the shadow DOM. + */ + styles?: Styles; +}; +/** + * Information about modifier keys and mouse buttons that were active during an interaction. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was held down during the interaction. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on PC) was held down during the interaction. + */ + metaKey: boolean; + /** + * Whether the Control key was held down during the interaction. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the interaction. + */ + button: number; +} +/** + * Options for influencing how a programmatic click behaves. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; } +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -/** Used when an element does not have children. */ + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** Used when an element does not have children. * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** Used when an element has children. * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } +/** + * A group of related options within a select dropdown, displayed with a label. + */ declare class OptionGroup - extends PolarisCustomElement + extends PreactCustomElement implements OptionGroupProps { + /** + * Whether all options in the group are disabled and can't be selected. + */ accessor disabled: OptionGroupProps['disabled']; + /** + * The text that describes what this group of options represents. + */ accessor label: OptionGroupProps['label']; constructor(); } @@ -58,13 +164,15 @@ declare module 'preact' { } declare const tagName = 's-option-group'; +/** + * Properties for using the option group component in JSX with React-style props. + * @publicDocs + */ export interface OptionGroupJSXProps extends Partial, Pick { /** - * The options a user can select from. - * - * Accepts `Option` components. + * The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList.d.ts b/packages/ui-extensions/src/surfaces/admin/components/OrderedList.d.ts index 06cfd1271e..ac6838ca9a 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/OrderedList.d.ts @@ -1,40 +1,145 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - OrderedListProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, OrderedListProps$1} from './shared.d.ts'; +/** + * The properties for the ordered list component. These properties define a numbered list of items with automatic numbering and proper list semantics. + * @publicDocs + */ export interface OrderedListProps extends OrderedListProps$1 {} -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with a shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow DOM content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * Optional CSS styles to apply to the shadow DOM. + */ + styles?: Styles; +}; +/** + * An object that represents the state of modifier keys and mouse button + * during an activation event like a click. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta (Command on Mac, Windows key on PC) key was pressed. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * Options for customizing click behavior on an element. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; } +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -/** Used when an element does not have children. */ + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } +/** + * A custom element for displaying a numbered list of items with automatic numbering and proper list semantics. Use ordered list when the sequence or order of items matters, such as instructions, rankings, or step-by-step processes. + */ declare class OrderedList - extends PolarisCustomElement + extends PreactCustomElement implements OrderedListProps { constructor(); @@ -54,13 +159,15 @@ declare module 'preact' { } declare const tagName = 's-ordered-list'; +/** + * The JSX properties for the ordered list component. These properties define how an ordered list is rendered in Preact or JSX. + * @publicDocs + */ export interface OrderedListJSXProps extends Partial, Pick { /** - * The items of the OrderedList. - * - * Only ListItems are accepted. + * The items in the ordered list. Only list item components are accepted. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/OrderedList.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/OrderedList.doc.ts deleted file mode 100644 index 3d89a2545b..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/OrderedList.doc.ts +++ /dev/null @@ -1,139 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/OrderedList'; -import listItemSharedContent from '../../../../docs/shared/components/ListItem'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/ordered-list.png', - isVisualComponent: true, - subSections: [ - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use to break up related content and improve scannability -- Phrase items consistently (start each with a noun or verb) -- Start each item with a capital letter -- Don't use commas or semicolons at the end of lines`, - }, - ], - definitions: [ - { - title: 'Slots', - description: '', - type: 'OrderedListSlots', - }, - { - title: listItemSharedContent.name, - description: listItemSharedContent.description, - type: 'ListItem', - }, - { - title: 'Slots', - description: '', - type: 'ListItemSlots', - }, - ], - defaultExample: { - image: 'ordered-list-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple ordered list with three sequential steps.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows an ordered list with multiple steps in a workflow process.', - codeblock: { - title: 'Order processing steps', - tabs: [ - { - code: './examples/order-processing-steps.html', - language: 'html', - }, - - { - code: './examples/order-processing-steps.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates a nested ordered list with sub-steps within main steps.', - codeblock: { - title: 'Product setup instructions', - tabs: [ - { - code: './examples/product-setup-instructions.html', - language: 'html', - }, - - { - code: './examples/product-setup-instructions.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Displays a complex nested list with multiple levels of sub-steps.', - codeblock: { - title: 'Fulfillment process', - tabs: [ - { - code: './examples/fulfillment-process.html', - language: 'html', - }, - - { - code: './examples/fulfillment-process.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/basic-usage.html deleted file mode 100644 index 1ddc3cb5cd..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/basic-usage.html +++ /dev/null @@ -1,5 +0,0 @@ - - Add products to your catalog - Set up payment methods - Configure shipping zones - diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/basic-usage.jsx deleted file mode 100644 index 1ddc3cb5cd..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/basic-usage.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - Add products to your catalog - Set up payment methods - Configure shipping zones - diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/default.html b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/default.html index 2152768a53..1ddc3cb5cd 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/default.html +++ b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/default.html @@ -1,5 +1,5 @@ - Red shirt - Green shirt - Blue shirt + Add products to your catalog + Set up payment methods + Configure shipping zones diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/default.jsx deleted file mode 100644 index ab50934e5a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/default.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - Red shirt - Green shirt - Blue shirt - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.html b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.html deleted file mode 100644 index b91650d75c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.html +++ /dev/null @@ -1,18 +0,0 @@ - - - Process payment - - Verify card details - Apply discount codes - Calculate taxes - - - - Prepare shipment - - Print shipping label - Pack items securely - - - Update customer with tracking info - diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.jsx b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.jsx deleted file mode 100644 index b91650d75c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/fulfillment-process.jsx +++ /dev/null @@ -1,18 +0,0 @@ - - - Process payment - - Verify card details - Apply discount codes - Calculate taxes - - - - Prepare shipment - - Print shipping label - Pack items securely - - - Update customer with tracking info - diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.html b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.html deleted file mode 100644 index 479ebfc87a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.html +++ /dev/null @@ -1,8 +0,0 @@ - - Review order details and customer information - Verify payment and billing address - Check inventory availability for all items - Generate fulfillment labels and packing slip - Package items and update tracking information - Send shipment confirmation to customer - diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.jsx b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.jsx deleted file mode 100644 index 479ebfc87a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/order-processing-steps.jsx +++ /dev/null @@ -1,8 +0,0 @@ - - Review order details and customer information - Verify payment and billing address - Check inventory availability for all items - Generate fulfillment labels and packing slip - Package items and update tracking information - Send shipment confirmation to customer - diff --git a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/product-setup-instructions.jsx b/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/product-setup-instructions.jsx deleted file mode 100644 index 73664bf663..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/OrderedList/examples/product-setup-instructions.jsx +++ /dev/null @@ -1,13 +0,0 @@ - - - Create product listing with title and description - - Add high-quality product images - Set SEO title and meta description - - - Configure pricing and inventory tracking - Set up product variants (size, color, material) - Enable inventory tracking and set stock levels - Review and publish product to storefront - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Page.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Page.d.ts index 932409757e..8d307eb57e 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Page.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Page.d.ts @@ -18,7 +18,8 @@ export interface PageProps inlineSize: Extract; } -/** Used when an element does not have children. */ +/** Used when an element does not have children. * @publicDocs + */ export interface PreactBaseElementProps { /** Assigns a unique key to this element. */ key?: preact.Key; @@ -27,7 +28,8 @@ export interface PreactBaseElementProps { /** Assigns this element to a parent's slot. */ slot?: Lowercase; } -/** Used when an element has children. */ +/** Used when an element has children. * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Page/Page.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Page/Page.ab.doc.ts deleted file mode 100644 index 61c19ce6ed..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Page/Page.ab.doc.ts +++ /dev/null @@ -1,177 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Page'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - requires: '', - thumbnail: '/assets/templated-apis-screenshots/admin/components/page.png', - isVisualComponent: true, - subSections: [ - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Always provide a title that describes the current page -- Include breadcrumbs when the page is part of a flow -- Include page actions in the header only if they are relevant to the entire page -- Include no more than one primary action and 3 secondary actions per page -- Don't include any actions at the bottom of the page`, - }, - { - title: 'Content guidelines', - type: 'Generic' as const, - anchorLink: 'content-guidelines', - sectionContent: `- Use sentence case and avoid unnecessary words -- Don't include punctuation like periods or exclamation marks -- Page titles should clearly communicate the page purpose -- Page actions should use a verb or verb + noun phrase (e.g., "Create store", "Edit product")`, - }, - ], - definitions: [ - { - title: 'Properties', - description: 'Use as the outer wrapper of a page', - type: 'Page', - }, - { - title: 'Slots', - description: '', - type: 'PageSlots', - }, - ], - defaultExample: { - image: 'ordered-list-default.png', - codeblock: { - title: '', - tabs: [ - { - code: './examples/default.html', - language: 'html', - layout: 'none', - }, - { - code: './examples/default.jsx', - language: 'preview-jsx', - layout: 'none', - }, - ], - }, - }, - related: [], - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Shows a page with a clear heading and descriptive text, illustrating how to use the page component with a title.', - codeblock: { - title: 'Page with heading', - tabs: [ - { - code: './examples/page-with-heading.html', - language: 'html', - layout: 'none', - }, - { - code: './examples/page-with-heading.jsx', - language: 'preview-jsx', - layout: 'none', - }, - ], - }, - }, - { - description: - 'Illustrates a page with a small inline size, ideal for focused, compact content like settings or forms with minimal information.', - codeblock: { - title: 'Small inline size for focused content', - tabs: [ - { - code: './examples/small-inline-size-for-focused-content.html', - language: 'html', - layout: 'none', - }, - { - code: './examples/small-inline-size-for-focused-content.jsx', - language: 'preview-jsx', - layout: 'none', - customStyles: { - minHeight: '400px', - }, - }, - ], - }, - }, - { - description: - 'Demonstrates a page with a large inline size, perfect for displaying broader content like analytics or dashboards with multiple information sections.', - codeblock: { - title: 'Large inline size for wide content', - tabs: [ - { - code: './examples/large-inline-size-for-wide-content.html', - language: 'html', - layout: 'none', - }, - { - code: './examples/large-inline-size-for-wide-content.jsx', - language: 'preview-jsx', - layout: 'none', - customStyles: { - minHeight: '400px', - }, - }, - ], - }, - }, - { - description: - 'Shows a page with breadcrumb navigation and a descriptive heading, helping users understand their location in the navigation hierarchy.', - codeblock: { - title: 'Page with breadcrumbs and title', - tabs: [ - { - code: './examples/page-with-breadcrumbs-and-title.html', - language: 'html', - layout: 'none', - }, - { - code: './examples/page-with-breadcrumbs-and-title.jsx', - language: 'preview-jsx', - layout: 'none', - }, - ], - }, - }, - { - description: - 'Demonstrates a page with a primary action button and secondary action buttons, showing how to provide main and related actions alongside the page heading.', - codeblock: { - title: 'Page with primary and secondary actions', - tabs: [ - { - code: './examples/page-with-secondary-actions.html', - language: 'html', - layout: 'none', - }, - { - code: './examples/page-with-secondary-actions.jsx', - language: 'preview-jsx', - layout: 'none', - customStyles: { - minHeight: '400px', - }, - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Paragraph.d.ts index 3b3812bfd3..380678507d 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Paragraph.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,13 +6,12 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - ParagraphProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, ParagraphProps$1} from './shared.d.ts'; +/** + * The properties for the paragraph component. These properties define blocks of text content with consistent spacing and styling for readable body copy. + * @publicDocs + */ export interface ParagraphProps extends Required< Pick< @@ -25,55 +24,184 @@ export interface ParagraphProps | 'lineClamp' > > { + /** + * The semantic tone that's applied to the paragraph text, which changes its color to convey meaning. + * + * - `info`: Informational content or helpful tips (blue). + * - `success`: Positive outcomes or successful states (green). + * - `warning`: Important warnings about potential issues (orange). + * - `critical`: Urgent problems or destructive actions (red). + * - `caution`: Advisory notices that need attention (yellow). + */ + tone: Extract< + ParagraphProps$1['tone'], + 'info' | 'success' | 'caution' | 'warning' | 'critical' + >; + /** + * The color of the paragraph text. Available options: + * - `'base'` - The default text color. + * - `'subdued'` - A lighter text color for secondary information. + */ color: Extract; } -/** Used when an element does not have children. */ +/** + * A string containing CSS styles. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with a shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow DOM content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * Optional CSS styles to apply to the shadow DOM. + */ + styles?: Styles; +}; +/** + * An object that represents the state of modifier keys and mouse button + * during an activation event like a click. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta (Command on Mac, Windows key on PC) key was pressed. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * Options for customizing click behavior on an element. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); -} - -declare abstract class ParagraphBase - extends PolarisCustomElement - implements - Pick< - ParagraphProps, - | 'fontVariantNumeric' - | 'lineClamp' - | 'tone' - | 'color' - | 'dir' - | 'accessibilityVisibility' - > -{ +/** + * A custom element for displaying blocks of text content with consistent spacing and styling for readable body copy. Use Paragraph to render longer text content with proper line height and spacing between paragraphs. + */ +declare class Paragraph extends PreactCustomElement implements ParagraphProps { + /** + * The numeric font variant for the paragraph text. + */ accessor fontVariantNumeric: ParagraphProps['fontVariantNumeric']; + /** + * The maximum number of lines to display before the text is truncated with an ellipsis. + */ accessor lineClamp: ParagraphProps['lineClamp']; - accessor tone: Extract< - ParagraphProps['tone'], - 'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical' - >; + /** + * The semantic tone that's applied to the paragraph text, which changes its color to convey meaning. + * + * - `info`: Informational content or helpful tips (blue). + * - `success`: Positive outcomes or successful states (green). + * - `warning`: Important warnings about potential issues (orange). + * - `critical`: Urgent problems or destructive actions (red). + * - `caution`: Advisory notices that need attention (yellow). + */ + accessor tone: ParagraphProps['tone']; + /** + * The color of the paragraph text. + */ accessor color: ParagraphProps['color']; + /** + * The text direction (left-to-right or right-to-left). + */ accessor dir: ParagraphProps['dir']; + /** + * The visibility of the element to assistive technologies. + */ accessor accessibilityVisibility: ParagraphProps['accessibilityVisibility']; - constructor(renderImpl: RenderImpl); -} - -declare class Paragraph extends ParagraphBase implements ParagraphProps { constructor(); } declare global { @@ -91,11 +219,15 @@ declare module 'preact' { } declare const tagName = 's-paragraph'; +/** + * The JSX properties for the paragraph component. These properties define how a paragraph is rendered in Preact or JSX. + * @publicDocs + */ export interface ParagraphJSXProps extends Partial, Pick { /** - * The content of the Paragraph. + * The content of the paragraph. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/Paragraph.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/Paragraph.doc.ts deleted file mode 100644 index 00f5b94b45..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/Paragraph.doc.ts +++ /dev/null @@ -1,195 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Paragraph'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/paragraph.png', - isVisualComponent: true, - subSections: [ - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Displaying text content in a paragraph format. -- Grouping elements with the same style. For instance, icons inside a paragraph will automatically adopt the paragraph's tone.`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use short paragraphs to make your content scannable. -- Use plain and clear terms. -- Don't use jargon or technical language. -- Don't use different terms to describe the same thing. -- Don't duplicate content.`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Paragraph', - }, - { - title: 'Slots', - description: '', - type: 'ParagraphSlots', - }, - ], - defaultExample: { - image: 'paragraph-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple paragraph with default styling, showing how to use the paragraph component for standard text content.', - codeblock: { - title: 'Basic Usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates how to apply different tones and color variations to convey different types of information, such as informational and success messages.', - codeblock: { - title: 'With Tone and Color', - tabs: [ - { - code: './examples/with-tone-and-color.html', - language: 'html', - }, - - { - code: './examples/with-tone-and-color.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how to limit the number of lines displayed using the lineClamp prop, which truncates long text with an ellipsis after the specified number of lines.', - codeblock: { - title: 'Line Clamping', - tabs: [ - { - code: './examples/line-clamping.html', - language: 'html', - }, - - { - code: './examples/line-clamping.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates the use of tabular numbers with fontVariantNumeric, ensuring consistent alignment and readability for numerical data.', - codeblock: { - title: 'Tabular Numbers', - tabs: [ - { - code: './examples/tabular-numbers.html', - language: 'html', - }, - - { - code: './examples/tabular-numbers.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates right-to-left (RTL) text rendering, showing how the paragraph component supports internationalization and different text directions.', - codeblock: { - title: 'RTL Support', - tabs: [ - { - code: './examples/rtl-support.html', - language: 'html', - }, - - { - code: './examples/rtl-support.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how to use the accessibilityVisibility prop to create text that is exclusively available to screen readers, improving accessibility for assistive technologies.', - codeblock: { - title: 'Screen Reader Text', - tabs: [ - { - code: './examples/screen-reader-text.html', - language: 'html', - }, - - { - code: './examples/screen-reader-text.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Showcases various tone and color combinations for different administrative messages, illustrating how paragraph can communicate different types of information in a user interface.', - codeblock: { - title: 'Admin UI Patterns', - tabs: [ - { - code: './examples/admin-ui-patterns.html', - language: 'html', - }, - - { - code: './examples/admin-ui-patterns.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.html b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.html deleted file mode 100644 index 23040da732..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.html +++ /dev/null @@ -1,21 +0,0 @@ - - - Payment successfully processed and order confirmed. - - - - Inventory levels are running low for this product. - - - - This order requires immediate attention due to shipping delays. - - - - Customer requested gift wrapping for this order. - - - - Review shipping address before processing. - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.jsx b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.jsx deleted file mode 100644 index d90e52a2c5..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/admin-ui-patterns.jsx +++ /dev/null @@ -1,21 +0,0 @@ - - - Payment successfully processed and order confirmed. - - - - Inventory levels are running low for this product. - - - - This order requires immediate attention due to shipping delays. - - - - Customer requested gift wrapping for this order. - - - - Review shipping address before processing. - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/basic-usage.html deleted file mode 100644 index a797d12083..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/basic-usage.html +++ /dev/null @@ -1,3 +0,0 @@ - - Track inventory across all your retail locations in real-time. - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/basic-usage.jsx deleted file mode 100644 index 9873834e90..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/basic-usage.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Track inventory across all your retail locations in real-time. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/default.jsx deleted file mode 100644 index 9361bc9e9e..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/default.jsx +++ /dev/null @@ -1,4 +0,0 @@ - - Shopify POS is the easiest way to sell your products in person. Available for - iPad, iPhone, and Android. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/line-clamping.jsx b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/line-clamping.jsx deleted file mode 100644 index cbf5f78163..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/line-clamping.jsx +++ /dev/null @@ -1,8 +0,0 @@ - - - Premium organic cotton t-shirt featuring sustainable manufacturing - processes, ethically sourced materials, and carbon-neutral shipping. - Available in multiple colors and sizes with customization options for your - brand. - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/rtl-support.jsx b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/rtl-support.jsx deleted file mode 100644 index 381fcd05d6..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/rtl-support.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - محتوى النص باللغة العربية - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/screen-reader-text.jsx b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/screen-reader-text.jsx deleted file mode 100644 index 451cf99ffc..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/screen-reader-text.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Table sorted by date, newest first. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/subdued-color.html b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/subdued-color.html new file mode 100644 index 0000000000..9b4ad1485b --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/subdued-color.html @@ -0,0 +1,3 @@ + + Changes will take effect the next time the customer visits your store. + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/tabular-numbers.jsx b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/tabular-numbers.jsx deleted file mode 100644 index 590b9c7336..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/tabular-numbers.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Orders: 1,234 Revenue: $45,678.90 Customers: 890 - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.html b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.html index f503cfb998..de66e17ae2 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.html @@ -3,7 +3,19 @@ Your order will be processed within 2-3 business days. - + Payment successfully processed. + + + Review shipping address before processing. + + + + Inventory levels are running low for this product. + + + + This order requires immediate attention due to shipping delays. + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.jsx b/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.jsx deleted file mode 100644 index d25bd114b7..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Paragraph/examples/with-tone-and-color.jsx +++ /dev/null @@ -1,9 +0,0 @@ - - - Your order will be processed within 2-3 business days. - - - - Payment successfully processed. - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/PasswordField.d.ts b/packages/ui-extensions/src/surfaces/admin/components/PasswordField.d.ts index 65ce07404d..804b72dca8 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/PasswordField.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/PasswordField.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -9,59 +9,220 @@ import type { TextFieldProps, PasswordFieldProps$1, - PreactCustomElement, - RenderImpl, + ComponentChildren, } from './shared.d.ts'; +/** + * An event object with a strongly-typed currentTarget property that references the specific HTML element type. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The DOM element that the event listener is attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * An event listener function or null that receives a typed callback event. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { + /** + * The callback function that's invoked when the event fires. + */ (event: CallbackEvent): void; }) | null; +/** + * The React-style event handler props for form field components. + * @publicDocs + */ export interface FieldReactProps { + /** + * A callback that's triggered when the field's value changes as the user types. + */ onInput?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the field's value changes and the field loses focus. + */ onChange?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the field receives focus. + */ onFocus?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the field loses focus. + */ onBlur?: ((event: CallbackEvent) => void) | null; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles to be applied to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a custom element with a shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * A function that renders the component's shadow DOM content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object containing information about keyboard and mouse button states during an activation event. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta (Command on Mac, Windows key on PC) key was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the event. + */ + button: number; +} +/** + * The options for programmatically triggering a click event on an element. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The required props for input elements that all form controls must implement. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** + * The base class for form input elements that participate in form submission. + */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { + /** @private */ static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * The callback that's triggered when the input value changes and the field loses focus. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * The callback that's triggered when the input value changes as the user types. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the input is disabled and can't be interacted with. + */ accessor disabled: PreactInputProps['disabled']; + /** + * The unique identifier for the input element. + */ accessor id: PreactInputProps['id']; + /** + * The name of the input, used when submitting form data. + */ accessor name: PreactInputProps['name']; + /** + * The current value of the input. + */ get value(): PreactInputProps['value']; + /** + * The current value of the input. + */ set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * The common props shared by all form field components in the admin UI. + * @publicDocs + */ export type PreactFieldProps = PreactInputProps & Required< @@ -78,17 +239,17 @@ export type PreactFieldProps = > > & { /** - * A hint as to the intended content of the field. + * A hint about the intended content of the field for browser autofill. * * 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 + * autofill, but you don't have any more semantic information on the intended * contents. * - * When set to `off`, you are indicating that this field contains sensitive + * When set to `off`, you're 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. + * Alternatively, you can provide a value which describes the + * specific data you'd like to be entered into this field during autofill. * * @see Learn more about the set of {@link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens|autocomplete values} supported in browsers. * @@ -99,27 +260,63 @@ export type PreactFieldProps = */ autocomplete: Autocomplete; }; +/** + * The base class for form field elements that includes label, error, and validation support. + */ declare class PreactFieldElement extends PreactInputElement implements PreactFieldProps { + /** + * The callback that's triggered when the field loses focus. + */ accessor onblur: CallbackEventListener<'input'>; + /** + * The callback that's triggered when the field receives focus. + */ accessor onfocus: CallbackEventListener<'input'>; + /** + * A hint about the intended content of the field for browser autofill. + */ accessor autocomplete: PreactFieldProps['autocomplete']; + /** + * The initial value of the field when it's first rendered. + */ accessor defaultValue: PreactFieldProps['defaultValue']; + /** + * The additional text displayed below the field to provide helpful context. + */ accessor details: PreactFieldProps['details']; + /** + * The error message displayed when the field validation fails. + */ accessor error: PreactFieldProps['error']; + /** + * The text label displayed above the field. + */ accessor label: PreactFieldProps['label']; + /** + * The visibility of the label for accessibility purposes. Available values: `hidden`, `visible`. + */ accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility']; + /** + * The hint text displayed inside the field when it's empty. + */ accessor placeholder: PreactFieldProps['placeholder']; + /** + * Whether the field is read-only and can't be edited by the user. + */ accessor readOnly: PreactFieldProps['readOnly']; + /** + * Whether the field must be filled out before the form can be submitted. + */ accessor required: PreactFieldProps['required']; /** * Global keyboard event handlers for things like key bindings typically * ignore keystrokes originating from within input elements. Unfortunately, - * these never account for a Custom Element being the input element. + * these never account for a custom element being the input element. * - * To fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement + * To fix this, we spoof getAttribute and hasAttribute to make a PreactFieldElement * appear as a contentEditable "input" when it contains a focused input element. * @private technically not private, but we don't want to expose this as public API */ @@ -129,8 +326,8 @@ declare class PreactFieldElement */ hasAttribute(qualifiedName: string): boolean; /** - * Checks if the shadow tree contains a focused input (input, textarea, select, ). - * Note: this does _not_ return true for focussed non-field form elements like buttons. + * Checks if the shadow tree contains a focused input (input, textarea, select, contentEditable element). + * Note: this doesn't return true for focused non-field form elements like buttons. * @private */ get isContentEditable(): boolean; @@ -141,6 +338,10 @@ declare class PreactFieldElement constructor(renderImpl: RenderImpl); } +/** + * The properties for the password field component. These properties configure a secure input field that collects sensitive password input from merchants with masked characters. + * @publicDocs + */ export type PasswordFieldProps = PreactFieldProps< Required['autocomplete'] > & @@ -163,12 +364,26 @@ export type PasswordFieldProps = PreactFieldProps< > >; +/** + * The password field custom element class that renders a password input field in the Shopify admin interface. This component allows merchants to enter passwords securely with characters automatically masked for privacy. + */ declare class PasswordField extends PreactFieldElement implements PasswordFieldProps { + /** + * The maximum number of characters allowed in the password. + */ accessor maxLength: PasswordFieldProps['maxLength']; + /** + * The minimum number of characters required in the password. + */ accessor minLength: PasswordFieldProps['minLength']; + /** + * The current password value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The value is masked in the UI for security. + */ + get value(): string; + set value(value: string); constructor(); } declare global { @@ -185,6 +400,10 @@ declare module 'preact' { } declare const tagName = 's-password-field'; +/** + * The JSX props for the password field component. These properties extend `PasswordFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact. + * @publicDocs + */ export interface PasswordFieldJSXProps extends Partial, Pick, diff --git a/packages/ui-extensions/src/surfaces/admin/components/PasswordField/PasswordField.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/PasswordField/PasswordField.doc.ts deleted file mode 100644 index 93b9b90c94..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/PasswordField/PasswordField.doc.ts +++ /dev/null @@ -1,141 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/PasswordField'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/passwordfield.png', - isVisualComponent: true, - definitions: [ - { - title: 'Properties', - description: '', - type: 'PasswordField', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'PasswordFieldEvents', - }, - ], - defaultExample: { - image: 'password-field-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a basic password field with a label, name, and required validation. Sets a minimum length of 8 characters and configures autocomplete for a new password.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows a password field in an error state, displaying a custom error message when the password does not meet the minimum length requirement.', - codeblock: { - title: 'With error state', - tabs: [ - { - code: './examples/with-error-state.html', - language: 'html', - }, - - { - code: './examples/with-error-state.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates a password field with additional details providing guidance about password creation requirements.', - codeblock: { - title: 'With helper text', - tabs: [ - { - code: './examples/with-helper-text.html', - language: 'html', - }, - - { - code: './examples/with-helper-text.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how the password field can be integrated into a form alongside other input fields, such as an email field, to create a complete login or registration form.', - codeblock: { - title: 'In form layout', - tabs: [ - { - code: './examples/in-form-layout.html', - language: 'html', - }, - - { - code: './examples/in-form-layout.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates a password field with dynamic password strength validation, showing real-time feedback on password complexity requirements.', - codeblock: { - title: 'With password strength requirements', - tabs: [ - { - code: './examples/with-password-strength-requirements.html', - language: 'html', - }, - - { - code: './examples/with-password-strength-requirements.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Popover/Popover.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Popover/Popover.ab.doc.ts deleted file mode 100644 index 817c901ec5..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Popover/Popover.ab.doc.ts +++ /dev/null @@ -1,160 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Popover'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - category: 'Polaris web components', - thumbnail: '/assets/templated-apis-screenshots/admin/components/popover.png', - isVisualComponent: true, - subSections: [ - { - title: 'Usage', - type: 'Generic' as const, - anchorLink: 'usage', - sectionContent: `Popovers are closed by default and should be triggered by a button using the \`commandFor\` attribute. The button's \`commandFor\` value should match the popover's \`id\`. The popover's position is determined by the button that triggers it.`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use for secondary or less important information and actions since they're hidden until triggered -- Contain actions that share a relationship to each other -- Be triggered by a clearly labeled default or tertiary button`, - }, - { - title: 'Content guidelines', - type: 'Generic' as const, - anchorLink: 'content-guidelines', - sectionContent: `- Use clear action verbs in the {verb}+{noun} format (e.g., "Create order", "Edit HTML") -- Avoid unnecessary words like "the", "an", or "a"`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Popover', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'PopoverEvents', - }, - { - title: 'Slots', - description: '', - type: 'PopoverSlots', - }, - ], - defaultExample: { - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '300px', - }, - }, - { - code: './examples/default.html', - language: 'preview', - layout: 'alignStart', - customStyles: { - minHeight: '300px', - }, - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Popover displaying admin notifications such as new orders, inventory alerts, and payment confirmations, demonstrating how popovers can show informational content without cluttering the main interface.', - codeblock: { - title: 'Popover with notifications', - tabs: [ - { - code: './examples/notifications.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '350px', - }, - }, - { - code: './examples/notifications.html', - language: 'preview', - layout: 'alignStart', - customStyles: { - minHeight: '350px', - }, - }, - ], - }, - }, - { - description: - 'Popover containing a choice list and action button demonstrating how popovers can be used for settings and configuration interfaces.', - codeblock: { - title: 'Popover with choice list', - tabs: [ - { - code: './examples/table-display-options.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '400px', - }, - }, - { - code: './examples/table-display-options.html', - language: 'preview', - layout: 'alignStart', - customStyles: { - minHeight: '400px', - }, - }, - ], - }, - }, - { - description: - 'Popover displaying detailed inventory information using Box padding instead of Section, demonstrating an alternative layout approach for data-focused content.', - codeblock: { - title: 'Popover with inventory details', - tabs: [ - { - code: './examples/inventory-stock-details.jsx', - language: 'preview-jsx', - layout: 'alignStart', - customStyles: { - minHeight: '350px', - }, - }, - { - code: './examples/inventory-stock-details.html', - language: 'preview', - layout: 'alignStart', - customStyles: { - minHeight: '350px', - }, - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/PrintActionExtensionComponents.ts b/packages/ui-extensions/src/surfaces/admin/components/PrintActionExtensionComponents.ts index 0d224e1072..9ff8bdf90c 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/PrintActionExtensionComponents.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/PrintActionExtensionComponents.ts @@ -1,5 +1,8 @@ import {StandardComponents} from './StandardComponents'; +/** + * The components available for building print action extensions. Includes all standard components plus the admin print action component required for print action setup. + */ export type PrintActionExtensionComponents = | StandardComponents | 'AdminPrintAction'; diff --git a/packages/ui-extensions/src/surfaces/admin/components/QueryContainer.d.ts b/packages/ui-extensions/src/surfaces/admin/components/QueryContainer.d.ts index 9116709d73..cbaf96ca3b 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/QueryContainer.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/QueryContainer.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,42 +6,152 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - QueryContainerProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, QueryContainerProps$1} from './shared.d.ts'; -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); -} - -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; +} +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The properties you can set on a query container component. + * @publicDocs + */ export interface QueryContainerProps extends Required> {} +/** + * A component that sets up a container query context, which lets child elements style themselves based on the container's size instead of the viewport size. + */ declare class QueryContainer - extends PolarisCustomElement + extends PreactCustomElement implements QueryContainerProps { + /** + * The name of the container, which you can reference in CSS container queries. + */ accessor containerName: QueryContainerProps['containerName']; /** @private */ static globalStylesApplied: boolean; + /** + * Creates a new QueryContainer instance. + */ constructor(); } declare global { @@ -58,12 +168,19 @@ declare module 'preact' { } } +/** + * The custom element tag name for the query container component. + */ declare const tagName = 's-query-container'; +/** + * The JSX properties you can set on a query container component. + * @publicDocs + */ export interface QueryContainerJSXProps extends Partial, Pick { /** - * The content of the container. + * The content to display inside the container. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/QueryContainer/QueryContainer.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/QueryContainer/QueryContainer.doc.ts deleted file mode 100644 index 74eda9742e..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/QueryContainer/QueryContainer.doc.ts +++ /dev/null @@ -1,72 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/QueryContainer'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - requires: '', - thumbnail: - '/assets/templated-apis-screenshots/admin/components/querycontainer.png', - isVisualComponent: true, - definitions: [ - { - title: 'Properties', - description: - 'Use to define an element as a containment context, enabling child components or styles to adapt based on the container’s size.', - type: 'QueryContainer', - }, - { - title: 'Slots', - description: '', - type: 'QueryContainerSlots', - }, - ], - defaultExample: { - image: 'ordered-list-default.png', - codeblock: { - title: '', - tabs: [ - { - code: './examples/default.html', - language: 'html', - layout: 'none', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - layout: 'none', - }, - ], - }, - }, - related: [], - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates the simplest way to use QueryContainer, wrapping content with a named container context.', - codeblock: { - title: 'Basic Usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/QueryContainer/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/QueryContainer/examples/basic-usage.jsx deleted file mode 100644 index 5f7d0482af..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/QueryContainer/examples/basic-usage.jsx +++ /dev/null @@ -1,17 +0,0 @@ -<> - - - - Padding is different depending on the container size - - - - - - - - Padding is different depending on the container size - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/QueryContainer/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/QueryContainer/examples/default.jsx deleted file mode 100644 index 74394c6bb9..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/QueryContainer/examples/default.jsx +++ /dev/null @@ -1,8 +0,0 @@ - - - Padding is applied when the inline-size > 500px - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/SearchField.d.ts b/packages/ui-extensions/src/surfaces/admin/components/SearchField.d.ts index c840ed5080..f7ecc9aef7 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/SearchField.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/SearchField.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,61 +6,213 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - TextFieldProps, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {TextFieldProps, ComponentChildren} from './shared.d.ts'; +/** + * An event that includes a strongly-typed reference to the element that triggered it. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event handler was attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * A function that handles events for a specific element type, or null if no handler is set. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; +/** + * Event handlers for field interactions in React-style syntax. + * @publicDocs + */ export interface FieldReactProps { + /** + * A callback that's triggered when the field's value changes as the user types. + */ onInput?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the field's value changes and the field loses focus. + */ onChange?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the field receives focus. + */ onFocus?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the field loses focus. + */ onBlur?: ((event: CallbackEvent) => void) | null; } -/** Used when an element does not have children. */ +/** Used when an element does not have children. * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * CSS styles that will be applied to the component's shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * Configuration for rendering a custom element with Preact and shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * A function that renders the component's content inside the shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * CSS styles that will be applied to the shadow DOM. + */ + styles?: Styles; +}; +/** + * Information about modifier keys and mouse buttons that were active during an interaction. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was held down during the interaction. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on PC) was held down during the interaction. + */ + metaKey: boolean; + /** + * Whether the Control key was held down during the interaction. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the interaction. + */ + button: number; +} +/** + * Options for influencing how a programmatic click behaves. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The core properties that all input elements need to function within forms. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** + * Base class for input elements that participate in form submission. + */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { + /** + * Indicates that this element can participate in form submission. + */ static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * A callback that's triggered when the input's value changes and the field loses focus. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * A callback that's triggered when the input's value changes as the user types. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the input is disabled and can't be interacted with. + */ accessor disabled: PreactInputProps['disabled']; + /** + * A unique identifier for the input element. + */ accessor id: PreactInputProps['id']; + /** + * The name that identifies this input when the form is submitted. + */ accessor name: PreactInputProps['name']; + /** + * The current value of the input. + */ get value(): PreactInputProps['value']; set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * Properties that are common to all text-based field components. + * @publicDocs + */ export type PreactFieldProps = PreactInputProps & Required< @@ -98,20 +250,56 @@ export type PreactFieldProps = */ autocomplete: Autocomplete; }; +/** + * Base class for text-based field elements that support labels, errors, and other form field features. + */ declare class PreactFieldElement extends PreactInputElement implements PreactFieldProps { + /** + * A callback that's triggered when the field loses focus. + */ accessor onblur: CallbackEventListener<'input'>; + /** + * A callback that's triggered when the field receives focus. + */ accessor onfocus: CallbackEventListener<'input'>; + /** + * A hint about what kind of information should go in the field for autofill purposes. + */ accessor autocomplete: PreactFieldProps['autocomplete']; + /** + * The initial value that the field should display when it's first rendered. + */ accessor defaultValue: PreactFieldProps['defaultValue']; + /** + * Additional text to provide context or guidance for the input. + */ accessor details: PreactFieldProps['details']; + /** + * An error message that's displayed below the field when validation fails. + */ accessor error: PreactFieldProps['error']; + /** + * The text that describes what the field is for. + */ accessor label: PreactFieldProps['label']; + /** + * Controls whether the label is visible to all users or only to screen readers. + */ accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility']; + /** + * Text that appears in the field when it's empty to provide a hint about what to enter. + */ accessor placeholder: PreactFieldProps['placeholder']; + /** + * Whether the field can be edited by the user. + */ accessor readOnly: PreactFieldProps['readOnly']; + /** + * Whether the field must be filled in before the form can be submitted. + */ accessor required: PreactFieldProps['required']; /** * Global keyboard event handlers for things like key bindings typically @@ -140,6 +328,10 @@ declare class PreactFieldElement constructor(renderImpl: RenderImpl); } +/** + * Properties for rendering a search field that lets users enter search queries with validation constraints and autofill support. + * @publicDocs + */ export type SearchFieldProps = PreactFieldProps< /** * @default 'on' @@ -165,16 +357,26 @@ export type SearchFieldProps = PreactFieldProps< > >; -declare abstract class SearchFieldBase +/** + * A search field that lets users enter search queries with a search-specific input type. + */ +declare class SearchField extends PreactFieldElement - implements Pick + implements SearchFieldProps { + /** + * The maximum number of characters that can be entered in the field. + */ accessor maxLength: SearchFieldProps['maxLength']; + /** + * The minimum number of characters that must be entered for the field to be valid. + */ accessor minLength: SearchFieldProps['minLength']; - constructor(renderImpl: RenderImpl); -} - -declare class SearchField extends SearchFieldBase implements SearchFieldProps { + /** + * The current search query value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. + */ + get value(): string; + set value(value: string); constructor(); } declare global { @@ -191,6 +393,10 @@ declare module 'preact' { } declare const tagName = 's-search-field'; +/** + * Props for using the search field component in JSX with React-style event handlers. + * @publicDocs + */ export interface SearchFieldJSXProps extends Partial, Pick, diff --git a/packages/ui-extensions/src/surfaces/admin/components/SearchField/SearchField.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/SearchField/SearchField.doc.ts deleted file mode 100644 index 4ea34d633d..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/SearchField/SearchField.doc.ts +++ /dev/null @@ -1,131 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/SearchField'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/searchfield.png', - isVisualComponent: true, - subSections: [ - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- The SearchField automatically includes a clear button when text is entered, so you should not create your own clear button`, - }, - ], - definitions: [ - { - title: 'SearchField', - description: - 'A search input field that allows users to enter a search term.', - type: 'SearchField', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'SearchFieldEvents', - }, - ], - defaultExample: { - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a standard search input field for product discovery, with a clear label, name, and placeholder text to guide user interaction.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - "Illustrates how the search field handles and displays an error state when no results are found or when there's a search-related issue.", - codeblock: { - title: 'With error state', - tabs: [ - { - code: './examples/with-error-state.html', - language: 'html', - }, - - { - code: './examples/with-error-state.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates the appearance and behavior of a search field when it is disabled, preventing user interaction.', - codeblock: { - title: 'Disabled state', - tabs: [ - { - code: './examples/disabled-state.html', - language: 'html', - }, - - { - code: './examples/disabled-state.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Showcases a search field with minimum and maximum character length constraints, providing guidance on input requirements.', - codeblock: { - title: 'With character limits', - tabs: [ - { - code: './examples/with-character-limits.html', - language: 'html', - }, - - { - code: './examples/with-character-limits.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/basic-usage.html deleted file mode 100644 index d1b5267d0e..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/basic-usage.html +++ /dev/null @@ -1,5 +0,0 @@ - diff --git a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/basic-usage.jsx deleted file mode 100644 index 4e3f17248a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/basic-usage.jsx +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/default.jsx deleted file mode 100644 index 2b0051a01e..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/default.jsx +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/disabled-state.jsx b/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/disabled-state.jsx deleted file mode 100644 index 049ea94fe8..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/disabled-state.jsx +++ /dev/null @@ -1,6 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/with-character-limits.jsx b/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/with-character-limits.jsx deleted file mode 100644 index 60972f6928..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/with-character-limits.jsx +++ /dev/null @@ -1,7 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/with-error-state.jsx b/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/with-error-state.jsx deleted file mode 100644 index 55ddd40013..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/SearchField/examples/with-error-state.jsx +++ /dev/null @@ -1,6 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Section.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Section.d.ts index f6ac0cf8d6..ee569d8643 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Section.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Section.d.ts @@ -1,62 +1,184 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - SectionProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, SectionProps$1} from './shared.d.ts'; +/** + * A version of the section properties with all fields required. + * @publicDocs + */ export type RequiredSectionProps = Required; +/** + * The properties for the section component. A section groups related content together with an optional heading, providing semantic structure and visual separation. + * @publicDocs + */ export interface SectionProps extends Pick< RequiredSectionProps, 'accessibilityLabel' | 'heading' | 'padding' > { + /** + * An accessibility label for screen readers that provides additional context when the heading isn't descriptive enough on its own. + */ accessibilityLabel: RequiredSectionProps['accessibilityLabel']; + /** + * The heading text that appears at the top of the section, helping users understand what content the section contains. + */ heading: RequiredSectionProps['heading']; + /** + * Whether the section has padding around its content. Set to `true` to add padding, or `false` to remove it. + */ padding: RequiredSectionProps['padding']; } -/** Used when an element does not have children. */ +/** + * A string containing CSS styles for a custom element. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with Preact. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The optional CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * An interface representing the properties of an activation event, such as a click or keypress. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta key (Command on Mac, Windows key on PC) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * The options for triggering a synthetic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * The base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +/** + * An abstract base class for creating custom elements that render with Preact. + */ +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); -} - -declare abstract class SectionBase - extends PolarisCustomElement - implements SectionProps -{ - constructor(renderImpl: RenderImpl); +/** + * A section is a container that groups related content together with an optional heading. + */ +declare class Section extends PreactCustomElement implements SectionProps { + constructor(); /** @private */ connectedCallback(): void; + /** + * The accessibility label for screen readers. + */ accessor accessibilityLabel: SectionProps['accessibilityLabel']; + /** + * The heading text for the section. + */ accessor heading: SectionProps['heading']; + /** + * Whether the section has padding. + */ accessor padding: SectionProps['padding']; } - -declare class Section extends SectionBase implements SectionProps { - constructor(); -} declare global { interface HTMLElementTagNameMap { [tagName]: Section; @@ -71,11 +193,15 @@ declare module 'preact' { } declare const tagName = 's-section'; +/** + * The properties for the section component when it's used in JSX. + * @publicDocs + */ export interface SectionJSXProps extends Partial, Pick { /** - * The content of the Section. + * The child elements to render inside the section. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Section/Section.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Section/Section.doc.ts deleted file mode 100644 index 9d1ff2dcf8..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Section/Section.doc.ts +++ /dev/null @@ -1,140 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Section'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - isVisualComponent: true, - thumbnail: '/assets/templated-apis-screenshots/admin/components/section.png', - subSections: [ - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Organizing your page in a logical structure based on nesting levels. -- Creating consistency across pages.`, - }, - { - title: 'Considerations', - type: 'Generic' as const, - anchorLink: 'considerations', - sectionContent: `- When adding headings inside sections they automatically use a specific style, which helps keep the content organized and clear. -- Built-in spacing is added between nested sections, as well as between heading and content. -- **Level 1:** Display as responsive cards with background color, rounded corners, and shadow effects. Includes outer padding that can be removed when content like \`s-table\` needs to expand to the full width of the section. -- **Nested sections:** Don't have any background color or effects by default.`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Section', - }, - { - title: 'Slots', - description: '', - type: 'SectionSlots', - }, - ], - defaultExample: { - image: 'section-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - layout: 'page', - }, - { - code: './examples/default.jsx', - language: 'preview-jsx', - layout: 'page', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a level 1 section with a heading and multiple form fields. This example shows how sections provide visual hierarchy and structure for input elements.', - codeblock: { - title: 'Top-Level Section with Form Elements', - tabs: [ - { - code: './examples/top-level-section-with-form-elements.html', - language: 'html', - }, - - { - code: './examples/top-level-section-with-form-elements.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates how sections can be nested to create a hierarchical layout, with each nested section automatically adjusting its visual style. This example demonstrates the automatic visual leveling of nested sections.', - codeblock: { - title: 'Nested Sections with Visual Level Differences', - tabs: [ - { - code: './examples/nested-sections-with-visual-level-differences.html', - language: 'html', - }, - - { - code: './examples/nested-sections-with-visual-level-differences.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows how to add an accessibility label to a section, providing an additional hidden heading for screen readers while maintaining a visible heading.', - codeblock: { - title: 'Section with Accessibility Label', - tabs: [ - { - code: './examples/section-with-accessibility-label.html', - language: 'html', - }, - - { - code: './examples/section-with-accessibility-label.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates using a section with `padding="none"` to create a full-width layout, ideal for displaying tables or other content that requires edge-to-edge rendering.', - codeblock: { - title: 'Full-width Content Layout', - tabs: [ - { - code: './examples/full-width-content-layout.html', - language: 'html', - }, - - { - code: './examples/full-width-content-layout.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Section/examples/default.jsx deleted file mode 100644 index c060e77d13..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/default.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - View a summary of your online store’s performance. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/full-width-content-layout.jsx b/packages/ui-extensions/src/surfaces/admin/components/Section/examples/full-width-content-layout.jsx deleted file mode 100644 index 965484de61..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/full-width-content-layout.jsx +++ /dev/null @@ -1,18 +0,0 @@ - - - - Product - Price - Status - - - - Cotton t-shirt - $29.99 - - Active - - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/nested-sections-with-visual-level-differences.jsx b/packages/ui-extensions/src/surfaces/admin/components/Section/examples/nested-sections-with-visual-level-differences.jsx deleted file mode 100644 index eda71fad8a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/nested-sections-with-visual-level-differences.jsx +++ /dev/null @@ -1,23 +0,0 @@ - - {/* Level 1 section */} - - Order #1234 placed on January 15, 2024 - - {/* Level 2 section - nested with different visual treatment */} - - - - - {/* Level 3 section - further nested */} - - - - - - - {/* Another Level 2 section */} - - 2 items totaling $49.99 - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/section-with-accessibility-label.jsx b/packages/ui-extensions/src/surfaces/admin/components/Section/examples/section-with-accessibility-label.jsx deleted file mode 100644 index 1d5f100000..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/section-with-accessibility-label.jsx +++ /dev/null @@ -1,13 +0,0 @@ - - - Subtotal: $42.99 - Tax: $5.59 - Shipping: $1.41 - - Total: $49.99 - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/top-level-section-with-form-elements.jsx b/packages/ui-extensions/src/surfaces/admin/components/Section/examples/top-level-section-with-form-elements.jsx deleted file mode 100644 index 35dcafb4a7..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Section/examples/top-level-section-with-form-elements.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Select.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Select.d.ts index dd017fab2d..48728757c0 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Select.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Select.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -11,75 +11,228 @@ import type { TextFieldProps, IconProps$1, SelectProps$1, - PreactCustomElement, - RenderImpl, IconType, } from './shared.d.ts'; +/** + * An event that includes a strongly-typed reference to the element that triggered it. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event handler was attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * A function that handles events for a specific element type, or null if no handler is set. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; -/** Used when an element does not have children. */ +/** Used when an element does not have children. * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** Used when an element has children. * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * CSS styles that will be applied to the component's shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * Configuration for rendering a custom element with Preact and shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * A function that renders the component's content inside the shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * CSS styles that will be applied to the shadow DOM. + */ + styles?: Styles; +}; +/** + * Information about modifier keys and mouse buttons that were active during an interaction. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was held down during the interaction. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on PC) was held down during the interaction. + */ + metaKey: boolean; + /** + * Whether the Control key was held down during the interaction. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the interaction. + */ + button: number; +} +/** + * Options for influencing how a programmatic click behaves. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The core properties that all input elements need to function within forms. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** + * Base class for input elements that participate in form submission. + */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { + /** + * Indicates that this element can participate in form submission. + */ static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * A callback that's triggered when the input's value changes and the field loses focus. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * A callback that's triggered when the input's value changes as the user types. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the input is disabled and can't be interacted with. + */ accessor disabled: PreactInputProps['disabled']; + /** + * A unique identifier for the input element. + */ accessor id: PreactInputProps['id']; + /** + * The name that identifies this input when the form is submitted. + */ accessor name: PreactInputProps['name']; + /** + * The current value of the input. + */ get value(): PreactInputProps['value']; set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * Properties for displaying an icon within a component. + * @publicDocs + */ export interface IconProps - extends Required< - Pick + extends Pick< + IconProps$1, + 'type' | 'tone' | 'color' | 'size' | 'interestFor' > { /** * Specifies the type of icon that will be displayed. */ type: '' | IconType | 'empty'; + /** + * The semantic meaning of the icon, which affects its color. + */ tone: Extract< IconProps$1['tone'], 'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical' >; + /** + * The visual prominence of the icon. + */ color: Extract; + /** + * The size of the icon. + */ size: Extract; } +/** + * Properties for rendering a select dropdown that lets users choose one option from a list with optional icon and label customization. + * @publicDocs + */ export interface SelectProps extends Omit, Required< @@ -96,39 +249,59 @@ export interface SelectProps | 'labelAccessibilityVisibility' > > { + /** + * The value of the currently selected option, matching one of the `value` properties from the available options. + */ value: Required['value']; + /** + * An icon that's displayed at the start of the select field to provide visual context for the selection. + */ icon: IconProps['type']; } declare const usedFirstOptionSymbol: unique symbol; declare const hasInitialValueSymbol: unique symbol; -declare abstract class SelectBase - extends PreactInputElement - implements - Pick< - SelectProps, - | 'icon' - | 'details' - | 'error' - | 'label' - | 'placeholder' - | 'required' - | 'labelAccessibilityVisibility' - > -{ +/** + * A select dropdown that lets users choose one option from a list. + */ +declare class Select extends PreactInputElement implements SelectProps { + /** + * An icon that's displayed at the start of the select field. + */ accessor icon: SelectProps['icon']; + /** + * Additional text to provide context or guidance for the select. + */ accessor details: SelectProps['details']; + /** + * An error message that's displayed below the select when validation fails. + */ accessor error: SelectProps['error']; + /** + * The text that describes what the select is for. + */ accessor label: SelectProps['label']; + /** + * Text that appears in the select when no option is selected to provide a hint about what to choose. + */ accessor placeholder: SelectProps['placeholder']; + /** + * Whether an option must be selected before the form can be submitted. + */ accessor required: SelectProps['required']; + /** + * Controls whether the label is visible to all users or only to screen readers. + */ accessor labelAccessibilityVisibility: SelectProps['labelAccessibilityVisibility']; /** @private */ connectedCallback(): void; - /** @private */ + /** + * A lifecycle callback that fires when the component is removed from the DOM. Performs cleanup operations. + * @private + */ disconnectedCallback(): void; - constructor(renderImpl: RenderImpl); + constructor(); /** * used to determine if no value or defaultValue was set, in which case the first non-disabled option was used * @@ -140,15 +313,14 @@ declare abstract class SelectBase * @private */ [hasInitialValueSymbol]: boolean; + /** + * The value of the currently selected option. When setting this property programmatically, it updates which option appears selected in the dropdown. When reading it, you get the `value` attribute of the currently selected Option component. + */ get value(): string; set value(value: string); /** @private */ formResetCallback(): void; } - -declare class Select extends SelectBase implements SelectProps { - constructor(); -} declare global { interface HTMLElementTagNameMap { [tagName]: Select; @@ -163,18 +335,34 @@ declare module 'preact' { } declare const tagName = 's-select'; +/** + * Properties for using the select component in JSX with React-style event handlers. + * @publicDocs + */ export interface SelectJSXProps extends Partial, Pick { /** - * The options a user can select from. + * The selectable options displayed in the dropdown list. * - * Accepts `Option` and `OptionGroup` components. + * Accepts option components for individual selectable items, and option group components to organize related options into logical groups with labels. */ children?: ComponentChildren; + /** + * A callback that's triggered when the selected option changes and the select loses focus. + */ onChange?: (event: CallbackEvent) => void; + /** + * A callback that's triggered when the selected option changes as the user interacts with the dropdown. + */ onInput?: (event: CallbackEvent) => void; + /** + * A callback that's triggered when the select loses focus after the user interacts with it. + */ onBlur?: (event: CallbackEvent) => void; + /** + * A callback that's triggered when the select receives focus from the user. + */ onFocus?: (event: CallbackEvent) => void; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Select/Select.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Select/Select.doc.ts deleted file mode 100644 index 493940c150..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Select/Select.doc.ts +++ /dev/null @@ -1,185 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Select'; -import optionSharedContent from '../../../../docs/shared/components/Option'; -import optionGroupSharedContent from '../../../../docs/shared/components/OptionGroup'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/select.png', - isVisualComponent: true, - definitions: [ - { - title: 'Properties', - description: '', - type: 'Select', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'SelectEvents', - }, - { - title: 'Slots', - description: '', - type: 'SelectSlots', - }, - { - title: optionSharedContent.name, - description: optionSharedContent.description, - type: 'Option', - }, - { - title: 'Slots', - description: '', - type: 'OptionSlots', - }, - { - title: optionGroupSharedContent.name, - description: optionGroupSharedContent.description, - type: 'OptionGroup', - }, - { - title: 'Slots', - description: '', - type: 'OptionGroupSlots', - }, - ], - defaultExample: { - image: 'select-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'A simple select dropdown with pre-selected value for product sorting options.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Select dropdown with helpful placeholder text guiding category selection.', - codeblock: { - title: 'With placeholder', - tabs: [ - { - code: './examples/with-placeholder.html', - language: 'html', - }, - - { - code: './examples/with-placeholder.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Select in error state showing specific business context and actionable error message.', - codeblock: { - title: 'With error state', - tabs: [ - { - code: './examples/with-error-state.html', - language: 'html', - }, - - { - code: './examples/with-error-state.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Grouped select options organized by geographical regions for international shipping.', - codeblock: { - title: 'With option groups', - tabs: [ - { - code: './examples/with-option-groups.html', - language: 'html', - }, - - { - code: './examples/with-option-groups.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Select dropdown with sort icon for filtering order management views.', - codeblock: { - title: 'With icon', - tabs: [ - { - code: './examples/with-icon.html', - language: 'html', - }, - - { - code: './examples/with-icon.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Select in disabled state preventing user interaction with pre-selected value.', - codeblock: { - title: 'Disabled state', - tabs: [ - { - code: './examples/disabled-state.html', - language: 'html', - }, - - { - code: './examples/disabled-state.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Select/examples/with-error-state.html b/packages/ui-extensions/src/surfaces/admin/components/Select/examples/with-error-state.html index 25c1265d88..0edcd493a0 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Select/examples/with-error-state.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Select/examples/with-error-state.html @@ -4,7 +4,7 @@ required > Canada - United states + United States Mexico - United kingdom + United Kingdom diff --git a/packages/ui-extensions/src/surfaces/admin/components/Select/examples/with-option-groups.html b/packages/ui-extensions/src/surfaces/admin/components/Select/examples/with-option-groups.html index 79970bd4f5..71d1e3c499 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Select/examples/with-option-groups.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Select/examples/with-option-groups.html @@ -1,16 +1,16 @@ - + Canada - United states + United States Mexico - United kingdom + United Kingdom France Germany Italy - + Australia Japan Singapore diff --git a/packages/ui-extensions/src/surfaces/admin/components/Spinner.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Spinner.d.ts index 11ad58ba17..e9112a50cc 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Spinner.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Spinner.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,34 +6,148 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - SpinnerProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {SpinnerProps$1, ComponentChildren} from './shared.d.ts'; +/** + * The properties you can set on a spinner component. + * @publicDocs + */ export interface SpinnerProps extends Required> { + /** + * The size of the spinner. Use `base` for the standard size, `large` for a larger spinner, or `large-100` for a full-width large spinner. + */ size: Extract; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; +} +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class Spinner extends PolarisCustomElement implements SpinnerProps { +/** + * A component that displays an animated loading indicator to show that content is currently being processed. + */ +declare class Spinner extends PreactCustomElement implements SpinnerProps { + /** + * A label that describes the spinner for assistive technologies. + */ accessor accessibilityLabel: string; + /** + * The size of the spinner. + */ accessor size: SpinnerProps['size']; + /** + * Creates a new Spinner instance. + */ constructor(); } declare global { @@ -49,7 +163,14 @@ declare module 'preact' { } } +/** + * The custom element tag name for the spinner component. + */ declare const tagName = 's-spinner'; +/** + * The JSX properties you can set on a spinner component. + * @publicDocs + */ export interface SpinnerJSXProps extends Partial, Pick {} diff --git a/packages/ui-extensions/src/surfaces/admin/components/Spinner/Spinner.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Spinner/Spinner.doc.ts deleted file mode 100644 index fdab19836a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Spinner/Spinner.doc.ts +++ /dev/null @@ -1,107 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Spinner'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/spinner.png', - isVisualComponent: true, - subSections: [ - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use to notify merchants that their action is being processed -- Don't use for entire page loads`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Spinner', - }, - ], - defaultExample: { - image: 'spinner-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Standard loading spinner with accessibility label for screen readers.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Centered loading indicator with text in a section layout for content loading states.', - codeblock: { - title: 'Loading state in section', - tabs: [ - { - code: './examples/loading-state-in-section.html', - language: 'html', - }, - - { - code: './examples/loading-state-in-section.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Compact inline loading indicator for form submissions and quick actions.', - codeblock: { - title: 'Inline loading with text', - tabs: [ - { - code: './examples/inline-loading-with-text.html', - language: 'html', - }, - - { - code: './examples/inline-loading-with-text.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/basic-usage.html deleted file mode 100644 index 55f1b75f3b..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/basic-usage.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/basic-usage.jsx deleted file mode 100644 index 9e505ba0b7..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/basic-usage.jsx +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/default.jsx deleted file mode 100644 index 67a6c8bc33..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/default.jsx +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/inline-loading-with-text.jsx b/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/inline-loading-with-text.jsx deleted file mode 100644 index 3f2648a647..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/inline-loading-with-text.jsx +++ /dev/null @@ -1,4 +0,0 @@ - - - Saving... - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/loading-state-in-section.jsx b/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/loading-state-in-section.jsx deleted file mode 100644 index 69af27ede0..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/loading-state-in-section.jsx +++ /dev/null @@ -1,4 +0,0 @@ - - - Loading products... - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/spinner-sizes.html b/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/spinner-sizes.html new file mode 100644 index 0000000000..3508048ce4 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/Spinner/examples/spinner-sizes.html @@ -0,0 +1,5 @@ + + + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Stack.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Stack.d.ts index 18faf37d49..4d4b9aa3e4 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Stack.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Stack.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -16,10 +16,12 @@ import type { JustifyContentKeyword, AlignItemsKeyword, AlignContentKeyword, - PreactCustomElement, - RenderImpl, } from './shared.d.ts'; +/** + * A type that allows a value to be responsive using container query syntax. + * @publicDocs + */ export type MakeResponsive = T | `@container${string}`; /** * Makes a property's value potentially responsive. @@ -36,12 +38,21 @@ export type MakeResponsive = T | `@container${string}`; * margin: string | `@container${string}`; * padding: number | `@container${string}`; * } + * @publicDocs */ export type MakeResponsivePick = { [P in TProperty]: MakeResponsive; }; +/** + * A version of the box properties with all fields required. + * @publicDocs + */ export type RequiredBoxProps = Required; +/** + * The allowed border radius values for a box component. + * @publicDocs + */ export type BoxBorderRadii = Extract< RequiredBoxProps['borderRadius'], | 'none' @@ -53,10 +64,18 @@ export type BoxBorderRadii = Extract< | 'large-100' | 'large-200' >; +/** + * The allowed border style values for a box component. + * @publicDocs + */ export type BoxBorderStyles = Extract< RequiredBoxProps['borderStyle'], 'none' | 'solid' | 'dashed' | 'auto' >; +/** + * The box properties that support responsive values through container queries. + * @publicDocs + */ export type ResponsiveBoxProps = MakeResponsivePick< RequiredBoxProps, | 'padding' @@ -89,7 +108,7 @@ export interface BoxProps | 'overflow' > { /** - * Adjust the background of the component. + * The background color of the stack container. * * @default 'transparent' */ @@ -98,7 +117,10 @@ export interface BoxProps 'transparent' | 'base' | 'subdued' | 'strong' >; /** - * Adjust the width of the border. + * Controls the thickness of the border on all sides. + * + * When set, this overrides the width value specified in the `border` property. + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side. * * @default '' - meaning no override */ @@ -111,7 +133,10 @@ export interface BoxProps > | Extract; /** - * Adjust the style of the border. + * Controls the visual style of the border on all sides (solid, dashed, auto, or none). + * + * When set, this overrides the style value specified in the `border` property. + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side. * * @default '' - meaning no override */ @@ -119,7 +144,10 @@ export interface BoxProps | MaybeAllValuesShorthandProperty | Extract; /** - * Adjust the color of the border. + * Controls the color of the border using the design system's color scale. + * + * When set, this overrides the color value specified in the `border` property. + * Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed. * * @default '' - meaning no override */ @@ -128,13 +156,15 @@ export interface BoxProps 'subdued' | 'base' | 'strong' | '' >; /** - * Adjust the radius of the border. + * Controls the roundedness of the element's corners using the design system's radius scale. + * + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different radii per corner. Use this to create rounded corners or fully rounded elements. * * @default 'none' */ borderRadius: MaybeAllValuesShorthandProperty; /** - * Adjust the padding of all edges. + * The padding applied to all edges of the stack container. * * [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: * @@ -150,71 +180,71 @@ export interface BoxProps * * 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. + * `padding` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default 'none' */ padding: ResponsiveBoxProps['padding']; /** - * Adjust the block-padding. + * The padding applied to the block axis (top and bottom in horizontal writing modes). * * - `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. + * `paddingBlock` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlock: ResponsiveBoxProps['paddingBlock']; /** - * Adjust the block-start padding. + * The padding applied to the block-start edge (top in horizontal writing modes). * * 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. + * `paddingBlockStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlockStart: ResponsiveBoxProps['paddingBlockStart']; /** - * Adjust the block-end padding. + * The padding applied to the block-end edge (bottom in horizontal writing modes). * * 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. + * `paddingBlockEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingBlockEnd: ResponsiveBoxProps['paddingBlockEnd']; /** - * Adjust the inline padding. + * The padding applied to the inline axis (left and right in horizontal writing modes). * * - `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. + * `paddingInline` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingInline: ResponsiveBoxProps['paddingInline']; /** - * Adjust the inline-start padding. + * The padding applied to the inline-start edge (left in left-to-right languages). * * 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. + * `paddingInlineStart` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ paddingInlineStart: ResponsiveBoxProps['paddingInlineStart']; /** - * Adjust the inline-end padding. + * The padding applied to the inline-end edge (right in left-to-right languages). * * 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. + * `paddingInlineEnd` also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value. * * @default '' - meaning no override */ @@ -229,48 +259,65 @@ export interface BoxProps */ display: ResponsiveBoxProps['display']; /** - * Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). + * The vertical size of the stack in standard layouts (height in left-to-right or right-to-left writing modes). + * + * Block size adjusts based on the writing direction: in horizontal layouts, it controls the height; + * in vertical layouts, it controls the width. This ensures consistent behavior across different text directions. + * + * Learn more about [block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). * * @default 'auto' */ blockSize: SizeUnitsOrAuto; /** - * Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size). + * The [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size) (minimum height in horizontal writing modes) of the stack container. * * @default '0' */ minBlockSize: SizeUnits; /** - * Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size). + * The [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size) (maximum height in horizontal writing modes) of the stack container. * * @default 'none' */ maxBlockSize: SizeUnitsOrNone; /** - * Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size). + * The [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size) (width in horizontal writing modes) of the stack container. * * @default 'auto' */ inlineSize: SizeUnitsOrAuto; /** - * Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size). + * The [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size) (minimum width in horizontal writing modes) of the stack container. * * @default '0' */ minInlineSize: SizeUnits; /** - * Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size). + * The [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size) (maximum width in horizontal writing modes) of the stack container. * * @default 'none' */ maxInlineSize: SizeUnitsOrNone; } +/** + * A version of the stack properties with all fields required. + * @publicDocs + */ export type AlignedStackProps = Required; +/** + * The stack properties that support responsive values through container queries. + * @publicDocs + */ export type ResponsiveStackProps = MakeResponsivePick< AlignedStackProps, 'gap' | 'rowGap' | 'columnGap' | 'direction' >; +/** + * The properties for the stack component. A stack arranges its children in a single direction with controlled spacing and alignment along both axes. + * @publicDocs + */ export interface StackProps extends BoxProps, Pick< @@ -278,127 +325,324 @@ export interface StackProps 'justifyContent' | 'alignItems' | 'alignContent' > { /** - * Aligns the Stack's children along the inline axis. + * Controls the distribution of children along the inline axis (horizontally in horizontal writing modes). + * + * Use this to position items along the primary axis of the stack - horizontally for inline stacks or vertically for block stacks when wrapped into multiple lines. * * @default 'normal' */ justifyContent: JustifyContentKeyword; /** - * Aligns the Stack's children along the block axis. + * Controls the alignment of children along the block axis (vertically in horizontal writing modes). + * + * Use this to align items perpendicular to the stack direction - vertically for inline stacks or horizontally for block stacks. * * @default 'normal' */ alignItems: AlignItemsKeyword; /** - * Aligns the Stack's children along the block axis. + * Controls the distribution of lines along the block axis when content wraps into multiple lines. * - * This overrides the block value of `alignContent`. + * This property only affects stacks with wrapping content. For single-line stacks, use `alignItems` instead. * * @default 'normal' */ alignContent: AlignContentKeyword; /** - * 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. + * The spacing between children in the stack. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value to apply the same spacing to both axes (for example, `'large-100'`), or a pair of values (for example, `'large-100 large-500'`) to set different spacing for the block and inline axes. This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax. * * @default 'none' */ gap: ResponsiveStackProps['gap']; /** - * 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. + * The spacing between children in the block axis (vertical in horizontal writing modes). This property overrides the row spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax. * * @default '' - meaning no override */ rowGap: ResponsiveStackProps['rowGap']; /** - * 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. + * The spacing between children in the inline axis (horizontal in left-to-right languages). This property overrides the column spacing set by the `gap` property. You can provide a single [`SpacingKeyword`](/docs/api/polaris/using-polaris-web-components#scale) value (for example, `'large-100'`), or a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax. * * @default '' - meaning no override */ columnGap: ResponsiveStackProps['columnGap']; /** - * 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. + * The direction in which the stack's children are laid out. Use `'inline'` to arrange children horizontally (with wrapping enabled), or `'block'` to arrange them vertically (without wrapping). This property also accepts [responsive values](/docs/api/polaris/using-polaris-web-components#responsive-values) using container query syntax. * * @default 'block' * - * @implementation the content will wrap if the direction is 'inline', and not wrap if the direction is 'block' + * @implementation The content will wrap if the direction is `'inline'`, and won't wrap if the direction is `'block'`. */ direction: ResponsiveStackProps['direction']; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles for a custom element. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with Preact. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The optional CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * An interface representing the properties of an activation event, such as a click or keypress. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta key (Command on Mac, Windows key on PC) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * The options for triggering a synthetic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * The base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +/** + * An abstract base class for creating custom elements that render with Preact. + */ +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } -declare class BoxElement extends PolarisCustomElement implements BoxProps { +/** + * The base element class for Box components with all Box properties as accessors. + */ +declare class BoxElement extends PreactCustomElement implements BoxProps { constructor(renderImpl: RenderImpl); + /** + * The ARIA role that defines the semantic meaning of the stack for assistive technologies. + */ accessor accessibilityRole: BoxProps['accessibilityRole']; + /** + * The background color of the stack using the design system's color scale. Choose from `transparent`, `subdued`, `base`, or `strong`. + */ accessor background: BoxProps['background']; + /** + * The height of the stack in horizontal writing modes, or width in vertical writing modes. + * Use this for flow-relative sizing that adapts to text direction. + */ accessor blockSize: BoxProps['blockSize']; + /** + * The minimum height of the stack in horizontal writing modes, or minimum width in vertical writing modes. + * Prevents the stack from shrinking below this size. + */ accessor minBlockSize: BoxProps['minBlockSize']; + /** + * The maximum height of the stack in horizontal writing modes, or maximum width in vertical writing modes. + * Prevents the stack from growing beyond this size. + */ accessor maxBlockSize: BoxProps['maxBlockSize']; + /** + * The width of the stack in horizontal writing modes, or height in vertical writing modes. + * Use this for flow-relative sizing that adapts to text direction. + */ accessor inlineSize: BoxProps['inlineSize']; + /** + * The minimum width of the stack in horizontal writing modes, or minimum height in vertical writing modes. + * Prevents the stack from shrinking below this size. + */ accessor minInlineSize: BoxProps['minInlineSize']; + /** + * The maximum width of the stack in horizontal writing modes, or maximum height in vertical writing modes. + * Prevents the stack from growing beyond this size. + */ accessor maxInlineSize: BoxProps['maxInlineSize']; + /** + * Controls how content that exceeds the stack's boundaries is displayed. Use `hidden` to clip overflow or `visible` to allow content to extend beyond boundaries. + */ accessor overflow: BoxProps['overflow']; + /** + * The spacing applied inside the stack on all sides, creating distance between the stack's edges and its content. + */ accessor padding: BoxProps['padding']; + /** + * The vertical padding (top and bottom) in horizontal writing modes. + * Use this for flow-relative padding that adapts to text direction. + */ accessor paddingBlock: BoxProps['paddingBlock']; + /** + * The padding at the top in horizontal writing modes, or at the start edge in vertical writing modes. + */ accessor paddingBlockStart: BoxProps['paddingBlockStart']; + /** + * The padding at the bottom in horizontal writing modes, or at the end edge in vertical writing modes. + */ accessor paddingBlockEnd: BoxProps['paddingBlockEnd']; + /** + * The horizontal padding (left and right) in horizontal writing modes. + * Use this for flow-relative padding that adapts to text direction. + */ accessor paddingInline: BoxProps['paddingInline']; + /** + * The padding at the left in left-to-right languages, or at the right in right-to-left languages. + */ accessor paddingInlineStart: BoxProps['paddingInlineStart']; + /** + * The padding at the right in left-to-right languages, or at the left in right-to-left languages. + */ accessor paddingInlineEnd: BoxProps['paddingInlineEnd']; + /** + * Applies a border using shorthand syntax to specify width, color, and style in a single property. + */ accessor border: BoxProps['border']; + /** + * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property. + */ accessor borderWidth: BoxProps['borderWidth']; + /** + * Controls the visual style of the border on all sides (solid, dashed, auto, or none). When set, this overrides the style value specified in the `border` property. + */ accessor borderStyle: BoxProps['borderStyle']; + /** + * Controls the color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property. + */ accessor borderColor: BoxProps['borderColor']; + /** + * Controls the roundedness of the element's corners using the design system's radius scale. + */ accessor borderRadius: BoxProps['borderRadius']; + /** + * A text description of the stack for screen readers, used when the visual context isn't sufficient for understanding. + */ accessor accessibilityLabel: BoxProps['accessibilityLabel']; + /** + * Controls the visibility of the stack for both visual and assistive technology users. Use `hidden` to hide from screen readers or `exclusive` to hide visually but announce to screen readers. + */ accessor accessibilityVisibility: BoxProps['accessibilityVisibility']; + /** + * Controls how the stack is displayed in the layout, such as block, inline, or none. + */ accessor display: BoxProps['display']; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } +/** + * A stack is a layout component that arranges its children in a single direction with controlled spacing and alignment. + */ declare class Stack extends BoxElement implements StackProps { constructor(); + /** + * The direction in which the stack's children are arranged. + */ accessor direction: StackProps['direction']; + /** + * Controls the distribution of children along the inline axis (horizontally in horizontal writing modes). + */ accessor justifyContent: StackProps['justifyContent']; + /** + * Controls the alignment of children along the block axis (vertically in horizontal writing modes). + */ accessor alignItems: StackProps['alignItems']; + /** + * Controls the distribution of lines along the block axis when content wraps into multiple lines. + */ accessor alignContent: StackProps['alignContent']; + /** + * The spacing between the stack's children. + */ accessor gap: StackProps['gap']; + /** + * The spacing between rows in the stack. + */ accessor rowGap: StackProps['rowGap']; + /** + * The spacing between columns in the stack. + */ accessor columnGap: StackProps['columnGap']; } declare global { @@ -415,11 +659,15 @@ declare module 'preact' { } declare const tagName = 's-stack'; +/** + * The properties for the stack component when it's used in JSX. + * @publicDocs + */ export interface StackJSXProps extends Partial, Pick { /** - * The content of the Stack. + * The child elements to render inside the stack. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Stack/Stack.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Stack/Stack.doc.ts deleted file mode 100644 index ebff5a7897..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Stack/Stack.doc.ts +++ /dev/null @@ -1,166 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Stack'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/stack.png', - isVisualComponent: true, - subSections: [ - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Placing non-form items in rows or columns when sections don't work for your layout. -- Controlling the spacing between elements. -- For form layouts where you need multiple input fields on the same row, use \`s-grid\` instead.`, - }, - { - title: 'Considerations', - type: 'Generic' as const, - anchorLink: 'considerations', - sectionContent: `- Stack doesn't add any padding by default. If you want padding around your stacked elements, use \`base\` to apply the default padding. -- When spacing becomes limited, Stack will always wrap children to a new line.`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use smaller gaps between small elements and larger gaps between big ones. -- Maintain consistent spacing in stacks across all pages of your app.`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Stack', - }, - { - title: 'Slots', - description: '', - type: 'StackSlots', - }, - ], - defaultExample: { - image: 'stack-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Default vertical stacking layout with consistent spacing between text elements.', - codeblock: { - title: 'Basic block stack (vertical)', - tabs: [ - { - code: './examples/basic-block-stack-vertical.html', - language: 'html', - }, - - { - code: './examples/basic-block-stack-vertical.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Horizontal layout for arranging badges or similar elements side by side.', - codeblock: { - title: 'Inline stack (horizontal)', - tabs: [ - { - code: './examples/inline-stack-horizontal.html', - language: 'html', - }, - - { - code: './examples/inline-stack-horizontal.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Advanced responsive layout that changes direction and spacing based on container size.', - codeblock: { - title: 'Responsive stack with container queries', - tabs: [ - { - code: './examples/responsive-stack-with-container-queries.html', - language: 'html', - layout: 'fullWidth', - }, - - { - code: './examples/responsive-stack-with-container-queries.jsx', - language: 'preview-jsx', - layout: 'fullWidth', - }, - ], - }, - }, - { - description: - 'Horizontal stack with space-between justification and center alignment for balanced layouts.', - codeblock: { - title: 'Custom alignment', - tabs: [ - { - code: './examples/custom-alignment.html', - language: 'html', - layout: 'fullWidth', - }, - - { - code: './examples/custom-alignment.jsx', - language: 'preview-jsx', - layout: 'fullWidth', - }, - ], - }, - }, - { - description: - 'Stack with custom gap values and separate row/column gap controls for precise spacing.', - codeblock: { - title: 'Custom spacing', - tabs: [ - { - code: './examples/custom-spacing.html', - language: 'html', - }, - - { - code: './examples/custom-spacing.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.html b/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.html deleted file mode 100644 index b77b73fbc1..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.html +++ /dev/null @@ -1,5 +0,0 @@ - - First item - Second item - Third item - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.jsx b/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.jsx deleted file mode 100644 index e3734e4a22..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/basic-block-stack-vertical.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - First item - Second item - Third item - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/custom-alignment.jsx b/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/custom-alignment.jsx deleted file mode 100644 index 05540543f7..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/custom-alignment.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - Left aligned - Centered text - Right aligned - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/custom-spacing.jsx b/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/custom-spacing.jsx deleted file mode 100644 index e3a622e387..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/custom-spacing.jsx +++ /dev/null @@ -1,18 +0,0 @@ - - - Box with custom spacing - - - Another box - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/default.jsx deleted file mode 100644 index 5cac2f4ce5..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/default.jsx +++ /dev/null @@ -1,6 +0,0 @@ - - Paid - Processing - Filled - Completed - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/inline-stack-horizontal.jsx b/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/inline-stack-horizontal.jsx deleted file mode 100644 index 22d53931dd..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/inline-stack-horizontal.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - Item 1 - Item 2 - Item 3 - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/responsive-stack-with-container-queries.jsx b/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/responsive-stack-with-container-queries.jsx deleted file mode 100644 index dc22de0eb1..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Stack/examples/responsive-stack-with-container-queries.jsx +++ /dev/null @@ -1,23 +0,0 @@ - - - - Content 1 - - - Content 2 - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/StandardComponents.ts b/packages/ui-extensions/src/surfaces/admin/components/StandardComponents.ts index c20a67230e..227d35842a 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/StandardComponents.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/StandardComponents.ts @@ -1,3 +1,6 @@ +/** + * The standard set of UI components available in most admin extensions. These components provide the building blocks for creating extension interfaces including layout elements, form inputs, data display, navigation, and interactive controls. Use these components to build consistent, accessible UIs that match the Shopify admin design system. + */ export type StandardComponents = | 'Avatar' | 'Badge' diff --git a/packages/ui-extensions/src/surfaces/admin/components/Switch.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Switch.d.ts index a06fb86a5b..b2b54ae266 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Switch.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Switch.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -10,53 +10,192 @@ import type { TextFieldProps, CheckboxProps, SwitchProps$1, - PreactCustomElement, - RenderImpl, + ComponentChildren, } from './shared.d.ts'; +/** + * An event that includes a strongly-typed reference to the element that triggered it. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event handler was attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * A function that handles events for a specific element type, or null if no handler is set. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; -/** Used when an element does not have children. */ +/** Used when an element does not have children. * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * CSS styles that will be applied to the component's shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * Configuration for rendering a custom element with Preact and shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * A function that renders the component's content inside the shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * CSS styles that will be applied to the shadow DOM. + */ + styles?: Styles; +}; +/** + * Information about modifier keys and mouse buttons that were active during an interaction. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was held down during the interaction. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on PC) was held down during the interaction. + */ + metaKey: boolean; + /** + * Whether the Control key was held down during the interaction. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the interaction. + */ + button: number; +} +/** + * Options for influencing how a programmatic click behaves. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The core properties that all input elements need to function within forms. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** + * Base class for input elements that participate in form submission. + */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { + /** + * Indicates that this element can participate in form submission. + */ static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * A callback that's triggered when the input's value changes and the field loses focus. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * A callback that's triggered when the input's value changes as the user types. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the input is disabled and can't be interacted with. + */ accessor disabled: PreactInputProps['disabled']; + /** + * A unique identifier for the input element. + */ accessor id: PreactInputProps['id']; + /** + * The name that identifies this input when the form is submitted. + */ accessor name: PreactInputProps['name']; + /** + * The current value of the input. + */ get value(): PreactInputProps['value']; set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * Properties that are common to checkbox-style components. + * @publicDocs + */ export interface PreactCheckboxProps extends Required< Pick< @@ -72,12 +211,21 @@ export interface PreactCheckboxProps | 'disabled' > > { + /** + * The value that's submitted with the form when the checkbox is checked. + */ value: Required['value']; } +/** + * Base class for checkbox-style elements that can be toggled on and off. + */ declare class PreactCheckboxElement extends PreactInputElement implements PreactCheckboxProps { + /** + * Whether the checkbox is currently checked. + */ get checked(): boolean; set checked(checked: PreactCheckboxProps['checked']); /** @@ -85,11 +233,29 @@ declare class PreactCheckboxElement */ get value(): string; set value(value: string); + /** + * Whether the checkbox should be checked when it's first rendered. + */ accessor defaultChecked: PreactCheckboxProps['defaultChecked']; + /** + * A label that's only visible to screen readers, used when the visual label isn't descriptive enough. + */ accessor accessibilityLabel: PreactCheckboxProps['accessibilityLabel']; + /** + * Additional text to provide context or guidance for the checkbox. + */ accessor details: PreactCheckboxProps['details']; + /** + * An error message that's displayed below the checkbox when validation fails. + */ accessor error: PreactCheckboxProps['error']; + /** + * The text that describes what the checkbox is for. + */ accessor label: PreactCheckboxProps['label']; + /** + * Whether the checkbox must be checked before the form can be submitted. + */ accessor required: PreactCheckboxProps['required']; /** @private */ formResetCallback(): void; @@ -97,19 +263,22 @@ declare class PreactCheckboxElement constructor(renderImpl: RenderImpl); } +/** + * Properties for rendering a switch that lets users toggle a setting on or off with a sliding control interface. + * @publicDocs + */ export interface SwitchProps extends PreactCheckboxProps, Required> {} -declare abstract class SwitchBase - extends PreactCheckboxElement - implements Pick -{ +/** + * A switch that lets users toggle a setting on or off with a sliding control. + */ +declare class Switch extends PreactCheckboxElement implements SwitchProps { + /** + * Controls whether the label is visible to all users or only to screen readers. + */ accessor labelAccessibilityVisibility: SwitchProps['labelAccessibilityVisibility']; - constructor(renderImpl: RenderImpl); -} - -declare class Switch extends SwitchBase implements SwitchProps { constructor(); } declare global { @@ -126,10 +295,20 @@ declare module 'preact' { } declare const tagName = 's-switch'; +/** + * Properties for using the switch component in JSX with React-style event handlers. + * @publicDocs + */ export interface SwitchJSXProps extends Partial, Pick { + /** + * A callback that's triggered when the switch's checked state changes and it loses focus. + */ onChange?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the switch's checked state changes as the user interacts with it. + */ onInput?: ((event: CallbackEvent) => void) | null; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Switch/Switch.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Switch/Switch.doc.ts deleted file mode 100644 index abe7e7ff0a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Switch/Switch.doc.ts +++ /dev/null @@ -1,175 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Switch'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/switch.png', - isVisualComponent: true, - definitions: [ - { - title: 'Properties', - description: '', - type: 'Switch', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'SwitchEvents', - }, - ], - defaultExample: { - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Standard toggle switch for enabling or disabling merchant preferences. This example demonstrates a simple switch with a label, allowing users to toggle a single setting on or off.', - codeblock: { - title: 'Basic switch', - tabs: [ - { - code: './examples/basic-switch.html', - language: 'html', - }, - - { - code: './examples/basic-switch.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Locked switch with explanatory text for unavailable premium features. This example shows a switch that is visually disabled and cannot be interacted with, typically used to indicate a feature is not currently available.', - codeblock: { - title: 'Disabled switch', - tabs: [ - { - code: './examples/disabled-switch.html', - language: 'html', - }, - - { - code: './examples/disabled-switch.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Multiple switches within a form for notification preferences submission. This example illustrates how switches can be used together in a form to allow users to configure multiple related settings simultaneously.', - codeblock: { - title: 'Form integration', - tabs: [ - { - code: './examples/form-integration.html', - language: 'html', - }, - - { - code: './examples/form-integration.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Switch with visually hidden label that remains accessible to screen readers. This example demonstrates how to create a switch with a label that is only perceivable by assistive technologies, maintaining accessibility while minimizing visual clutter.', - codeblock: { - title: 'Hidden label for accessibility', - tabs: [ - { - code: './examples/hidden-label-for-accessibility.html', - language: 'html', - }, - - { - code: './examples/hidden-label-for-accessibility.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Required switch with validation error and contextual details for user guidance. This example shows a switch that requires user interaction, provides additional context through details, and displays an error message when validation fails.', - codeblock: { - title: 'With details and error', - tabs: [ - { - code: './examples/with-details-and-error.html', - language: 'html', - }, - - { - code: './examples/with-details-and-error.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Switch with enhanced accessibility description for screen reader users. This example illustrates how to provide a more descriptive accessibility label that provides additional context beyond the visible label.', - codeblock: { - title: 'Switch with accessibility label', - tabs: [ - { - code: './examples/switch-with-accessibility-label.html', - language: 'html', - }, - - { - code: './examples/switch-with-accessibility-label.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Group of related switches arranged in a vertical stack for settings configuration. This example demonstrates how to use the Stack component to create a clean, organized layout for multiple related switch settings.', - codeblock: { - title: 'Settings panel with Stack', - tabs: [ - { - code: './examples/settings-panel-with-stack.html', - language: 'html', - }, - - { - code: './examples/settings-panel-with-stack.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/disabled-switch.html b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/disabled-switch.html index b57e0429ca..905e103feb 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/disabled-switch.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/disabled-switch.html @@ -1,6 +1,6 @@ diff --git a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/form-integration.html b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/form-integration.html index ab0dc032c0..0e18f53388 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/form-integration.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/form-integration.html @@ -1,14 +1,17 @@
- - + + + + Save preferences +
diff --git a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/hidden-label-for-accessibility.html b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/hidden-label-for-accessibility.html index 92b91cac57..2a505f75fa 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/hidden-label-for-accessibility.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/hidden-label-for-accessibility.html @@ -2,5 +2,5 @@ id="hidden-label-switch" labelAccessibilityVisibility="exclusive" label="Toggle feature" - checked="true" + checked > diff --git a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/settings-panel-with-stack.html b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/settings-panel-with-stack.html index db9f48f3bb..c66b1fb1f3 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/settings-panel-with-stack.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/settings-panel-with-stack.html @@ -4,6 +4,6 @@ diff --git a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/with-details-and-error.html b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/with-details-and-error.html index ffd1749151..4509d95939 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/with-details-and-error.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Switch/examples/with-details-and-error.html @@ -4,6 +4,6 @@ details="You must agree to continue with the purchase" error="Agreement is required" name="termsAgreement" - required="true" + required value="agreed" > diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Table.d.ts index defdc683dd..10149dc1f5 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Table.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Table.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -10,11 +10,12 @@ import type { ComponentChildren, TableProps$1, TableHeaderProps$1, - PreactCustomElement, - RenderImpl, } from './shared.d.ts'; -import * as _shopify_admin_web_component_foundations from '@shopify/admin-web-component-foundations'; +/** + * The properties you can set on a table component. + * @publicDocs + */ export interface TableProps extends Required< Pick< @@ -22,68 +23,291 @@ export interface TableProps 'loading' | 'paginate' | 'hasPreviousPage' | 'hasNextPage' | 'variant' > > { + /** + * The display variant of the table. Use `list` to force a list view, or `auto` to automatically switch between table and list based on the available space. + */ variant: Extract; } +/** + * The format type for a table header, which determines how the cell content is displayed. + * @publicDocs + */ export type HeaderFormat = Extract< TableHeaderProps$1['format'], 'base' | 'currency' | 'numeric' >; +/** + * The properties you can set on a table header component. + * @publicDocs + */ export interface TableHeaderProps extends Pick { + /** + * The slot where this header's data appears in list view. The options include `primary` for the main content, `secondary` for supporting text, `labeled` for labeled data, `kicker` for small text above the primary content, or `inline` for inline content. + */ listSlot: Extract< TableHeaderProps$1['listSlot'], 'primary' | 'secondary' | 'labeled' | 'kicker' | 'inline' >; + /** + * The format of the header, which affects how the cell content is aligned and displayed. Use `base` for standard text, `currency` for monetary values, or `numeric` for numbers. + */ format: HeaderFormat; } +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; +} +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * A context object that provides a default value of a specific type. + * @publicDocs + */ +export interface Context { + /** + * The default value for this context. + */ + readonly defaultValue: T; +} +/** + * An extended context class that provides event-based updates when the context value changes. + */ +declare class AddedContext extends EventTarget { + /** + * Creates a new context with the given default value. + */ + constructor(defaultValue: T); + /** + * The current value of the context. + */ + get value(): T; + /** + * Sets a new value for the context. + */ + set value(value: T); +} + +/** + * A callback that a context requester provides, which is called with the value that satisfies the request. + * Context providers can call this callback multiple times as the requested value changes. + * @publicDocs + */ +export type ContextCallback = (value: T) => void; +/** + * An event that a context requester fires to signal it wants a named context. + * + * A provider should inspect the `context` property of the event to see if it has a value that can satisfy the request, and if so, call the `callback` with the requested value. + */ +declare class ContextRequestEvent extends Event { + /** + * The context that's being requested. + */ + readonly context: Context; + /** + * The callback to call with the requested context value. + */ + readonly callback: ContextCallback; + /** + * Creates a new context request event with the given context and callback. + */ + constructor(context: Context, callback: ContextCallback); +} +declare global { + interface HTMLElementEventMap { + /** + * A 'context-request' event can be emitted by any element which desires + * a context value to be injected by an external provider. + */ + 'context-request': ContextRequestEvent; + } +} + +/** @private */ declare const actualTableVariantSymbol: unique symbol; +/** @private */ declare const tableHeadersSharedDataSymbol: unique symbol; +/** + * The actual display variant of the table, which is either a traditional table or a list. + * @publicDocs + */ export type ActualTableVariant = 'table' | 'list'; -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); -} - +/** + * An event that includes a strongly typed `currentTarget` property based on the element tag name. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event listener is attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * An event listener function that receives a strongly typed callback event, or `null` if no listener is attached. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class Table extends PolarisCustomElement implements TableProps { +/** + * A component that displays data in a structured table format that automatically adapts to the available space. + */ +declare class Table extends PreactCustomElement implements TableProps { + /** + * The display variant of the table. + */ accessor variant: TableProps['variant']; + /** + * Whether the table is currently in a loading state. + */ accessor loading: TableProps['loading']; + /** + * Whether the pagination controls are displayed. + */ accessor paginate: TableProps['paginate']; + /** + * Whether there's a previous page of data that the user can navigate to. + */ accessor hasPreviousPage: TableProps['hasPreviousPage']; + /** + * Whether there's a next page of data that the user can navigate to. + */ accessor hasNextPage: TableProps['hasNextPage']; + /** + * The event listener that's called when the user navigates to the previous page. + */ accessor onpreviouspage: CallbackEventListener | null; + /** + * The event listener that's called when the user navigates to the next page. + */ accessor onnextpage: CallbackEventListener | null; /** * @private * The actual table variant, which is either 'table' or 'list'. */ - [actualTableVariantSymbol]: _shopify_admin_web_component_foundations.AddedContext; + [actualTableVariantSymbol]: AddedContext; /** @private */ - [tableHeadersSharedDataSymbol]: _shopify_admin_web_component_foundations.AddedContext< + [tableHeadersSharedDataSymbol]: AddedContext< { listSlot: TableHeaderProps['listSlot']; textContent: string; @@ -91,6 +315,9 @@ declare class Table extends PolarisCustomElement implements TableProps { }[] >; + /** + * Creates a new Table instance. + */ constructor(); } declare global { @@ -107,16 +334,23 @@ declare module 'preact' { } } +/** + * The custom element tag name for the table component. + */ declare const tagName = 's-table'; +/** + * The JSX properties you can set on a table component. + * @publicDocs + */ export interface TableJSXProps extends Partial, Pick { /** - * The content of the Table. + * The content to display inside the table, which should include table header row, table body, and table row components. */ children?: ComponentChildren; /** - * Additional filters to display in the table. For example, the `s-search-field` component can be used to filter the table data. + * Additional filters to display in the table. For example, you can use the search field component to filter the table data. */ filters?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table/Table.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Table/Table.doc.ts deleted file mode 100644 index 9209304428..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Table/Table.doc.ts +++ /dev/null @@ -1,224 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Table'; - -import tableBodySharedContent from '../../../../docs/shared/components/TableBody'; -import tableCellSharedContent from '../../../../docs/shared/components/TableCell'; -import tableHeaderSharedContent from '../../../../docs/shared/components/TableHeader'; -import tableHeaderRowSharedContent from '../../../../docs/shared/components/TableHeaderRow'; -import tableRowSharedContent from '../../../../docs/shared/components/TableRow'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/table.png', - isVisualComponent: true, - subSections: [ - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use when displaying data with 3 or more attributes per item -- All items should share the same structure and attributes -- Don't use when data varies significantly between items (use a list instead) -- Tables automatically transform into lists on mobile devices`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Table', - }, - { - title: 'Slots', - description: '', - type: 'TableSlots', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'TableEvents', - }, - { - title: tableBodySharedContent.name, - description: tableBodySharedContent.description, - type: 'TableBody', - }, - { - title: 'Slots', - description: '', - type: 'TableBodySlots', - }, - { - title: tableCellSharedContent.name, - description: tableCellSharedContent.description, - type: 'TableCell', - }, - { - title: 'Slots', - description: '', - type: 'TableCellSlots', - }, - { - title: tableHeaderSharedContent.name, - description: tableHeaderSharedContent.description, - type: 'TableHeader', - }, - { - title: 'Slots', - description: '', - type: 'TableHeaderSlots', - }, - { - title: tableHeaderRowSharedContent.name, - description: tableHeaderRowSharedContent.description, - type: 'TableHeaderRow', - }, - { - title: 'Slots', - description: '', - type: 'TableHeaderRowSlots', - }, - { - title: tableRowSharedContent.name, - description: tableRowSharedContent.description, - type: 'TableRow', - }, - { - title: 'Slots', - description: '', - type: 'TableRowSlots', - }, - ], - defaultExample: { - image: 'table-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - layout: 'section', - }, - { - code: './examples/default.jsx', - language: 'preview-jsx', - layout: 'section', - }, - ], - }, - }, - related: [ - { - name: 'Index table', - subtitle: 'Composition', - url: '/docs/api/app-home/patterns/compositions/index-table', - type: 'component', - }, - ], - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: 'Tables expand to full width by default.', - codeblock: { - title: 'Basic Usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - layout: 'padding', - }, - ], - }, - }, - { - description: - 'Add pagination controls for navigating large datasets.', - codeblock: { - title: 'With Pagination', - tabs: [ - { - code: './examples/with-pagination.html', - language: 'html', - }, - - { - code: './examples/with-pagination.jsx', - language: 'preview-jsx', - layout: 'padding', - }, - ], - }, - }, - { - description: 'Display a loading state while fetching data.', - codeblock: { - title: 'With Loading State', - tabs: [ - { - code: './examples/with-loading-state.html', - language: 'html', - }, - { - code: './examples/with-loading-state.jsx', - language: 'preview-jsx', - layout: 'padding', - }, - ], - }, - }, - { - description: 'Display multiple columns in a full-width table.', - codeblock: { - title: 'Full-width table with multiple columns', - tabs: [ - { - code: './examples/full-width-product-inventory-table.html', - language: 'html', - }, - - { - code: './examples/full-width-product-inventory-table.jsx', - language: 'preview-jsx', - layout: 'padding', - customStyles: { - minHeight: '400px', - }, - }, - ], - }, - }, - { - description: - 'Display data using the list variant with specialized slot types. List is the default variant on mobile devices.', - codeblock: { - title: 'List Variant', - tabs: [ - { - code: './examples/list-variant.html', - language: 'html', - }, - { - code: './examples/list-variant.jsx', - language: 'preview-jsx', - layout: 'padding', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/Table/examples/basic-usage.jsx deleted file mode 100644 index fc6f9c00b5..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/basic-usage.jsx +++ /dev/null @@ -1,37 +0,0 @@ - - - - Product - Status - Inventory - Price - - - - - Water bottle - - Active - - 128 - $24.99 - - - T-shirt - - Low stock - - 15 - $19.99 - - - Cutting board - - Out of stock - - 0 - $34.99 - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Table/examples/default.jsx deleted file mode 100644 index 49c6e8bae1..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/default.jsx +++ /dev/null @@ -1,30 +0,0 @@ - - - - Name - Email - Orders placed - Phone - - - - John Smith - john@example.com - 23 - 123-456-7890 - - - Jane Johnson - jane@example.com - 15 - 234-567-8901 - - - Brandon Williams - brandon@example.com - 42 - 345-678-9012 - - - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.html b/packages/ui-extensions/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.html deleted file mode 100644 index be142a20e8..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - Product - SKU - Status - Inventory - Price - Last updated - - - - - Water bottle - WB-001 - - Active - - 128 - $24.99 - 2 hours ago - - - T-shirt - TS-002 - - Low stock - - 15 - $19.99 - 1 day ago - - - Cutting board - CB-003 - - Out of stock - - 0 - $34.99 - 3 days ago - - - Notebook set - NB-004 - - Active - - 245 - $12.99 - 5 hours ago - - - Stainless steel straws - SS-005 - - Active - - 89 - $9.99 - 1 hour ago - - - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.jsx b/packages/ui-extensions/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.jsx deleted file mode 100644 index 13feae679d..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/full-width-product-inventory-table.jsx +++ /dev/null @@ -1,65 +0,0 @@ - - - - Product - SKU - Status - Inventory - Price - Last updated - - - - - Water bottle - WB-001 - - Active - - 128 - $24.99 - 2 hours ago - - - T-shirt - TS-002 - - Low stock - - 15 - $19.99 - 1 day ago - - - Cutting board - CB-003 - - Out of stock - - 0 - $34.99 - 3 days ago - - - Notebook set - NB-004 - - Active - - 245 - $12.99 - 5 hours ago - - - Stainless steel straws - SS-005 - - Active - - 89 - $9.99 - 1 hour ago - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/list-variant.jsx b/packages/ui-extensions/src/surfaces/admin/components/Table/examples/list-variant.jsx deleted file mode 100644 index 4f1217469d..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/list-variant.jsx +++ /dev/null @@ -1,44 +0,0 @@ - - - - ID - Customer - Email - Status - Orders - Total spent - - - - #1001 - Sarah Johnson - sarah@example.com - - Active - - 23 - $1,245.50 - - - #1002 - Mike Chen - mike@example.com - - Inactive - - 7 - $432.75 - - - #1003 - Emma Davis - emma@example.com - - Active - - 15 - $892.25 - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/with-filters.html b/packages/ui-extensions/src/surfaces/admin/components/Table/examples/with-filters.html new file mode 100644 index 0000000000..72cac68f9a --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/Table/examples/with-filters.html @@ -0,0 +1,26 @@ + + + + + Product + Status + Inventory + + + + Water bottle + + Active + + 128 + + + T-shirt + + Low stock + + 15 + + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/with-loading-state.jsx b/packages/ui-extensions/src/surfaces/admin/components/Table/examples/with-loading-state.jsx deleted file mode 100644 index 643de0d88c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/with-loading-state.jsx +++ /dev/null @@ -1,40 +0,0 @@ - - - - Product - Status - Inventory - - - - - Water bottle - - Active - - 128 - - - T-shirt - - Low stock - - 15 - - - Cutting board - - Out of stock - - 0 - - - Notebook set - - Active - - 245 - - - - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/with-pagination.jsx b/packages/ui-extensions/src/surfaces/admin/components/Table/examples/with-pagination.jsx deleted file mode 100644 index 48b9a65cfa..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Table/examples/with-pagination.jsx +++ /dev/null @@ -1,27 +0,0 @@ - - - - Product - Status - Sales - - - - - Product 1 - Active - 250 - - - Product 2 - Active - 180 - - - Product 3 - Paused - 95 - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TableBody.d.ts b/packages/ui-extensions/src/surfaces/admin/components/TableBody.d.ts index 23c8ac936a..225275d073 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/TableBody.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/TableBody.d.ts @@ -1,39 +1,146 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - TableBodyProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, TableBodyProps$1} from './shared.d.ts'; +/** + * The properties you can set on a table body component. + * @publicDocs + */ export interface TableBodyProps extends TableBodyProps$1 {} -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; +} +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; } +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -/** Used when an element does not have children. */ + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class TableBody extends PolarisCustomElement implements TableBodyProps { +/** + * A component that wraps the body content of a table, which contains the data rows. + */ +declare class TableBody extends PreactCustomElement implements TableBodyProps { + /** + * Creates a new TableBody instance. + */ constructor(); } declare global { @@ -50,12 +157,19 @@ declare module 'preact' { } } +/** + * The custom element tag name for the table body component. + */ declare const tagName = 's-table-body'; +/** + * The JSX properties you can set on a table body component. + * @publicDocs + */ export interface TableBodyJSXProps extends Partial, Pick { /** - * The body of the table. May not have any semantic meaning in the Table's `list` variant. + * The body content of the table, which should include table row components. This content might not have any semantic meaning when the table uses the `list` variant. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/TableCell.d.ts b/packages/ui-extensions/src/surfaces/admin/components/TableCell.d.ts index 3d35109305..c3ffea3cf3 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/TableCell.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/TableCell.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -9,39 +9,154 @@ import type { ComponentChildren, TableCellProps$1, TableHeaderProps, - PreactCustomElement, - RenderImpl, } from './shared.d.ts'; +/** + * The properties you can set on a table cell component. + * @publicDocs + */ export interface TableCellProps extends TableCellProps$1 {} -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; } +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -/** Used when an element does not have children. */ + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } +/** @private */ declare const headerFormatSymbol: unique symbol; +/** + * The format type for a table header, which determines how the cell content is displayed. + * @publicDocs + */ export type HeaderFormat = Extract< TableHeaderProps['format'], 'base' | 'currency' | 'numeric' >; -declare class TableCell extends PolarisCustomElement implements TableCellProps { +/** + * A component that represents a single cell in a table row, which displays data in a format that's determined by its column header. + */ +declare class TableCell extends PreactCustomElement implements TableCellProps { + /** + * Creates a new TableCell instance. + */ constructor(); /** @private */ get [headerFormatSymbol](): HeaderFormat; @@ -62,12 +177,19 @@ declare module 'preact' { } } +/** + * The custom element tag name for the table cell component. + */ declare const tagName = 's-table-cell'; +/** + * The JSX properties you can set on a table cell component. + * @publicDocs + */ export interface TableCellJSXProps extends Partial, Pick { /** - * The content of the table cell. + * The content to display inside the table cell. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/TableHeader.d.ts b/packages/ui-extensions/src/surfaces/admin/components/TableHeader.d.ts index b62c1028a5..bbcd13d604 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/TableHeader.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/TableHeader.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,51 +6,174 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - TableHeaderProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, TableHeaderProps$1} from './shared.d.ts'; +/** + * The format type for a table header, which determines how the cell content is displayed. + * @publicDocs + */ export type HeaderFormat = Extract< TableHeaderProps$1['format'], 'base' | 'currency' | 'numeric' >; +/** + * The properties you can set on a table header component. + * @publicDocs + */ export interface TableHeaderProps extends Pick { + /** + * The slot where this header's data appears in list view. The options include `primary` for the main content, `secondary` for supporting text, `labeled` for labeled data, `kicker` for small text above the primary content, or `inline` for inline content. + */ listSlot: Extract< TableHeaderProps$1['listSlot'], 'primary' | 'secondary' | 'labeled' | 'kicker' | 'inline' >; + /** + * The format of the header, which affects how the cell content is aligned and displayed. Use `base` for standard text, `currency` for monetary values, or `numeric` for numbers. + */ format: HeaderFormat; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; +} +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; } +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -/** Used when an element does not have children. */ + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } +/** + * A component that defines a column header in a table, which specifies both the header label and how the column's data should be formatted. + */ declare class TableHeader - extends PolarisCustomElement + extends PreactCustomElement implements TableHeaderProps { + /** + * The slot where this header's data appears when the table is shown in list view. + */ accessor listSlot: TableHeaderProps['listSlot']; + /** + * The format of the header and its corresponding cells. + */ accessor format: TableHeaderProps['format']; + /** + * Creates a new TableHeader instance. + */ constructor(); } declare global { @@ -67,12 +190,19 @@ declare module 'preact' { } } +/** + * The custom element tag name for the table header component. + */ declare const tagName = 's-table-header'; +/** + * The JSX properties you can set on a table header component. + * @publicDocs + */ export interface TableHeaderJSXProps extends Partial, Pick { /** - * The heading of the column in the `table` variant, and the label of its data in `list` variant. + * The heading of the column when the table uses the `table` variant, and the label of its data when the table uses the `list` variant. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/TableHeaderRow.d.ts b/packages/ui-extensions/src/surfaces/admin/components/TableHeaderRow.d.ts index 0d6d934d92..c19fbc593a 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/TableHeaderRow.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/TableHeaderRow.d.ts @@ -1,42 +1,149 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - TableHeaderRowProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, TableHeaderRowProps$1} from './shared.d.ts'; +/** + * The properties you can set on a table header row component. + * @publicDocs + */ export interface TableHeaderRowProps extends TableHeaderRowProps$1 {} -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; +} +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; } +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -/** Used when an element does not have children. */ + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } +/** + * A component that wraps the header row of a table, which contains the table header components that define the column structure. + */ declare class TableHeaderRow - extends PolarisCustomElement + extends PreactCustomElement implements TableHeaderRowProps { + /** + * Creates a new TableHeaderRow instance. + */ constructor(); /** @private */ connectedCallback(): void; @@ -57,12 +164,19 @@ declare module 'preact' { } } +/** + * The custom element tag name for the table header row component. + */ declare const tagName = 's-table-header-row'; +/** + * The JSX properties you can set on a table header row component. + * @publicDocs + */ export interface TableHeaderRowJSXProps extends Partial, Pick { /** - * Contents of the table heading row; children should be `TableHeading` components. + * The content to display inside the table header row, which should include table header components. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/TableRow.d.ts b/packages/ui-extensions/src/surfaces/admin/components/TableRow.d.ts index 12046899af..83acd96ae5 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/TableRow.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/TableRow.d.ts @@ -1,41 +1,151 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - TableRowProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, TableRowProps$1} from './shared.d.ts'; +/** + * The properties you can set on a table row component. + * @publicDocs + */ export interface TableRowProps extends Pick {} -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; } +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -/** Used when an element does not have children. */ + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class TableRow extends PolarisCustomElement implements TableRowProps { +/** + * A component that represents a single row in a table, which contains the data cells. + */ +declare class TableRow extends PreactCustomElement implements TableRowProps { + /** + * Creates a new TableRow instance. + */ constructor(); + /** + * A CSS selector for a child element that should handle clicks on the entire row. When you set this property, clicking anywhere on the row will trigger a click on the element that matches the selector. + */ accessor clickDelegate: string; } declare global { @@ -52,12 +162,19 @@ declare module 'preact' { } } +/** + * The custom element tag name for the table row component. + */ declare const tagName = 's-table-row'; +/** + * The JSX properties you can set on a table row component. + * @publicDocs + */ export interface TableRowJSXProps extends Partial, Pick { /** - * The content of a TableRow, which should be `TableCell` components. + * The content to display inside the row, which should include table cell components. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Text.d.ts index a3ca1646ad..97743fdf19 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Text.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Text.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,13 +6,16 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - TextProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, TextProps$1} from './shared.d.ts'; +/** + * The properties for the text component. These properties define inline or small blocks of text content with various visual styles and semantic meanings. + * @publicDocs + */ +/** + * @publicDocs + * @publicDocs + */ export interface TextProps extends Required< Pick< @@ -26,65 +29,230 @@ export interface TextProps | 'interestFor' > > { + /** + * The color of the text. Available options: + * - `'base'` - The default text color. + * - `'subdued'` - A lighter text color for secondary information. + */ color: Extract; + /** + * The semantic type and styling treatment for the text content. + * + * Other presentation properties on Text override the default styling. + * + * - `strong`: Emphasizes the text with strong importance, typically displayed in bold. + * - `generic`: Standard text with no special semantic meaning or styling. + * - `address`: Marks the text as contact information, such as a physical or email address. + * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context. + * + * @default 'generic' + */ type: Extract< TextProps$1['type'], - 'address' | 'redundant' | 'strong' | 'generic' + 'strong' | 'generic' | 'address' | 'redundant' >; + /** + * The semantic tone that's applied to the text, which changes its color to convey meaning. + * + * - `info`: Informational content or helpful tips (blue). + * - `success`: Positive outcomes or successful states (green). + * - `warning`: Important warnings about potential issues (orange). + * - `critical`: Urgent problems or destructive actions (red). + * - `auto`: Automatically determined based on context. + * - `neutral`: General information without specific intent (gray). + * - `caution`: Advisory notices that need attention (yellow). + * + * @default 'auto' + */ tone: Extract< TextProps$1['tone'], - 'auto' | 'neutral' | 'info' | 'success' | 'warning' | 'caution' | 'critical' + 'info' | 'success' | 'warning' | 'critical' | 'auto' | 'neutral' | 'caution' >; + /** + * The numeric font variant for the text. Available options: + * - `'auto'` - The font variant is automatically determined. + * - `'normal'` - Standard numeric rendering. + * - `'tabular-nums'` - Monospaced numbers for better alignment in tables. + */ fontVariantNumeric: Extract< TextProps$1['fontVariantNumeric'], 'auto' | 'normal' | 'tabular-nums' >; } -/** Used when an element does not have children. */ +/** + * A string containing CSS styles. + * @publicDocs + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with a shadow DOM. + * @publicDocs + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow DOM content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * Optional CSS styles to apply to the shadow DOM. + */ + styles?: Styles; +}; +/** + * An object that represents the state of modifier keys and mouse button + * during an activation event like a click. + * @publicDocs + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta (Command on Mac, Windows key on PC) key was pressed. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * Options for customizing click behavior on an element. + * @publicDocs + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); -} - -declare abstract class TextBase - extends PolarisCustomElement - implements - Pick< - TextProps, - | 'fontVariantNumeric' - | 'color' - | 'type' - | 'dir' - | 'accessibilityVisibility' - | 'interestFor' - > -{ +/** + * A custom element for displaying inline or small blocks of text with various visual styles and semantic meanings. Use Text to render short pieces of content with appropriate styling, emphasis, and color treatment. + */ +declare class Text extends PreactCustomElement implements TextProps { + /** + * The numeric font variant for the text. + */ accessor fontVariantNumeric: TextProps['fontVariantNumeric']; + /** + * The color of the text. + */ accessor color: TextProps['color']; + /** + * The semantic tone that's applied to the text, which changes its color to convey meaning. + * + * - `info`: Informational content or helpful tips (blue). + * - `success`: Positive outcomes or successful states (green). + * - `warning`: Important warnings about potential issues (orange). + * - `critical`: Urgent problems or destructive actions (red). + * - `auto`: Automatically determined based on context. + * - `neutral`: General information without specific intent (gray). + * - `caution`: Advisory notices that need attention (yellow). + */ + accessor tone: TextProps['tone']; + /** + * The semantic type and styling treatment for the text content. + * + * - `strong`: Emphasizes the text with strong importance, typically displayed in bold. + * - `generic`: Standard text with no special semantic meaning or styling. + * - `address`: Marks the text as contact information, such as a physical or email address. + * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context. + */ accessor type: TextProps['type']; + /** + * The text direction (left-to-right or right-to-left). + */ accessor dir: TextProps['dir']; + /** + * The visibility of the element to assistive technologies. + */ accessor accessibilityVisibility: TextProps['accessibilityVisibility']; + /** + * The ID of an element this text provides contextual information for. + */ accessor interestFor: string; - abstract tone: string; - constructor(renderImpl: RenderImpl); -} - -declare class Text extends TextBase implements TextProps { - accessor tone: TextProps['tone']; constructor(); } declare global { @@ -101,11 +269,16 @@ declare module 'preact' { } declare const tagName = 's-text'; +/** + * The JSX properties for the text component. These properties define how text is rendered in Preact or JSX. + * @publicDocs + * @publicDocs + */ export interface TextJSXProps extends Partial, Pick { /** - * The content of the Text. + * The content of the text. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/Text.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Text/Text.doc.ts deleted file mode 100644 index 1e3e33c30e..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/Text.doc.ts +++ /dev/null @@ -1,237 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Text'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/text.png', - isVisualComponent: true, - subSections: [ - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Adding inline text elements such as labels or line errors. -- Applying different visual tones and text styles to specific words or phrases within a \`s-paragraph\`, such as a \`strong\` type or \`critical\` tone.`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Text elements display inline and will flow on the same line when placed next to each other. To stack multiple text elements vertically, wrap them in a Stack container or use multiple \`s-paragraph\` components. -- Use plain and clear terms. -- Don't use jargon or technical language. -- Don't use different terms to describe the same thing. -- Don't duplicate content.`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Text', - }, - { - title: 'Slots', - description: '', - type: 'TextSlots', - }, - ], - defaultExample: { - image: 'text-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - layout: 'wrapped', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Standard text content for general interface messaging and descriptions.', - codeblock: { - title: 'Basic Usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Emphasized text for important messages and call-to-actions.', - codeblock: { - title: 'Strong Text', - tabs: [ - { - code: './examples/strong-text.html', - language: 'html', - }, - - { - code: './examples/strong-text.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Structured address text with proper semantic meaning for screen readers.', - codeblock: { - title: 'Semantic Address', - tabs: [ - { - code: './examples/semantic-address.html', - language: 'html', - }, - - { - code: './examples/semantic-address.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Monospace number formatting for consistent alignment in tables and financial data.', - codeblock: { - title: 'Tabular Numbers', - tabs: [ - { - code: './examples/tabular-numbers.html', - language: 'html', - }, - - { - code: './examples/tabular-numbers.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Color-coded text indicating different status states and semantic meanings.', - codeblock: { - title: 'Status Tones', - tabs: [ - { - code: './examples/status-tones.html', - language: 'html', - }, - - { - code: './examples/status-tones.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Text visible only to screen readers for providing additional context.', - codeblock: { - title: 'Accessibility Hidden Text', - tabs: [ - { - code: './examples/accessibility-hidden-text.html', - language: 'html', - }, - - { - code: './examples/accessibility-hidden-text.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Text direction support for RTL languages like Arabic and Hebrew.', - codeblock: { - title: 'Right-to-Left Text', - tabs: [ - { - code: './examples/right-to-left-text.html', - language: 'html', - }, - - { - code: './examples/right-to-left-text.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Lower contrast text for secondary information and timestamps.', - codeblock: { - title: 'Subdued Color', - tabs: [ - { - code: './examples/subdued-color.html', - language: 'html', - }, - - { - code: './examples/subdued-color.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Text element associated with tooltips using the `interestFor` attribute to show additional information on hover or focus.', - codeblock: { - title: 'Interest For Association', - tabs: [ - { - code: './examples/interest-for-association.html', - language: 'html', - customStyles: { - minHeight: '200px', - }, - }, - - { - code: './examples/interest-for-association.jsx', - language: 'preview-jsx', - customStyles: { - minHeight: '200px', - }, - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/accessibility-hidden-text.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/accessibility-hidden-text.jsx deleted file mode 100644 index 1b634516f4..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/accessibility-hidden-text.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Product prices include tax - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/basic-usage.html deleted file mode 100644 index 9f1e0944a9..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/basic-usage.html +++ /dev/null @@ -1,3 +0,0 @@ - - Manage your products and inventory from one dashboard. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/basic-usage.jsx deleted file mode 100644 index 9f1e0944a9..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/basic-usage.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Manage your products and inventory from one dashboard. - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/default.jsx deleted file mode 100644 index 5c527eecbb..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/default.jsx +++ /dev/null @@ -1,4 +0,0 @@ - - Name: - Jane Doe - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/interest-for-association.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/interest-for-association.jsx deleted file mode 100644 index 116f25527f..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/interest-for-association.jsx +++ /dev/null @@ -1,8 +0,0 @@ -<> - - SKU must be unique across all products and cannot be changed after creation - - - What is a product SKU? - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/right-to-left-text.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/right-to-left-text.jsx deleted file mode 100644 index f5ed7a2b7f..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/right-to-left-text.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - محتوى النص باللغة العربية - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/semantic-address.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/semantic-address.jsx deleted file mode 100644 index a8a02b81a2..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/semantic-address.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - 123 Commerce Street, Toronto, ON M5V 2H1 - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/status-tones.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/status-tones.jsx deleted file mode 100644 index 941c14f71c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/status-tones.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - Order fulfilled - Payment failed - Low inventory - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/strong-text.html b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/strong-text.html deleted file mode 100644 index c2dab70f7a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/strong-text.html +++ /dev/null @@ -1,3 +0,0 @@ - - Free shipping on orders over $50 - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/strong-text.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/strong-text.jsx deleted file mode 100644 index c2dab70f7a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/strong-text.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Free shipping on orders over $50 - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/subdued-color.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/subdued-color.jsx deleted file mode 100644 index 067147b0d3..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/subdued-color.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - Last updated 2 hours ago - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/tabular-numbers.jsx b/packages/ui-extensions/src/surfaces/admin/components/Text/examples/tabular-numbers.jsx deleted file mode 100644 index 9e9d2367c6..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Text/examples/tabular-numbers.jsx +++ /dev/null @@ -1,3 +0,0 @@ - - $1,234.56 - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextArea.d.ts b/packages/ui-extensions/src/surfaces/admin/components/TextArea.d.ts index dca668bc17..a4898d0158 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/TextArea.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/TextArea.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -9,59 +9,213 @@ import type { TextFieldProps, TextAreaProps$1, - PreactCustomElement, - RenderImpl, + ComponentChildren, } from './shared.d.ts'; +/** + * An event with a strongly-typed currentTarget property for a specific HTML element. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event listener is attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * A callback function that receives a strongly-typed event for a specific HTML element. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; +/** + * The React-style event callback props for form field components. + * @publicDocs + */ export interface FieldReactProps { + /** + * A callback that's invoked when the user makes any changes in the field. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). + */ onInput?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). + */ onChange?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). + */ onFocus?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). + */ onBlur?: ((event: CallbackEvent) => void) | null; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles for the component's shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a Preact component in a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's Preact elements into the shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * The properties from an event that indicate how the user activated an element. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was held down when the event occurred. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on macOS) was held down when the event occurred. + */ + metaKey: boolean; + /** + * Whether the Control key was held down when the event occurred. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed when the event occurred. A value of 0 indicates the primary button (usually left), 1 indicates the middle button, and 2 indicates the secondary button (usually right). + */ + button: number; +} +/** + * The options for influencing a programmatic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The base properties for an input element that participates in form submission. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** @private */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the user makes any changes in the field. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the field is disabled, disallowing any interaction. + * + * @default false + */ accessor disabled: PreactInputProps['disabled']; + /** + * An identifier for the field. + */ accessor id: PreactInputProps['id']; + /** + * An identifier for the field that's unique within the nearest containing form. + */ accessor name: PreactInputProps['name']; + /** + * The current value for the field. + */ get value(): PreactInputProps['value']; set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * The base properties for form field elements that support labels, validation, and autocomplete. + * @publicDocs + */ export type PreactFieldProps = PreactInputProps & Required< @@ -81,10 +235,10 @@ export type PreactFieldProps = * 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 + * autofill, but you don't have any more semantic information on the intended * contents. * - * When set to `off`, you are indicating that this field contains sensitive + * When set to `off`, you're 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 @@ -99,20 +253,58 @@ export type PreactFieldProps = */ autocomplete: Autocomplete; }; +/** @private */ declare class PreactFieldElement extends PreactInputElement implements PreactFieldProps { + /** + * A callback that's invoked when the field loses focus. + */ accessor onblur: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the field receives focus. + */ accessor onfocus: CallbackEventListener<'input'>; + /** + * A hint as to the intended content of the field for autocomplete purposes. + */ accessor autocomplete: PreactFieldProps['autocomplete']; + /** + * The initial value for the field when it's first rendered. + */ accessor defaultValue: PreactFieldProps['defaultValue']; + /** + * Additional descriptive text to display below the field that provides supplementary information. + */ accessor details: PreactFieldProps['details']; + /** + * An error message to display below the field, indicating validation failure or other issues. + */ accessor error: PreactFieldProps['error']; + /** + * The text label to display for the field, describing what the user should enter. + */ accessor label: PreactFieldProps['label']; + /** + * Controls the visibility of the label for accessibility purposes. + */ accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility']; + /** + * The placeholder text that's displayed inside the field when it's empty, providing a hint about expected input. + */ accessor placeholder: PreactFieldProps['placeholder']; + /** + * Whether the field is read-only, preventing edits while still allowing focus and selection. + * + * @default false + */ accessor readOnly: PreactFieldProps['readOnly']; + /** + * Whether the field must be filled out before form submission. + * + * @default false + */ accessor required: PreactFieldProps['required']; /** * Global keyboard event handlers for things like key bindings typically @@ -141,18 +333,39 @@ declare class PreactFieldElement constructor(renderImpl: RenderImpl); } +/** + * The properties for the text area component. These properties configure a multi-line text input field that allows merchants to enter and edit longer text content. + * @publicDocs + */ export type TextAreaProps = PreactFieldProps< Required['autocomplete'] > & Required>; +/** + * The text area custom element class that renders a multi-line text input field in the Shopify admin interface. This component allows merchants to enter and edit longer text content with support for labels, validation, and length constraints. + */ declare class TextArea extends PreactFieldElement implements TextAreaProps { + /** + * The maximum number of characters the user can enter in the field. + */ accessor maxLength: TextAreaProps['maxLength']; + /** + * The minimum number of characters required in the field for validation. + */ accessor minLength: TextAreaProps['minLength']; + /** + * The number of visible text lines for the field, controlling its initial height. + */ accessor rows: TextAreaProps['rows']; + /** + * The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. + */ + get value(): string; + set value(value: string); constructor(); } declare global { @@ -169,6 +382,10 @@ declare module 'preact' { } declare const tagName = 's-text-area'; +/** + * The JSX props for the text area component. These properties extend `TextAreaProps` with JSX-specific event callbacks for React-style event handling. + * @publicDocs + */ export interface TextAreaJSXProps extends Partial, Pick, diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextArea/TextArea.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/TextArea/TextArea.doc.ts deleted file mode 100644 index 9001772841..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextArea/TextArea.doc.ts +++ /dev/null @@ -1,122 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/TextArea'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/textarea.png', - isVisualComponent: true, - definitions: [ - { - title: 'Properties', - description: '', - type: 'TextArea', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'TextAreaEvents', - }, - ], - defaultExample: { - image: 'textarea-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple text area for collecting product descriptions with a placeholder and autocomplete disabled.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Showcases a text area for writing SEO meta descriptions with a character limit of 160, providing guidance text and a multi-line input.', - codeblock: { - title: 'Seo meta description with character limit', - tabs: [ - { - code: './examples/seo-meta-description-with-character-limit.html', - language: 'html', - }, - - { - code: './examples/seo-meta-description-with-character-limit.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates the error state of a text area with a minimum length requirement, showing how validation errors are displayed in a commerce context.', - codeblock: { - title: 'With error state', - tabs: [ - { - code: './examples/error-state.html', - language: 'html', - }, - - { - code: './examples/error-state.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates a text area for entering detailed product care instructions, with an expanded height and supporting guidance text.', - codeblock: { - title: 'Product care instructions', - tabs: [ - { - code: './examples/product-care-instructions.html', - language: 'html', - }, - - { - code: './examples/product-care-instructions.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/basic-usage.jsx deleted file mode 100644 index c96075a552..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/basic-usage.jsx +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/default.jsx deleted file mode 100644 index 14dc5e2722..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/default.jsx +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/disabled-and-read-only.html b/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/disabled-and-read-only.html new file mode 100644 index 0000000000..c1d7cba0dc --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/disabled-and-read-only.html @@ -0,0 +1,15 @@ + + + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/error-state.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/error-state.jsx deleted file mode 100644 index 07685290d1..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/error-state.jsx +++ /dev/null @@ -1,8 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/product-care-instructions.html b/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/product-care-instructions.html deleted file mode 100644 index ca41cfb043..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/product-care-instructions.html +++ /dev/null @@ -1,7 +0,0 @@ - diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/product-care-instructions.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/product-care-instructions.jsx deleted file mode 100644 index 5101339409..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/product-care-instructions.jsx +++ /dev/null @@ -1,7 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/seo-meta-description-with-character-limit.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/seo-meta-description-with-character-limit.jsx deleted file mode 100644 index d6fb53f7a2..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextArea/examples/seo-meta-description-with-character-limit.jsx +++ /dev/null @@ -1,8 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField.d.ts b/packages/ui-extensions/src/surfaces/admin/components/TextField.d.ts index e5bbdb92d4..deb1e919c1 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/TextField.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,67 +6,223 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - TextFieldProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, TextFieldProps$1} from './shared.d.ts'; +/** + * A callback event with a strongly-typed `currentTarget` property that corresponds to a specific HTML element. This provides better type safety when handling events from custom elements. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that the event listener is attached to, strongly typed based on the element's tag name. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * An event listener function type for callback events with a strongly-typed `currentTarget`. This ensures the event handler receives the correct element type. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; +/** + * The JSX-style event callback props for form field components. These properties provide React-like event handling for input, change, focus, and blur events. + * @publicDocs + */ export interface FieldReactProps { + /** + * A callback that's invoked when the user makes any changes in the field. This fires on every keystroke or modification. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). + */ onInput?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field or press Enter. This fires less frequently than `onInput`. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). + */ onChange?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field receives focus, typically when the user clicks into it or tabs to it. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). + */ onFocus?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's invoked when the field loses focus, typically when the user clicks away or tabs out of it. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). + */ onBlur?: ((event: CallbackEvent) => void) | null; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements without children. Provides `key`, `ref`, and `slot` properties for element identification, DOM access, and slot-based positioning. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for the element when used in lists. Preact uses keys for efficient rendering and reconciliation when lists change. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element. Typically created with `useRef()` to access the element directly for imperative operations like focusing or measuring. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * The named slot this element should be placed in when used within a web component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots). + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements with children. Extends `PreactBaseElementProps` with the ability to render child elements. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { + /** + * The child elements to render within this component. + */ children?: preact.ComponentChildren; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * The CSS styles as a string, used for styling web components within their shadow DOM. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The render function that returns Preact/JSX elements to display in the component's shadow root. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The optional CSS styles to inject into the component's shadow DOM. + */ + styles?: Styles; +}; +/** + * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the activation event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the activation event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the activation event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the activation event. `0` for primary button (left click), `1` for auxiliary button (middle click), `2` for secondary button (right click). + */ + button: number; +} +/** + * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs. + * @publicDocs + */ +export interface ClickOptions { + /** + * The activation event (such as a click or keyboard event) whose modifier key state and button information should influence the synthetic click behavior. For example, passing an event with `metaKey: true` will cause links to open in a new tab. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The base properties for an input element that participates in form submission. Defines the core properties needed for form integration including identifier, name, value, and disabled state. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** @private */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * A callback that's invoked when the user has finished editing the field, such as when they blur the field. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the user makes any changes in the field. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the field is disabled, disallowing any interaction. + * + * @default false + */ accessor disabled: PreactInputProps['disabled']; + /** + * An identifier for the field. + */ accessor id: PreactInputProps['id']; + /** + * An identifier for the field that's unique within the nearest containing form. + */ accessor name: PreactInputProps['name']; + /** + * The current value for the field. + */ get value(): PreactInputProps['value']; set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * The base properties for form field elements that support labels, validation, and autocomplete. Extends `PreactInputProps` with additional form field features like labels, placeholders, error messages, and autocomplete hints. + * @publicDocs + */ export type PreactFieldProps = PreactInputProps & Required< @@ -83,19 +239,9 @@ export type PreactFieldProps = > > & { /** - * 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. + * A hint about the intended content of the field for browser autocomplete functionality. When set to `'on'` (the default), this indicates that the field should support autofill, but you don't have specific semantic information about the contents. When set to `'off'`, you're indicating that this field contains sensitive information or contents that are never saved, like one-time codes. Alternatively, you can provide a specific autocomplete value that describes the data you'd like to be entered during autofill, such as `'email'`, `'name'`, or `'street-address'`. * - * Alternatively, you can provide value which describes the - * specific data you would like to be entered into this field during autofill. - * - * @see Learn more about the set of {@link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens|autocomplete values} supported in browsers. + * @see Learn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers. * * @default 'tel' for PhoneField * @default 'email' for EmailField @@ -104,20 +250,58 @@ export type PreactFieldProps = */ autocomplete: Autocomplete; }; +/** @private */ declare class PreactFieldElement extends PreactInputElement implements PreactFieldProps { + /** + * A callback that's invoked when the field loses focus. + */ accessor onblur: CallbackEventListener<'input'>; + /** + * A callback that's invoked when the field receives focus. + */ accessor onfocus: CallbackEventListener<'input'>; + /** + * A hint as to the intended content of the field for autocomplete purposes. + */ accessor autocomplete: PreactFieldProps['autocomplete']; + /** + * The initial value for the field when it's first rendered. + */ accessor defaultValue: PreactFieldProps['defaultValue']; + /** + * Additional descriptive text to display below the field that provides supplementary information. + */ accessor details: PreactFieldProps['details']; + /** + * An error message to display below the field, indicating validation failure or other issues. + */ accessor error: PreactFieldProps['error']; + /** + * The text label to display for the field, describing what the user should enter. + */ accessor label: PreactFieldProps['label']; + /** + * Controls the visibility of the label for accessibility purposes. + */ accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility']; + /** + * The placeholder text that's displayed inside the field when it's empty, providing a hint about expected input. + */ accessor placeholder: PreactFieldProps['placeholder']; + /** + * Whether the field is read-only, preventing edits while still allowing focus and selection. + * + * @default false + */ accessor readOnly: PreactFieldProps['readOnly']; + /** + * Whether the field must be filled out before form submission. + * + * @default false + */ accessor required: PreactFieldProps['required']; /** * Global keyboard event handlers for things like key bindings typically @@ -146,6 +330,10 @@ declare class PreactFieldElement constructor(renderImpl: RenderImpl); } +/** + * The properties for the text field component. Extends `PreactFieldProps` with text-specific features like icons, length constraints, and prefix/suffix content. + * @publicDocs + */ export type TextFieldProps = PreactFieldProps< /** @default 'on' */ Required['autocomplete'] @@ -157,23 +345,38 @@ export type TextFieldProps = PreactFieldProps< > >; -declare abstract class TextFieldBase +/** + * The text field custom element class that renders a single-line text input field in the Shopify admin interface. This component allows merchants to enter and edit text with support for labels, validation, icons, and prefix/suffix content. + */ +declare class TextField extends PreactFieldElement - implements - Pick< - TextFieldProps, - 'icon' | 'maxLength' | 'minLength' | 'prefix' | 'suffix' - > + implements TextFieldProps { + /** + * An icon to display at the start of the text field, providing visual context for the input. Accepts any valid icon type from the admin icon set, or an empty string to display no icon. + */ accessor icon: TextFieldProps['icon']; + /** + * The maximum number of characters the merchant can enter in the field. When this limit is reached, the field prevents further input. + */ accessor maxLength: TextFieldProps['maxLength']; + /** + * The minimum number of characters required in the field for validation. The field will be considered invalid if the merchant enters fewer characters than this value. + */ accessor minLength: TextFieldProps['minLength']; + /** + * Text or content to display before the merchant's input, such as a currency symbol (`$`) or protocol (`https://`). + */ accessor prefix: TextFieldProps['prefix']; + /** + * Text or content to display after the merchant's input, such as a unit of measurement (`kg`, `%`) or domain (`.myshopify.com`). + */ accessor suffix: TextFieldProps['suffix']; - constructor(renderImpl: RenderImpl); -} - -declare class TextField extends TextFieldBase implements TextFieldProps { + /** + * The current text value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. + */ + get value(): string; + set value(value: string); constructor(); } declare global { @@ -191,12 +394,16 @@ declare module 'preact' { } declare const tagName = 's-text-field'; +/** + * The JSX props for the text field component. These properties extend `TextFieldProps` with JSX-specific event callbacks and an accessory slot for rendering additional content at the end of the field. + * @publicDocs + */ export interface TextFieldJSXProps extends Partial>, Pick, FieldReactProps { /** - * The accessory to display in the text field. + * An accessory element to display at the end of the text field, such as a button, icon, or other interactive component. This appears inside the field's visual boundary, typically for actions like clearing the field or showing additional options. */ accessory?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/TextField.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/TextField/TextField.doc.ts deleted file mode 100644 index 63d882a39f..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/TextField.doc.ts +++ /dev/null @@ -1,164 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/TextField'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/textfield.png', - isVisualComponent: true, - definitions: [ - { - title: 'TextField', - description: - 'A text input field that allows users to enter and edit text.', - type: 'TextField', - }, - { - title: 'Slots', - description: '', - type: 'TextFieldSlots', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'TextFieldEvents', - }, - ], - defaultExample: { - image: 'text-field-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple text input field for entering a store name with autocomplete turned off, providing a clean and straightforward input experience.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Showcases a text field enhanced with a search icon and a placeholder, creating a visually intuitive input for searching products.', - codeblock: { - title: 'With icon', - tabs: [ - { - code: './examples/with-icon.html', - language: 'html', - }, - - { - code: './examples/with-icon.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates the importance of providing clear, actionable, and context-specific error messages that guide merchants toward correct input and understanding.', - codeblock: { - title: 'Specific error messages for merchant context', - tabs: [ - { - code: './examples/specific-error-messages-for-merchant-context.html', - language: 'html', - }, - - { - code: './examples/specific-error-messages-for-merchant-context.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates a text field marked as required, ensuring that users must provide input before form submission, with built-in validation support.', - codeblock: { - title: 'Required field with validation', - tabs: [ - { - code: './examples/required-field-with-validation.html', - language: 'html', - }, - - { - code: './examples/required-field-with-validation.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: 'Displays text field usage with prefix and suffix', - codeblock: { - title: 'With prefix and suffix', - tabs: [ - { - code: './examples/with-prefix-and-suffix.html', - language: 'html', - }, - - { - code: './examples/with-prefix-and-suffix.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates the flexibility of adding interactive elements like buttons to text fields, enabling immediate actions based on the entered input.', - codeblock: { - title: 'With accessory', - tabs: [ - { - code: './examples/with-accessory.html', - language: 'html', - }, - - { - code: './examples/with-accessory.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/basic-usage.html deleted file mode 100644 index 9ef2274cc4..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/basic-usage.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/basic-usage.jsx deleted file mode 100644 index 4316abe8bd..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/basic-usage.jsx +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/default.jsx deleted file mode 100644 index d476be8246..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/default.jsx +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/disabled-and-read-only.html b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/disabled-and-read-only.html new file mode 100644 index 0000000000..6cd39f3f93 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/disabled-and-read-only.html @@ -0,0 +1,13 @@ + + + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/required-field-with-validation.html b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/required-field-with-validation.html deleted file mode 100644 index a2479270bf..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/required-field-with-validation.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/required-field-with-validation.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/required-field-with-validation.jsx deleted file mode 100644 index 3ce7e5f0f4..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/required-field-with-validation.jsx +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/specific-error-messages-for-merchant-context.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/specific-error-messages-for-merchant-context.jsx deleted file mode 100644 index 5e04435ef8..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/specific-error-messages-for-merchant-context.jsx +++ /dev/null @@ -1,16 +0,0 @@ - - {/* Generic error (avoid) */} - - - {/* Specific error (preferred) */} - - - {/* Business rule error */} - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/with-accessory.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/with-accessory.jsx deleted file mode 100644 index 897c454dcf..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/with-accessory.jsx +++ /dev/null @@ -1,6 +0,0 @@ -<> - This is info tooltip - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/with-icon.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/with-icon.jsx deleted file mode 100644 index f8989da816..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/with-icon.jsx +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/with-prefix-and-suffix.jsx b/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/with-prefix-and-suffix.jsx deleted file mode 100644 index 87c3db1666..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/TextField/examples/with-prefix-and-suffix.jsx +++ /dev/null @@ -1,11 +0,0 @@ - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail.d.ts index 96b0ac0bc5..ba4e3a0742 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -6,47 +6,191 @@ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ThumbnailProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ThumbnailProps$1, ComponentChildren} from './shared.d.ts'; +/** + * A callback event that's typed to a specific HTML element. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The element that currently has the event listener attached. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * An event listener for callback events, typed to a specific HTML element. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { (event: CallbackEvent): void; }) | null; -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } +/** + * The properties for the thumbnail component. A thumbnail displays a small preview image with configurable sizing. Properties include `src` for the image URL, `alt` for accessibility text, and `size` for controlling the thumbnail dimensions. + * @publicDocs + */ export interface ThumbnailProps extends Required> { + /** + * The URL of the image to display in the thumbnail. You can provide an absolute or relative URL pointing to the image file. + */ + src: ThumbnailProps$1['src']; + /** + * Alternative text that describes the image for screen readers. This text should convey the meaning or content of the image to users who can't see it. + */ + alt: ThumbnailProps$1['alt']; + /** + * The size of the thumbnail. Choose from `'small-200'`, `'small-100'`, `'small'`, `'base'`, `'large'`, or `'large-100'` to control the thumbnail dimensions. + * + * @default 'base' + */ size: Extract< ThumbnailProps$1['size'], 'small-200' | 'small-100' | 'small' | 'base' | 'large' | 'large-100' >; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles for a custom element. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with Preact. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The optional CSS styles to apply to the shadow root. + */ + styles?: Styles; +}; +/** + * The properties of an activation event, such as a click or keypress. These properties capture which modifier keys were pressed and which mouse button was used during the event. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * The options for triggering a synthetic click event. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * The base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of `HTMLElement` to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +/** + * An abstract base class for creating custom elements that render with Preact. + */ +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queues a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to `@property` values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in a background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } -declare class Thumbnail extends PolarisCustomElement implements ThumbnailProps { +/** + * A thumbnail displays a small preview image with configurable sizing. + */ +declare class Thumbnail extends PreactCustomElement implements ThumbnailProps { + /** + * The URL of the image to display in the thumbnail. + */ accessor src: ThumbnailProps['src']; + /** + * Alternative text that describes the image for screen readers. + */ accessor alt: ThumbnailProps['alt']; + /** + * The size of the thumbnail. + */ accessor size: ThumbnailProps['size']; + /** + * A callback that's fired when the image has loaded successfully. + */ accessor onload: CallbackEventListener | null; + /** + * A callback that's fired when the image fails to load. + */ accessor onerror: OnErrorEventHandler; constructor(); } @@ -64,10 +208,20 @@ declare module 'preact' { } declare const tagName = 's-thumbnail'; +/** + * The properties for the thumbnail component when it's used in JSX. + * @publicDocs + */ export interface ThumbnailJSXProps extends Partial, Pick { + /** + * A callback that's fired when the image has loaded successfully. + */ onLoad?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's fired when the image fails to load. + */ onError?: ((event: CallbackEvent) => void) | null; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/Thumbnail.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/Thumbnail.doc.ts deleted file mode 100644 index f2c9075d14..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/Thumbnail.doc.ts +++ /dev/null @@ -1,153 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Thumbnail'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/thumbnail.png', - isVisualComponent: true, - subSections: [ - { - title: 'Useful for', - type: 'Generic' as const, - anchorLink: 'useful-for', - sectionContent: `- Identifying items visually in lists, tables, or cards -- Seeing a preview of images before uploading or publishing -- Distinguishing between similar items by their appearance -- Confirming the correct item is selected`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- \`small-200\`: use in very small areas -- \`small\`: use in small areas -- \`base\`: use as the default size -- \`large\`: use when thumbnail is a focal point`, - }, - { - title: 'Content guidelines', - type: 'Generic' as const, - anchorLink: 'content-guidelines', - sectionContent: `Alternative text should be accurate, concise, and descriptive: -- Use "Image of", "Photo of" prefix -- Be primary visual content: "Image of a woman with curly brown hair smiling" -- Include relevant emotions: "Image of a woman laughing with her hand on her face"`, - }, - ], - definitions: [ - { - title: 'Properties', - description: '', - type: 'Thumbnail', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'ThumbnailEvents', - }, - ], - defaultExample: { - image: 'thumbnail-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - layout: 'inline', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a basic thumbnail component with a product image, showing the default base size and an alt text for accessibility.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows the thumbnail component in an empty state, displaying a placeholder icon when no image source is provided.', - codeblock: { - title: 'Empty state', - tabs: [ - { - code: './examples/empty-state.html', - language: 'html', - }, - - { - code: './examples/empty-state.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates the various size options for the thumbnail component, showcasing small-200, base, and large sizes in a stack layout.', - codeblock: { - title: 'Different sizes', - tabs: [ - { - code: './examples/different-sizes.html', - language: 'html', - }, - - { - code: './examples/different-sizes.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Demonstrates how event handlers like onload or onerror can be attached to the thumbnail component via JavaScript to handle image loading states.', - codeblock: { - title: 'With event handling', - tabs: [ - { - code: './examples/with-event-handling.html', - language: 'html', - }, - - { - code: './examples/with-event-handling.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/basic-usage.html deleted file mode 100644 index 2f392e6942..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/basic-usage.html +++ /dev/null @@ -1,5 +0,0 @@ - diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/basic-usage.jsx deleted file mode 100644 index 1fdb193519..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/basic-usage.jsx +++ /dev/null @@ -1,5 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/default.html b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/default.html index 4fdba6f07e..4f9315cfff 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/default.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/default.html @@ -1,4 +1,4 @@ diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/default.jsx deleted file mode 100644 index d597a041ac..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/default.jsx +++ /dev/null @@ -1,4 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/different-sizes.html b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/different-sizes.html index 64ca22db42..be5009f69b 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/different-sizes.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/different-sizes.html @@ -1,17 +1,17 @@ diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/different-sizes.jsx b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/different-sizes.jsx deleted file mode 100644 index 81048cf63f..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/different-sizes.jsx +++ /dev/null @@ -1,17 +0,0 @@ - - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/empty-state.jsx b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/empty-state.jsx deleted file mode 100644 index bf3190e093..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/empty-state.jsx +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.html b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.html index 40a0107dcd..7ac2d83da7 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.html @@ -1,9 +1,22 @@ - - - Image loaded - \ No newline at end of file + + + Loading... + + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.jsx b/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.jsx deleted file mode 100644 index f0b75821b3..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Thumbnail/examples/with-event-handling.jsx +++ /dev/null @@ -1,13 +0,0 @@ -const [loading, setLoading] = useState(true) - -return ( - - setLoading(false)} - /> - {loading ? 'Loading...' : 'Image loaded'} - -) \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Tooltip.d.ts b/packages/ui-extensions/src/surfaces/admin/components/Tooltip.d.ts index 811c8545f0..3cac397086 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Tooltip.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/Tooltip.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -9,38 +9,146 @@ import type { ComponentChildren, TooltipProps$1, - PreactCustomElement, - RenderImpl, InteractionProps, } from './shared.d.ts'; +/** + * The properties you can set on a tooltip component. + * @publicDocs + */ export interface TooltipProps extends Required> {} -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string that contains CSS styles to apply to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a Preact custom element with a shadow root. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow root content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right). + */ + button: number; +} +/** + * The options for customizing how a synthetic click is performed. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } +/** + * The properties for controlling overlay elements like popovers, tooltips, and menus through command interactions. + * @publicDocs + */ export interface PreactOverlayControlProps extends Pick { /** - * Sets the action the [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this clickable is activated. + * The action that the [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated. * - * See the documentation of particular components for the actions they support. + * See the documentation of specific components for the actions they support. * * - `--auto`: a default action for the target component. * - `--show`: shows the target component. @@ -54,11 +162,11 @@ export interface PreactOverlayControlProps '--show' | '--hide' | '--toggle' | '--auto' >; /** - * Sets the element the [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this clickable is activated. + * The element that the [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated. */ commandFor: Extract; /** - * Sets the element the [interestFor](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code) should act on when this clickable is activated. + * The element that the [interestFor](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code) should act on when this component is activated. */ interestFor: Extract; } @@ -66,29 +174,43 @@ export interface PreactOverlayControlProps /** * Shared symbols for overlay control functionality. * These symbols are used by components that implement overlay behavior - * (like Popover, Tooltip, Modal, etc.) to communicate with the overlay control system. - */ -/** - * Symbol used to track the open or closed state of the overlay. + * (such as Popover, Tooltip, and Modal) to communicate with the overlay control system. */ +/** @private */ declare const overlayHidden: unique symbol; -/** - * Symbol used to track the element that opened the overlay. In some cases, like tooltips and popovers, the overlay is positioned against this element. In all cases, focus should be restored to this element when the overlay is closed. - */ +/** @private */ declare const overlayActivator: unique symbol; +/** @private */ declare const overlayHideFrameId: unique symbol; +/** + * The initialization object for creating a polyfill command event. + * @publicDocs + */ export type PolyfillCommandEventInit = EventInit & { + /** + * The element that triggered the command. + */ source: HTMLElement | null | undefined; + /** + * The command action that should be performed. + */ command: PreactOverlayControlProps['command']; - rootActivator?: HTMLElement | null; }; +/** + * A polyfill event for the command interaction pattern, which is used to control overlay elements. + * @publicDocs + */ export type PolyfillCommandEvent = Event & { + /** + * The element that triggered the command. + */ source: PolyfillCommandEventInit['source']; + /** + * The command action that should be performed. + */ command: PolyfillCommandEventInit['command']; - /** Have to use `_s_shadowSource` because `source` is retargeted to the shadow host by browsers */ + /** You have to use `_s_shadowSource` because `source` is retargeted to the shadow host by browsers. */ _s_shadowSource: PolyfillCommandEventInit['source']; - /** Root activator for nested overlays (e.g., menu button when modal opened from menu item) */ - _s_rootActivator?: HTMLElement | null; }; declare global { interface GlobalEventHandlersEventMap { @@ -96,7 +218,13 @@ declare global { } } -declare class PreactOverlayElement extends PolarisCustomElement { +/** + * The base class for overlay elements that can be shown and hidden through command interactions. + */ +declare class PreactOverlayElement extends PreactCustomElement { + /** + * Creates a new overlay element with the given render implementation. + */ constructor(renderImpl: RenderImpl); /** @private */ [overlayHidden]: boolean; @@ -106,7 +234,13 @@ declare class PreactOverlayElement extends PolarisCustomElement { [overlayHideFrameId]?: number; } +/** + * A component that displays a small popup with explanatory text when the user hovers over or focuses on an element. + */ declare class Tooltip extends PreactOverlayElement implements TooltipProps { + /** + * Creates a new Tooltip instance. + */ constructor(); } declare global { @@ -122,14 +256,19 @@ declare module 'preact' { } } +/** + * The custom element tag name for the tooltip component. + */ declare const tagName = 's-tooltip'; +/** + * The JSX properties you can set on a tooltip component. + * @publicDocs + */ export interface TooltipJSXProps extends Partial, Pick { /** - * The content of the Tooltip. - * - * Only accepts `Text`, `Paragraph` components, and raw `textContent`. + * The content to display inside the tooltip, which should include text or paragraph components, or raw text content. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/Tooltip.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/Tooltip.doc.ts deleted file mode 100644 index 8f061447ae..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/Tooltip.doc.ts +++ /dev/null @@ -1,124 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/Tooltip'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/tooltip.png', - isVisualComponent: true, - subSections: [ - { - title: 'Usage', - type: 'Generic' as const, - anchorLink: 'usage', - sectionContent: `Tooltips only render on devices with a pointer and do not display on mobile devices.`, - }, - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use for additional, non-essential context only -- Provide for icon-only buttons or buttons with keyboard shortcuts -- Keep content concise and in sentence case -- Don't use for critical information, errors, or blocking messages -- Don't contain any links or buttons -- Use sparingly. If you need many tooltips, clarify the design and language instead`, - }, - ], - definitions: [ - { - title: 'Slots', - description: '', - type: 'TooltipSlots', - }, - { - title: 'Slots', - description: '', - type: 'TooltipSlots', - }, - ], - defaultExample: { - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - layout: 'inline', - customStyles: { - minHeight: '200px', - }, - }, - { - code: './examples/default.jsx', - language: 'preview-jsx', - layout: 'inline', - customStyles: { - minHeight: '200px', - }, - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple tooltip that provides additional context for a text element when hovered or focused.', - codeblock: { - title: 'Basic Usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - layout: 'inline', - customStyles: { - minHeight: '200px', - }, - }, - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - layout: 'inline', - customStyles: { - minHeight: '200px', - }, - }, - ], - }, - }, - { - description: - "Shows how to add a tooltip to an icon button, providing a clear explanation of the button's action when hovered.", - codeblock: { - title: 'With Icon Button', - tabs: [ - { - code: './examples/with-icon-button.html', - language: 'html', - layout: 'inline', - customStyles: { - minHeight: '200px', - }, - }, - { - code: './examples/with-icon-button.jsx', - language: 'preview-jsx', - layout: 'inline', - customStyles: { - minHeight: '200px', - }, - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/basic-usage.html b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/basic-usage.html index 7c9ae533b8..60058037c5 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/basic-usage.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/basic-usage.html @@ -1,4 +1,2 @@ - - This order has shipping labels. - -Shipping status +This order has active shipping labels. +Shipping status diff --git a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/basic-usage.jsx b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/basic-usage.jsx deleted file mode 100644 index 306846bf39..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/basic-usage.jsx +++ /dev/null @@ -1,6 +0,0 @@ -<> - - This order has shipping labels. - - Shipping status - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/default.jsx deleted file mode 100644 index 5c519bf956..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/default.jsx +++ /dev/null @@ -1,6 +0,0 @@ -<> - Bold - - B - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/keyboard-shortcut.html b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/keyboard-shortcut.html new file mode 100644 index 0000000000..4e6c6f76b7 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/keyboard-shortcut.html @@ -0,0 +1,2 @@ +Save (⌘S) +Save diff --git a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/with-icon-button.html b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/with-icon-button.html index b766fb1c7c..772d5f3056 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/with-icon-button.html +++ b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/with-icon-button.html @@ -1,6 +1,4 @@ - - Delete item permanently - - - +View product details and inventory status + + diff --git a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/with-icon-button.jsx b/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/with-icon-button.jsx deleted file mode 100644 index caec0ae00d..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/Tooltip/examples/with-icon-button.jsx +++ /dev/null @@ -1,8 +0,0 @@ -<> - - Delete item permanently - - - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/URLField.d.ts b/packages/ui-extensions/src/surfaces/admin/components/URLField.d.ts index c830c01793..cffb6454fd 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/URLField.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/URLField.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ @@ -9,59 +9,220 @@ import type { TextFieldProps, URLFieldProps$1, - PreactCustomElement, - RenderImpl, + ComponentChildren, } from './shared.d.ts'; +/** + * An event object with a strongly-typed currentTarget property that references the specific HTML element type. + * @publicDocs + */ export type CallbackEvent = Event & { + /** + * The DOM element that the event listener is attached to. + */ currentTarget: HTMLElementTagNameMap[T]; }; +/** + * An event listener function or null that receives a typed callback event. + * @publicDocs + */ export type CallbackEventListener = | (EventListener & { + /** + * The callback function that's invoked when the event fires. + */ (event: CallbackEvent): void; }) | null; +/** + * The React-style event handler props for form field components. + * @publicDocs + */ export interface FieldReactProps { + /** + * A callback that's triggered when the field's value changes as the user types. + */ onInput?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the field's value changes and the field loses focus. + */ onChange?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the field receives focus. + */ onFocus?: ((event: CallbackEvent) => void) | null; + /** + * A callback that's triggered when the field loses focus. + */ onBlur?: ((event: CallbackEvent) => void) | null; } -/** Used when an element does not have children. */ +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles to be applied to the component. + * @publicDocs + */ +export type Styles = string; +/** + * The implementation details for rendering a custom element with a shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * A function that renders the component's shadow DOM content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * The CSS styles to apply to the component. + */ + styles?: Styles; +}; +/** + * An object containing information about keyboard and mouse button states during an activation event. + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the Shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the Meta (Command on Mac, Windows key on PC) key was pressed during the event. + */ + metaKey: boolean; + /** + * Whether the Control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed during the event. + */ + button: number; +} +/** + * The options for programmatically triggering a click event on an element. + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; +} +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); + + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; } declare const internals: unique symbol; +/** + * The required props for input elements that all form controls must implement. + * @publicDocs + */ export type PreactInputProps = Required< Pick >; +/** + * The base class for form input elements that participate in form submission. + */ declare class PreactInputElement - extends PolarisCustomElement + extends PreactCustomElement implements PreactInputProps { + /** @private */ static formAssociated: boolean; /** @private */ [internals]: ElementInternals; + /** + * The callback that's triggered when the input value changes and the field loses focus. + */ accessor onchange: CallbackEventListener<'input'>; + /** + * The callback that's triggered when the input value changes as the user types. + */ accessor oninput: CallbackEventListener<'input'>; + /** + * Whether the input is disabled and can't be interacted with. + */ accessor disabled: PreactInputProps['disabled']; + /** + * The unique identifier for the input element. + */ accessor id: PreactInputProps['id']; + /** + * The name of the input, used when submitting form data. + */ accessor name: PreactInputProps['name']; + /** + * The current value of the input. + */ get value(): PreactInputProps['value']; + /** + * The current value of the input. + */ set value(value: PreactInputProps['value']); constructor(renderImpl: RenderImpl); } +/** + * The common props shared by all form field components in the admin UI. + * @publicDocs + */ export type PreactFieldProps = PreactInputProps & Required< @@ -78,17 +239,17 @@ export type PreactFieldProps = > > & { /** - * A hint as to the intended content of the field. + * A hint about the intended content of the field for browser autofill. * * 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 + * autofill, but you don't have any more semantic information on the intended * contents. * - * When set to `off`, you are indicating that this field contains sensitive + * When set to `off`, you're 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. + * Alternatively, you can provide a value which describes the + * specific data you'd like to be entered into this field during autofill. * * @see Learn more about the set of {@link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens|autocomplete values} supported in browsers. * @@ -99,27 +260,63 @@ export type PreactFieldProps = */ autocomplete: Autocomplete; }; +/** + * The base class for form field elements that includes label, error, and validation support. + */ declare class PreactFieldElement extends PreactInputElement implements PreactFieldProps { + /** + * The callback that's triggered when the field loses focus. + */ accessor onblur: CallbackEventListener<'input'>; + /** + * The callback that's triggered when the field receives focus. + */ accessor onfocus: CallbackEventListener<'input'>; + /** + * A hint about the intended content of the field for browser autofill. + */ accessor autocomplete: PreactFieldProps['autocomplete']; + /** + * The initial value of the field when it's first rendered. + */ accessor defaultValue: PreactFieldProps['defaultValue']; + /** + * The additional text displayed below the field to provide helpful context. + */ accessor details: PreactFieldProps['details']; + /** + * The error message displayed when the field validation fails. + */ accessor error: PreactFieldProps['error']; + /** + * The text label displayed above the field. + */ accessor label: PreactFieldProps['label']; + /** + * The visibility of the label for accessibility purposes. Available values: `hidden`, `visible`. + */ accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility']; + /** + * The hint text displayed inside the field when it's empty. + */ accessor placeholder: PreactFieldProps['placeholder']; + /** + * Whether the field is read-only and can't be edited by the user. + */ accessor readOnly: PreactFieldProps['readOnly']; + /** + * Whether the field must be filled out before the form can be submitted. + */ accessor required: PreactFieldProps['required']; /** * Global keyboard event handlers for things like key bindings typically * ignore keystrokes originating from within input elements. Unfortunately, - * these never account for a Custom Element being the input element. + * these never account for a custom element being the input element. * - * To fix this, we spoof getAttribute & hasAttribute to make a PreactFieldElement + * To fix this, we spoof getAttribute and hasAttribute to make a PreactFieldElement * appear as a contentEditable "input" when it contains a focused input element. * @private technically not private, but we don't want to expose this as public API */ @@ -129,8 +326,8 @@ declare class PreactFieldElement */ hasAttribute(qualifiedName: string): boolean; /** - * Checks if the shadow tree contains a focused input (input, textarea, select, ). - * Note: this does _not_ return true for focussed non-field form elements like buttons. + * Checks if the shadow tree contains a focused input (input, textarea, select, contentEditable element). + * Note: this doesn't return true for focused non-field form elements like buttons. * @private */ get isContentEditable(): boolean; @@ -141,18 +338,41 @@ declare class PreactFieldElement constructor(renderImpl: RenderImpl); } +/** + * The properties for the URL field component. These properties configure an input field that allows merchants to enter and validate web addresses (URLs) with built-in validation. + * @publicDocs + */ export type URLFieldProps = PreactFieldProps< Required['autocomplete'] > & Required>; +/** + * The URL field custom element class that renders a URL input field in the Shopify admin interface. This component allows merchants to enter web addresses with automatic URL validation and appropriate mobile keyboard layouts. + */ declare class URLField extends PreactFieldElement implements URLFieldProps { + /** + * A hint about the intended content of the field for browser autofill. + * + * @default 'url' + */ accessor autocomplete: URLFieldProps['autocomplete']; + /** + * The maximum number of characters allowed in the URL. + */ accessor maxLength: URLFieldProps['maxLength']; + /** + * The minimum number of characters required in the URL. + */ accessor minLength: URLFieldProps['minLength']; + /** + * The current URL value in the field as a string. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as a URL format when the user finishes editing. + */ + get value(): string; + set value(value: string); constructor(); } declare global { @@ -169,6 +389,10 @@ declare module 'preact' { } declare const tagName = 's-url-field'; +/** + * The JSX props for the URL field component. These properties extend `URLFieldProps` with JSX-specific event callbacks for React-style event handling when used in Preact. + * @publicDocs + */ export interface URLFieldJSXProps extends Partial>, Pick, diff --git a/packages/ui-extensions/src/surfaces/admin/components/URLField/URLField.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/URLField/URLField.doc.ts deleted file mode 100644 index 9061daf4ab..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/URLField/URLField.doc.ts +++ /dev/null @@ -1,122 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/URLField'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: '/assets/templated-apis-screenshots/admin/components/urlfield.png', - isVisualComponent: true, - definitions: [ - { - title: 'URLField', - description: '', - type: 'URLField', - }, - { - title: 'Events', - description: - 'Learn more about [registering events](/docs/api/app-home/using-polaris-components#event-handling).', - type: 'URLFieldEvents', - }, - ], - defaultExample: { - image: 'urlfield-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - title: 'HTML', - code: './examples/default.html', - language: 'html', - }, - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'Demonstrates a simple URL input field with a label and placeholder, showing the minimal configuration needed for collecting a URL.', - codeblock: { - title: 'Basic usage', - tabs: [ - { - code: './examples/basic-usage.html', - language: 'html', - }, - - { - code: './examples/basic-usage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows a URL input field with built-in validation, including required status, minimum and maximum length constraints, and a custom error message for invalid inputs.', - codeblock: { - title: 'With validation', - tabs: [ - { - code: './examples/with-validation.html', - language: 'html', - }, - - { - code: './examples/with-validation.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Illustrates a URL field pre-populated with a default value, set to read-only mode to prevent user modifications.', - codeblock: { - title: 'With default value', - tabs: [ - { - code: './examples/with-default-value.html', - language: 'html', - }, - - { - code: './examples/with-default-value.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - { - description: - 'Shows a URL field in a disabled state, displaying a pre-filled URL that cannot be edited by the user.', - codeblock: { - title: 'Disabled state', - tabs: [ - { - code: './examples/disabled-state.html', - language: 'html', - }, - - { - code: './examples/disabled-state.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/URLField/examples/default.html b/packages/ui-extensions/src/surfaces/admin/components/URLField/examples/default.html index a15bbee2dc..6d8c62ae93 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/URLField/examples/default.html +++ b/packages/ui-extensions/src/surfaces/admin/components/URLField/examples/default.html @@ -1,5 +1,5 @@ diff --git a/packages/ui-extensions/src/surfaces/admin/components/URLField/examples/with-default-value.html b/packages/ui-extensions/src/surfaces/admin/components/URLField/examples/with-default-value.html index 35f01e05a5..6a4e27b172 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/URLField/examples/with-default-value.html +++ b/packages/ui-extensions/src/surfaces/admin/components/URLField/examples/with-default-value.html @@ -1,7 +1,5 @@ - - - + diff --git a/packages/ui-extensions/src/surfaces/admin/components/UnorderedList.d.ts b/packages/ui-extensions/src/surfaces/admin/components/UnorderedList.d.ts index cf46c2bd36..38a9482fef 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/UnorderedList.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/UnorderedList.d.ts @@ -1,40 +1,150 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable import/extensions */ /* eslint-disable @typescript-eslint/no-namespace */ // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment /// -import type { - ComponentChildren, - UnorderedListProps$1, - PreactCustomElement, - RenderImpl, -} from './shared.d.ts'; +import type {ComponentChildren, UnorderedListProps$1} from './shared.d.ts'; +/** + * The properties for the unordered list component. These properties define a bulleted list of items where the order doesn't matter. + * @publicDocs + * @publicDocs + */ export interface UnorderedListProps extends UnorderedListProps$1 {} -declare class PolarisCustomElement extends PreactCustomElement { - constructor(renderImpl: Omit); +/** + * A string containing CSS styles. + * @publicDocs + */ +export type Styles = string; +/** + * The configuration for rendering a custom element with a shadow DOM. + * @publicDocs + */ +export type RenderImpl = Omit & { + /** + * The function that renders the component's shadow DOM content. + */ + ShadowRoot: (element: any) => ComponentChildren; + /** + * Optional CSS styles to apply to the shadow DOM. + */ + styles?: Styles; +}; +/** + * An object that represents the state of modifier keys and mouse button + * during an activation event like a click. + * @publicDocs + * @publicDocs + */ +export interface ActivationEventEsque { + /** + * Whether the shift key was pressed during the event. + */ + shiftKey: boolean; + /** + * Whether the meta (Command on Mac, Windows key on PC) key was pressed. + */ + metaKey: boolean; + /** + * Whether the control key was pressed during the event. + */ + ctrlKey: boolean; + /** + * The mouse button that was pressed (0 for left, 1 for middle, 2 for right). + */ + button: number; +} +/** + * Options for customizing click behavior on an element. + * @publicDocs + * @publicDocs + */ +export interface ClickOptions { + /** + * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked. + */ + sourceEvent?: ActivationEventEsque; } +/** + * Base class for creating custom elements with Preact. + * While this class could be used in both Node and the browser, the constructor will only be used in the browser. + * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser. + */ +declare const BaseClass: typeof globalThis.HTMLElement; +declare abstract class PreactCustomElement extends BaseClass { + /** @private */ + static get observedAttributes(): string[]; + constructor({ + styles, + ShadowRoot: renderFunction, + delegatesFocus, + ...options + }: RenderImpl); -/** Used when an element does not have children. */ + /** @private */ + setAttribute(name: string, value: string): void; + /** @private */ + attributeChangedCallback(name: string): void; + /** @private */ + connectedCallback(): void; + /** @private */ + disconnectedCallback(): void; + /** @private */ + adoptedCallback(): void; + /** + * Queue a run of the render function. + * You shouldn't need to call this manually - it should be handled by changes to @property values. + * @private + */ + queueRender(): void; + /** + * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. + * + * For example, if the `sourceEvent` was a middle click, or has particular keys held down, + * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. + * @private + * @param options + */ + click({sourceEvent}?: ClickOptions): void; +} + +/** + * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management. + * @publicDocs + * @publicDocs + */ export interface PreactBaseElementProps { - /** Assigns a unique key to this element. */ + /** + * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered. + */ key?: preact.Key; - /** Assigns a ref (generally from `useRef()`) to this element. */ + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; - /** Assigns this element to a parent's slot. */ + /** + * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns. + */ slot?: Lowercase; } -/** Used when an element has children. */ +/** + * The base properties for Preact elements that have children, extending the base element properties to include child content. + * @publicDocs + * @publicDocs + */ export interface PreactBaseElementPropsWithChildren extends PreactBaseElementProps { children?: preact.ComponentChildren; } +/** + * A custom element for displaying a bulleted list of items where the order doesn't matter. Use unordered list when you have a collection of related items without a specific sequence, such as features, options, or bullet points. + */ declare class UnorderedList - extends PolarisCustomElement + extends PreactCustomElement implements UnorderedListProps { constructor(); @@ -54,13 +164,16 @@ declare module 'preact' { } declare const tagName = 's-unordered-list'; +/** + * The JSX properties for the unordered list component. These properties define how an unordered list is rendered in Preact or JSX. + * @publicDocs + * @publicDocs + */ export interface UnorderedListJSXProps extends Partial, Pick { /** - * The items of the UnorderedList. - * - * Only ListItems are accepted. + * The items in the unordered list. Only list item components are accepted. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/admin/components/UnorderedList/UnorderedList.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/UnorderedList/UnorderedList.doc.ts deleted file mode 100644 index c53ad0c783..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/UnorderedList/UnorderedList.doc.ts +++ /dev/null @@ -1,85 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; -import sharedContent from '../../../../docs/shared/components/UnorderedList'; -import listItemSharedContent from '../../../../docs/shared/components/ListItem'; - -const data: AdminReferenceEntityTemplateSchema = { - ...sharedContent, - thumbnail: - '/assets/templated-apis-screenshots/admin/components/unordered-list.png', - isVisualComponent: true, - subSections: [ - { - title: 'Best practices', - type: 'Generic' as const, - anchorLink: 'best-practices', - sectionContent: `- Use to break up related content and improve scannability -- Phrase items consistently (start each with a noun or verb) -- Start each item with a capital letter -- Don't use commas or semicolons at the end of lines`, - }, - ], - definitions: [ - { - title: 'Slots', - description: '', - type: 'UnorderedListSlots', - }, - { - title: listItemSharedContent.name, - description: listItemSharedContent.description, - type: 'ListItem', - }, - { - title: 'Slots', - description: '', - type: 'ListItemSlots', - }, - ], - defaultExample: { - image: 'unordered-list-default.png', - codeblock: { - title: 'Code', - tabs: [ - { - code: './examples/default.html', - language: 'html', - }, - - { - code: './examples/default.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - examples: { - description: 'Component examples', - exampleGroups: [ - { - title: 'Basic usage', - examples: [ - { - description: - 'A standard unordered list with nested items demonstrating hierarchical content structure.', - codeblock: { - title: 'Unordered list with nested items', - tabs: [ - { - code: './examples/store-setup-checklist.html', - language: 'html', - }, - - { - code: './examples/store-setup-checklist.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - ], - }, - ], - }, -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/UnorderedList/examples/default.jsx b/packages/ui-extensions/src/surfaces/admin/components/UnorderedList/examples/default.jsx deleted file mode 100644 index 6997e4f86c..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/UnorderedList/examples/default.jsx +++ /dev/null @@ -1,5 +0,0 @@ - - Red shirt - Green shirt - Blue shirt - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/UnorderedList/examples/store-setup-checklist.jsx b/packages/ui-extensions/src/surfaces/admin/components/UnorderedList/examples/store-setup-checklist.jsx deleted file mode 100644 index c1743339c3..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/UnorderedList/examples/store-setup-checklist.jsx +++ /dev/null @@ -1,24 +0,0 @@ - - - - Configure payment settings - - Set up shipping options - - Domestic shipping rates - International shipping zones - - - Add product descriptions - - - - - - Enable online payments - Set up shipping rates - Configure tax settings - Add product descriptions - - - \ No newline at end of file diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/accountConnection.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/accountConnection.ab.doc.ts deleted file mode 100644 index 6463a5a687..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/accountConnection.ab.doc.ts +++ /dev/null @@ -1,54 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Account connection', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Enable merchants to connect or disconnect their store from external accounts or services.', - - description: `The account connection component is used so merchants can connect or disconnect their store to various accounts. For example, if merchants want to use the Facebook sales channel, they need to connect their Facebook account to their Shopify store. - - | Used to | Examples | - | --- | --- | - | Display connection status | Show if a sales channel is connected or disconnected | - | Allow merchants to disconnect accounts | Enable merchants to disconnect from a marketing platform | - - --- - - - -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: - '/assets/templated-apis-screenshots/admin/patterns/accountConnection.png', - defaultExample: { - codeblock: { - title: 'Account connection', - tabs: [ - { - title: 'html', - code: 'examples/accountConnection.html', - language: 'html', - }, - { - title: 'jsx', - code: 'examples/accountConnection.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/appCard.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/appCard.ab.doc.ts deleted file mode 100644 index a649e82651..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/appCard.ab.doc.ts +++ /dev/null @@ -1,53 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'App card', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Introduce and promote relevant apps to merchants within your app experience.', - description: `App cards provide a consistent layout for presenting another app to merchants. They are used to highlight apps that can extend functionality or help merchants accomplish related tasks. App cards should educate merchants about the value of the suggested app and provide a clear, actionable way to learn more or install it. - - | Used to | Examples | - | --- | --- | - | Suggest complementary apps | Recommend an email marketing app to subscription service users | - | Promote integrations | Highlight a social media scheduler that connects with your app | - | Guide merchants to explore new solutions | Introduce a reporting tool for advanced analytics | - - --- - - - -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/appCard.png', - defaultExample: { - codeblock: { - title: 'App card', - tabs: [ - { - title: 'html', - code: 'examples/appCard.html', - language: 'html', - }, - { - title: 'jsx', - code: 'examples/appCard.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/calloutCard.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/calloutCard.ab.doc.ts deleted file mode 100644 index d50b32bbd7..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/calloutCard.ab.doc.ts +++ /dev/null @@ -1,49 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Callout card', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Encourage merchants to take action on new features or opportunities.', - description: `Callout cards are used to encourage merchants to take an action related to a new feature or opportunity. They are most commonly displayed in the sales channels section of Shopify. - - | Used to | Examples | - | --- | --- | - | Promote new features or integrations | Dismissible feature announcement | - | Drive adoption of app functionality | Common first actions | - --- -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: - '/assets/templated-apis-screenshots/admin/patterns/calloutCard.png', - defaultExample: { - codeblock: { - title: 'Callout card', - tabs: [ - { - title: 'html', - code: 'examples/calloutCard.html', - language: 'html', - }, - { - title: 'jsx', - code: 'examples/calloutCard.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/details.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/details.ab.doc.ts deleted file mode 100644 index fc75f8228b..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/details.ab.doc.ts +++ /dev/null @@ -1,96 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Details', - overviewPreviewDescription: - 'Edit and view objects with efficient dual-column layout.', - description: `The details page allows merchants to view, create and edit objects. Use the right column to provide editable fields, and the right column for supporting information such as status, metadata, and summaries. - - | Used to | Examples | - | --- | --- | - | View, edit and create objects | Discounts, shipping labels, newsletters, templates. | - - ![Preview of the details page pattern](/assets/templated-apis-screenshots/admin/patterns/details-example.png) - - This pattern uses \`Badge\`, \`Box\`, \`Button\`, \`Grid\`, \`Heading\`, \`Image\`, \`Link\`, \`MoneyField\`, \`NumberField\`, \`SearchField\`, \`Section\`, \`Select\`, \`Stack\`, \`Switch\`, \`Table\`, \`TextArea\`, \`TextField\`, \`UnorderedList\`, and \`URLField\` components. - - --- - - ## Design guidelines - Design details pages that enable users to create, view, and edit resource objects. - - ### Navigation - - * Users must be able to return to the previous page without using the browser button. To achieve this, your app can provide breadcrumbs or a Back button on the page. - * Use tabs sparingly for secondary navigation purposes when the nav menu isn't sufficient. - * Clicking a tab should only change the content below it, not above. - * Tabs should never wrap onto multiple lines. - * Navigating between tabs shouldn't cause the tabs to change position or move. - * Offer users clear and predictable action labels. - - --- - - ### Layout - - * Design your app to be responsive and adapt to different screen sizes and devices. This ensures a seamless user experience across various platforms. - * Use looser spacing for low-density layouts. Use tighter spacing for high-density layouts. - * Always use the default width. Full width tends to waste space and make the page harder to parse - * In the primary column: Put information that defines the resource object - * In the secondary column: Put supporting information such as status, metadata, and summaries - * Arrange content in order of importance - * Group similar content in the same card - * Place unique page actions at the top of the actions list and typical object actions at the bottom - - --- - - ### Forms - - * For more than five inputs, use sections with titles in one card or use multiple cards with headers. - * Form inputs should be saved using the App Bridge Contextual Save Bar API. This also applies to forms within max modals. Continuous data validation or auto-save for forms is consistent with the standard Shopify admin save UX. - - --- - - `, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Templates', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/details.png', - defaultExample: { - codeblock: { - title: 'Details', - tabs: [ - { - title: 'html', - code: './examples/details.html', - language: 'html', - }, - { - title: 'jsx', - code: './examples/details.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/emptyState.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/emptyState.ab.doc.ts deleted file mode 100644 index 1800ebbb6a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/emptyState.ab.doc.ts +++ /dev/null @@ -1,48 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Empty state', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Provide guidance and encourage action when no data or items are available.', - description: `Empty states are used when a list, table, or chart has no items or data to show. This is an opportunity to provide explanation or guidance to help merchants progress. The empty state component is intended for use when a full page in the admin is empty, and not for individual elements or areas in the interface. - - | Used to | Examples | - | --- | --- | - | Offer a clear next step when no data is present | Prompt merchants to create their first campaign | - | Encourage activation of features | Suggest setting up a subscription plan when none exist | - --- -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/emptyState.png', - defaultExample: { - codeblock: { - title: 'Empty state', - tabs: [ - { - title: 'Preview', - code: 'examples/emptyState.html', - language: 'preview', - }, - { - title: 'jsx', - code: 'examples/emptyState.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/footerHelp.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/footerHelp.ab.doc.ts deleted file mode 100644 index e1eeea61da..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/footerHelp.ab.doc.ts +++ /dev/null @@ -1,53 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Footer help', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Footer help is used to refer merchants to more information related to the product or feature they’re using.', - - description: `Footer help is used to refer merchants to more information related to the product or feature they’re using. - - | Used to | Examples | - | --- | --- | - | Refer merchants to related help docs | Learn more about [shipping zones]| - | Offer support as a secondary option | [Contact us] about email marketing | - - --- - - - -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/footerHelp.png', - defaultExample: { - codeblock: { - title: 'Footer help', - tabs: [ - { - title: 'Preview', - code: 'examples/footerHelp.html', - language: 'preview', - }, - { - title: 'jsx', - code: 'examples/footerHelp.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/homepage.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/homepage.ab.doc.ts deleted file mode 100644 index 2ff5aab452..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/homepage.ab.doc.ts +++ /dev/null @@ -1,85 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Homepage', - overviewPreviewDescription: - 'Design your app homepage for daily merchant value.', - description: `The app URL specified in the Partner Dashboard should point to your app homepage. The home page of your app is the first thing merchants will see, and it should provide daily value to them. Design the page to provide status updates and show merchants what actions they can take. - - | Used to | Examples | - | --- | --- | - | Teach merchants how to use the app | Onboarding, how-to guides | - | Display app functionalities | Call-to-actions to app features, resource tables | - | Show updates | Status banners, company news | - - ![Preview of the homepage pattern](/assets/templated-apis-screenshots/admin/patterns/homepage-example.png) - - This pattern uses \`Badge\`, \`Banner\`, \`Box\`, \`Button\`, \`Checkbox\`, \`Clickable\`, \`Divider\`, \`Grid\`, \`Heading\`, \`Image\`, \`Link\`, \`Paragraph\`, \`Section\`, \`Stack\`, and \`Text\` components. - - --- - - ## Design guidelines - Your app home page should be designed to provide users with relevant, timely information like quick statistics, status updates, or information that’s immediately actionable. - - ### Onboarding - - The onboarding experience quickly introduces users to your app's essential features. A good onboarding should be self-guided, easy to follow and make users feel they understand how the app works after finishing it. If the onboarding is long or complex, give users the option to complete it at a later time to avoid stopping their workflow. - - * Onboarding must be brief and direct. Provide clear instructions and guide users to completion - * Only request information from users if it's necessary - * If your onboarding isn't essential, then make it dismissible - * Don't have more than five steps in your onboarding process. This can lead users to drop off and not use your app - - --- - - ### Visual design - - * Design your app to be responsive and adapt to different screen sizes and devices. This ensures a seamless user experience across various platforms. - * Use looser spacing for low-density layouts. Use tighter spacing for high-density layouts. - * Use high-resolution photos and images to ensure a professional, high-quality experience. - - --- - - `, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Templates', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/homepage.png', - defaultExample: { - codeblock: { - title: 'Homepage', - tabs: [ - { - title: 'html', - code: './examples/homepage.html', - language: 'html', - }, - { - title: 'jsx', - code: './examples/homepage.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/index.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/index.ab.doc.ts deleted file mode 100644 index 43f8d58265..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/index.ab.doc.ts +++ /dev/null @@ -1,80 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Index', - overviewPreviewDescription: - 'Manage objects efficiently with dynamic table actions.', - description: `The index layout lets merchants view and manage all their objects at once in a table format. They can filter, sort and do quick actions on their objects. To prevent tables from becoming visually cluttered, reveal actions only when the row is hovered over or selected - - | Used to | Examples | - | --- | --- | - | View all objects at once | Products, orders, customers, discounts | - | Perform bulk actions | Delete products, pause/activate campaigns | - - ![Preview of the index pattern](/assets/templated-apis-screenshots/admin/patterns/index-example.png) - - This pattern uses \`Badge\`, \`Box\`, \`Button\`, \`Clickable\`, \`Grid\`, \`Heading\`, \`Image\`, \`Link\`, \`Paragraph\`, \`Section\`, \`Stack\`, and \`Table\` components. - - --- - - ## Design guidelines - Design your index page so users can organize and take action on resource objects. - - ### Navigation - - * Users must be able to return to the previous page without using the browser button. To achieve this, your app can provide breadcrumbs or a Back button on the page. - * Offer users clear and predictable action labels. - - --- - - ### Layout - - * Design your app to be responsive and adapt to different screen sizes and devices. This ensures a seamless user experience across various platforms. - * For resource index pages, use a full-width page. This is helpful when users are dealing with lists of data that have many columns. - - --- - - `, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Templates', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/index.png', - defaultExample: { - codeblock: { - title: 'Index', - tabs: [ - { - title: 'html', - code: './examples/index.html', - language: 'html', - }, - { - title: 'jsx', - code: './examples/index.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/indexTable.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/indexTable.ab.doc.ts deleted file mode 100644 index 8ec068174a..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/indexTable.ab.doc.ts +++ /dev/null @@ -1,57 +0,0 @@ -import {AdminReferenceEntityTemplateSchema} from '../../docs-types'; - -const data: AdminReferenceEntityTemplateSchema = { - name: 'Index table', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Display and manage data with powerful table interactions.', - description: `An index table displays a collection of objects of the same type, like orders or products. The main job of an index table is to help merchants get an at-a-glance of the objects to perform actions or navigate to a full-page representation of it. - | Used to | Examples | - | --- | --- | - | Display collections of similar objects | Products, orders, customers, discounts | - | Perform bulk actions | Delete products, pause/activate campaigns | - --- - - `, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/indexTable.png', - defaultExample: { - codeblock: { - title: 'Index table', - tabs: [ - { - title: 'html', - code: 'examples/indexTable.html', - language: 'html', - }, - { - title: 'jsx', - code: 'examples/indexTable.jsx', - language: 'preview-jsx', - customStyles: { - minHeight: '400px', - }, - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - { - name: 'Table', - subtitle: 'Component', - url: '/docs/api/app-home/polaris-web-components/structure/table', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/interstitialNav.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/interstitialNav.ab.doc.ts deleted file mode 100644 index 17994bd068..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/interstitialNav.ab.doc.ts +++ /dev/null @@ -1,51 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Interstitial nav', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Provide deeper navigation by linking merchants to related pages within a section.', - description: `Interstitial navigation is used to connect merchants to deeper pages—such as settings, features, or resources—within a section of your app. It helps keep navigation clean and focused by avoiding multiple nested items, making it easier for merchants to discover and access important functionality. - - | Used to | Examples | - | --- | --- | - | Link to individual settings pages | Navigate from a settings overview to product settings or notification preferences | - | Connect to feature-specific pages | Direct merchants from campaign overview to reporting or automation setup | - | Guide merchants to supporting resources | Link to help documentation or integration guides from a central section | - | Simplify navigation structure | Reduce clutter by providing access to deeper pages without multi-level menus | - --- -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: - '/assets/templated-apis-screenshots/admin/patterns/interstitialNav.png', - defaultExample: { - codeblock: { - title: 'Interstitial nav', - tabs: [ - { - title: 'html', - code: 'examples/interstitialNav.html', - language: 'html', - }, - { - title: 'jsx', - code: 'examples/interstitialNav.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/mediaCard.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/mediaCard.ab.doc.ts deleted file mode 100644 index 9bb4943df4..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/mediaCard.ab.doc.ts +++ /dev/null @@ -1,52 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Media card', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Present visual information alongside actionable, educational content.', - description: `Media cards provide a consistent layout to present visual information to merchants. Visual media is used to provide additional context to the written information it's paired with. - - | Used to | Examples | - | --- | --- | - | Educate merchants on key actions | Show how to connect a social account with a demo image | - | Provide clear calls to action | Show campaign preview with a "Send campaign" button | - - --- - - - -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/mediaCard.png', - defaultExample: { - codeblock: { - title: 'Media card', - tabs: [ - { - title: 'html', - code: 'examples/mediaCard.html', - language: 'html', - }, - { - title: 'jsx', - code: 'examples/mediaCard.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/metricsCard.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/metricsCard.ab.doc.ts deleted file mode 100644 index a99a91eb91..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/metricsCard.ab.doc.ts +++ /dev/null @@ -1,50 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Metrics card', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Display key metrics, statistics, or trends at a glance.', - description: `Metrics cards are used to highlight important numbers, statistics, or trends from your app, so merchants can quickly understand their activity and performance. - - - | Used to | Examples | - | --- | --- | - | Show app-specific metrics | Email open rates, active subscribers | - | Visualize user engagement | Social media followers, campaign clicks | - --- -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: - '/assets/templated-apis-screenshots/admin/patterns/metricsCard.png', - defaultExample: { - codeblock: { - title: 'Metrics card', - tabs: [ - { - title: 'html', - code: 'examples/metricsCard.html', - language: 'html', - }, - { - title: 'jsx', - code: 'examples/metricsCard.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/resourceList.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/resourceList.ab.doc.ts deleted file mode 100644 index 2b6fb46ba7..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/resourceList.ab.doc.ts +++ /dev/null @@ -1,56 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Resource list', - isOneColumnLayout: false, - overviewPreviewDescription: - 'A resource list displays a collection of objects of the same type, like products or customers. The main job of a resource list is to help merchants find an object and navigate to a full-page representation of it.', - - description: `A resource list displays a collection of objects of the same type, like products or customers. The main job of a resource list is to help merchants find an object and navigate to a full-page representation of it. -. - - | Used to | Examples | - | --- | --- | - | Display collections of similar resources | Campaigns, subscribers, social posts, templates| - | Help merchants find and select items | Search subscribers by email; Filter campaigns by status | - | Perform bulk actions on selected items | Tag subscribers; Archive campaigns; Publish selected posts | - - --- - - - -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: - '/assets/templated-apis-screenshots/admin/patterns/resourceList.png', - defaultExample: { - codeblock: { - title: 'Resource list', - tabs: [ - { - title: 'Preview', - code: 'examples/resourceList.html', - language: 'preview', - }, - { - title: 'jsx', - code: 'examples/resourceList.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/settings.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/settings.ab.doc.ts deleted file mode 100644 index 514eceb982..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/settings.ab.doc.ts +++ /dev/null @@ -1,80 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Settings', - overviewPreviewDescription: - 'Organize settings into categories for easy navigation.', - description: `Make settings pages easy to scan by grouping related information in a logical order. For complex or lengthy settings, organize content into distinct, themed sections that link to their own pages. - | Used to | Examples | - | --- | --- | - | Find and change app settings | Membership settings, app appearance, set up theme blocks | - - ![Preview of the settings pattern](/assets/templated-apis-screenshots/admin/patterns/settings-example.png) - - This pattern uses \`Box\`, \`Button\`, \`ChoiceList\`, \`Clickable\`, \`Divider\`, \`Grid\`, \`Heading\`, \`Icon\`, \`Paragraph\`, \`Section\`, \`Select\`, \`Stack\`, and \`TextField\` components. - - --- - - ## Design guidelines - Design scannable settings pages with groups of related information placed in logical order. - - ### Navigation - - * Users must be able to return to the previous page without using the browser button. To achieve this, your app can provide breadcrumbs or a Back button on the page. - * Offer users clear and predictable action labels. - - --- - - ### Visual design - - Design your app to be responsive and adapt to different screen sizes and devices. This ensures a seamless user experience across various platforms. - - * Use looser spacing for low-density layouts. Use tighter spacing for high-density layouts. - * Use high-resolution photos and images to ensure a professional, high-quality experience. - - --- - - `, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Templates', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/settings.png', - defaultExample: { - codeblock: { - title: 'Settings', - tabs: [ - { - title: 'html', - code: 'examples/settings.html', - language: 'html', - }, - { - title: 'jsx', - code: 'examples/settings.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/patterns/setupGuide.ab.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/patterns/setupGuide.ab.doc.ts deleted file mode 100644 index 0ed9c90ef0..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/components/patterns/setupGuide.ab.doc.ts +++ /dev/null @@ -1,47 +0,0 @@ -import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -const data: ReferenceEntityTemplateSchema = { - name: 'Setup guide', - isOneColumnLayout: false, - overviewPreviewDescription: - 'Guide merchants through onboarding and setup with interactive checklists and progress tracking.', - description: `Setup guide provides an interactive checklist to guide merchants through essential onboarding or configuration tasks. Progress is tracked visually, helping merchants complete all required steps and understand what remains. - | Used to | Examples | - | --- | --- | - | Onboard merchants | Initial app setup | - | Track completion of multi-step processes | Necessary setup steps | - --- -`, - isVisualComponent: true, - category: 'Patterns', - subCategory: 'Compositions', - thumbnail: '/assets/templated-apis-screenshots/admin/patterns/setupGuide.png', - defaultExample: { - codeblock: { - title: 'Setup guide', - tabs: [ - { - title: 'html', - code: 'examples/setupGuide.html', - language: 'html', - }, - { - title: 'jsx', - code: 'examples/setupGuide.jsx', - language: 'preview-jsx', - }, - ], - }, - }, - - related: [ - { - name: 'Built for Shopify', - subtitle: 'Requirements', - url: '/docs/apps/launch/built-for-shopify/requirements', - type: 'component', - }, - ], -}; - -export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/components/shared.d.ts b/packages/ui-extensions/src/surfaces/admin/components/shared.d.ts index 3ff4156348..80377718f3 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/shared.d.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/shared.d.ts @@ -1,4 +1,4 @@ -/** VERSION: 1.38.0 **/ +/** VERSION: 1.25.0 **/ /* eslint-disable @typescript-eslint/ban-types */ @@ -7,35 +7,48 @@ /** * TODO: Update `any` type here after this is resolved * https://github.com/Shopify/ui-api-design/issues/139 + * @publicDocs */ export type ComponentChildren = preact.ComponentChildren; +/** + * @publicDocs + */ export type StringChildren = string; +/** + * @publicDocs + */ export interface GlobalProps { /** * A unique identifier for the element. */ id?: string; } +/** + * @publicDocs + */ export interface ActionProps { /** * The text to use as the Action modal’s title. If not provided, the name of the extension will be used. */ heading?: string; } +/** + * @publicDocs + */ export interface ActionSlots { /** - * The primary action to perform, provided as a button or link type element. + * The primary action element, typically a button or link component representing the main call-to-action. */ primaryAction?: ComponentChildren; /** - * The secondary actions to perform, provided as button or link type elements. + * The secondary action elements, typically button or link components representing alternative or supporting actions. */ secondaryActions?: ComponentChildren; } interface AdminActionProps$1 extends GlobalProps, ActionProps, ActionSlots { /** - * Whether the action is in a loading state, such as initial page load or action opening. - * When true, the action could be in an inert state, which prevents user interaction. + * Whether the action is in a loading state, such as during initial page load or when the action is being opened. + * When `true`, the action might be in an inert state that prevents user interaction. * * @default false */ @@ -43,39 +56,50 @@ interface AdminActionProps$1 extends GlobalProps, ActionProps, ActionSlots { } interface AdminBlockProps$1 extends GlobalProps { /** - * The text to use as the Block title in the block header. If not provided, the name of the - * extension will be used. + * The text displayed as the block's title in the header. If not provided, the extension name will be used. */ heading?: string; /** - * The summary to display when the app block is collapsed. - * Summary longer than 30 characters will be truncated. + * The summary text displayed when the app block is collapsed. Summaries longer than 30 characters will be truncated. */ collapsedSummary?: string; } interface AdminPrintActionProps$1 extends GlobalProps { /** - * Sets the src URL of the preview and the document to print. + * The source URL of the preview and the document to print. * If not provided, the preview will show an empty state and the print button will be disabled. - * HTML, PDFs and images are supported. + * HTML, PDFs, and images are supported. */ src?: string; } +interface AppNavProps$1 extends GlobalProps { + /** + * The navigation items to inject into the external host navigation. + * One child Link is required and represents the home/root navigation item. + * + * @implementation This does not render UI + * @implementation This item is not rendered as a clickable link but configures the home route. + */ + children?: ComponentChildren; +} +/** + * @publicDocs + */ export interface BaseOverlayProps { /** - * Callback fired after the overlay is shown. + * A callback fired immediately after the overlay is shown. */ onShow?: (event: Event) => void; /** - * Callback fired when the overlay is shown **after** any animations to show the overlay have finished. + * A callback fired when the overlay is shown, after any show animations have completed. */ onAfterShow?: (event: Event) => void; /** - * Callback fired after the overlay is hidden. + * A callback fired immediately after the overlay is hidden. */ onHide?: (event: Event) => void; /** - * Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished. + * A callback fired when the overlay is hidden, after any hide animations have completed. */ onAfterHide?: (event: Event) => void; } @@ -86,90 +110,105 @@ export interface BaseOverlayProps { * - Components implementing this interface must provide all methods * - Unlike props/attributes, methods are not rendered in HTML but are JavaScript APIs * - Consumers expect these methods to be consistently available on all instances + * @publicDocs */ export interface BaseOverlayMethods { /** - * Method to show an overlay. + * A method to programmatically show the overlay. * * @implementation This is a method to be called on the element and not a callback and should hence be camelCase */ showOverlay: () => void; /** - * Method to hide an overlay. + * A method to programmatically hide the overlay. * * @implementation This is a method to be called on the element and not a callback and should hence be camelCase */ hideOverlay: () => void; /** - * Method to toggle the visiblity of an overlay. + * A method to programmatically toggle the visibility of the overlay. * * @implementation This is a method to be called on the element and not a callback and should hence be camelCase */ toggleOverlay: () => void; } +/** + * @publicDocs + */ export interface FocusEventProps { /** - * Callback when the element loses focus. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ onBlur?: (event: FocusEvent) => void; /** - * Callback when the element receives focus. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ onFocus?: (event: FocusEvent) => void; } +/** + * @publicDocs + */ export interface ToggleEventProps { /** - * Callback fired when the element state changes **after** any animations have finished. + * A callback fired when the element state changes, after any toggle animations have finished. * * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState). */ onAfterToggle?: (event: ToggleEvent$1) => void; /** - * Callback straight after the element state changes. + * A callback fired immediately when the element state changes, before any animations. * * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about the [toggle event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [ToggleEvent.newState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [ToggleEvent.oldState](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState). */ onToggle?: (event: ToggleEvent$1) => void; } +/** + * @publicDocs + */ export type ToggleState = 'open' | 'closed'; interface ToggleEvent$1 extends Event { readonly newState: ToggleState; readonly oldState: ToggleState; } +/** + * @publicDocs + */ export interface ExtendableEvent extends Event { /** - * Provide a promise that signals the length, and eventual success or failure of actions relating to the event. + * A method that accepts a promise signaling the duration and eventual success or failure of actions relating to the event. * - * This may be called many times, which adds promises to the event. + * This might be called multiple times to add promises to the event. * - * However, this may only be called synchronously during the dispatch of the event. + * However, this might only be called synchronously during the dispatch of the event. * As in, you cannot call it after a `setTimeout` or microtask. */ waitUntil?: (promise: Promise) => void; } +/** + * @publicDocs + */ export interface AggregateError extends Error { errors: T[]; } +/** + * @publicDocs + */ export interface AggregateErrorEvent extends ErrorEvent { error: AggregateError; } +/** + * @publicDocs + */ export type SizeKeyword = | 'small-500' | 'small-400' @@ -184,46 +223,73 @@ export type SizeKeyword = | 'large-300' | 'large-400' | 'large-500'; +/** + * Defines the color intensity or emphasis level for text and UI elements. + * + * - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements. + * - `base`: Primary color for body text, standard UI elements, and general content with good readability. + * - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence. + * + * @publicDocs + */ export type ColorKeyword = 'subdued' | 'base' | 'strong'; interface AvatarProps$1 extends GlobalProps { /** - * Initials to display in the avatar. + * The initials to display in the avatar when no image is provided or fails to load. Typically one or two characters representing a person's first and last name initials (e.g., "JD" for John Doe). */ initials?: string; /** - * 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 + * The URL or path to the avatar image. When provided, the image takes priority over `initials`. If the image is not provided, fails to load, or loads slowly, `initials` will be rendered as a fallback. */ src?: string; /** - * Invoked when load of provided image completes successfully. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload + * A callback fired when the avatar image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload). */ onLoad?: (event: Event) => void; /** - * Invoked on load error of provided image. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror + * A callback fired when the avatar image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror). */ onError?: (event: Event) => void; /** - * Size of the avatar. + * The size of the avatar. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default medium size that works well in most contexts. * * @default 'base' */ size?: SizeKeyword; /** - * An alternative text that describes the avatar for the reader - * to understand what it is about or identify the user the avatar belongs to. + * Alternative text that describes the avatar for accessibility. + * + * Provides a text description of the avatar for users with assistive technology + * and serves as a fallback when the avatar fails to load. A well-written description + * enables people with visual impairments to understand non-text content. + * + * When a screen reader encounters an avatar, it reads this description aloud. + * When an avatar fails to load, this text displays on screen, helping all users + * understand what content was intended. + * + * Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) + * and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt). */ alt?: string; } +/** + * Defines the background color intensity or emphasis level for UI elements. + * + * - `transparent`: No background, allowing the underlying surface to show through. + * - `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment. + * + * @publicDocs + */ export type BackgroundColorKeyword = 'transparent' | ColorKeyword; +/** + * @publicDocs + */ export interface BackgroundProps { /** - * Adjust the background of the element. + * The background color of the element. Use `transparent` for no background, or choose from `subdued`, `base`, or `strong` to apply varying levels of color intensity based on the component's `tone`. + * + * - `transparent`: No background, allowing the underlying surface to show through. + * - `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment. * * @default 'transparent' */ @@ -233,11 +299,12 @@ export interface BackgroundProps { * Tone is a property for defining the color treatment of a component. * * A tone can apply a grouping of colors to a component. For example, - * critical may have a specific text color and background color. + * critical might have a specific text color and background color. * - * In some cases, like for Banner, the tone may also affect the semantic and accessibility treatment of the component. + * In some cases, like for Banner, the tone might also affect the semantic and accessibility treatment of the component. * * @default 'auto' + * @publicDocs */ export type ToneKeyword = | 'auto' @@ -261,7 +328,6 @@ declare const privateIconArray: readonly [ 'alert-octagon-filled', 'alert-triangle', 'alert-triangle-filled', - 'align-horizontal-centers', 'app-extension', 'apps', 'archive', @@ -325,7 +391,6 @@ declare const privateIconArray: readonly [ 'catalog-product', 'categories', 'channels', - 'channels-filled', 'chart-cohort', 'chart-donut', 'chart-funnel', @@ -811,17 +876,47 @@ declare const privateIconArray: readonly [ 'x-circle', 'x-circle-filled', ]; +/** + * @publicDocs + */ export type IconType = (typeof privateIconArray)[number]; /** * Like `Extract`, but ensures that the extracted type is a strict subtype of the input type. + * @publicDocs */ export type ExtractStrict = Extract; +/** + * Represents CSS shorthand properties that accept one to four values. + * Supports specifying values for all four sides: top, right, bottom, and left. + * + * - `T`: Single value that applies to all four sides. + * - `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right). + * - `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom). + * - `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left). + * @publicDocs + */ export type MaybeAllValuesShorthandProperty = | T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`; +/** + * Represents CSS shorthand properties that accept one or two values. + * Supports specifying the same value for both dimensions or different values. + * + * - `T`: Single value that applies to both dimensions. + * - `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal). + * @publicDocs + */ export type MaybeTwoValuesShorthandProperty = T | `${T} ${T}`; +/** + * Makes a property responsive by allowing it to be set conditionally based on container query conditions. + * The value can be either a base value or a container query string. + * + * - `T`: Base value that applies in all conditions. + * - `@container${string}`: Container query string for conditional responsive styling based on container size. + * @publicDocs + */ export type MaybeResponsive = T | `@container${string}`; /** * Prevents widening string literal types in a union to `string`. @@ -830,6 +925,7 @@ export type MaybeResponsive = T | `@container${string}`; * // ^? string * type PropName = 'foo' | 'bar' | (string & {}) * // ^? 'foo' | 'bar' | (string & {}) + * @publicDocs */ export type AnyString = string & {}; /** @@ -837,37 +933,50 @@ export type AnyString = string & {}; * to have a space or not in the string literal types. * * For example in the `aspectRatio` property, `16/9` and `16 / 9` are both valid. + * @publicDocs */ export type optionalSpace = '' | ' '; interface BadgeProps$1 extends GlobalProps { /** - * The content of the Badge. + * The text or elements displayed inside the badge component. */ children?: ComponentChildren; /** - * Sets the tone of the Badge, based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the component. + * + * - `auto`: Automatically determined based on context. + * - `neutral`: General information without specific intent. + * - `info`: Informational content or helpful tips. + * - `success`: Positive outcomes or successful states. + * - `caution`: Advisory notices that need attention. + * - `warning`: Important warnings about potential issues. + * - `critical`: Urgent problems or destructive actions. * * @default 'auto' */ tone?: ToneKeyword; /** - * Modify the color to be more or less intense. + * Controls the visual weight and emphasis of the badge. + * + * - `base`: Standard weight with moderate emphasis, suitable for most use cases. + * - `strong`: Increased visual weight for higher emphasis and prominence. * * @default 'base' */ color?: ColorKeyword; /** - * The type of icon to be displayed in the badge. + * An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. + * Accepts any icon name from the icon library or a custom string identifier. * * @default '' */ icon?: IconType | AnyString; /** - * The position of the icon in relation to the text. + * The position of the icon relative to the badge text. Use `start` to place the icon before the text, or `end` to place it after. */ iconPosition?: 'start' | 'end'; /** - * Adjusts the size. + * The size of the badge. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size. * * @default 'base' */ @@ -875,42 +984,42 @@ interface BadgeProps$1 extends GlobalProps { } interface BannerProps$1 extends GlobalProps, ActionSlots { /** - * The title of the banner. + * The heading text displayed at the top of the banner to summarize the message or alert. * * @default '' */ heading?: string; /** - * The content of the Banner. + * The main content displayed within the banner component, typically descriptive text or other elements providing details about the message or alert. */ children?: ComponentChildren; /** - * 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. + * The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected. * - * - `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. + * - `auto`: Automatically determined based on context. + * - `neutral`: General status information without emphasis. + * - `info`: Informational content or helpful tips. + * - `success`: Positive outcomes or successful states. + * - `caution`: Situations that need attention but aren't urgent. + * - `warning`: Important warnings about potential issues. + * - `critical`: Urgent problems or destructive actions. * - * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions - * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role - * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role + * The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/alert_role) that is announced by screen readers immediately. The `neutral`, `info`, `success`, `warning`, and `caution` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Roles/status_role) that is announced by screen readers after the current message. * * @default 'auto' */ tone?: ToneKeyword; /** - * Makes the content collapsible. - * A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them. + * Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them. * * @default false */ collapsible?: boolean; /** - * Determines whether the close button of the banner is present. + * Whether the banner displays a close button that allows users to dismiss it. * * When the close button is pressed, the `dismiss` event will fire, - * then `hidden` will be true, + * then `hidden` will be set to `true`, * any animation will complete, * and the `afterhide` event will fire. * @@ -918,17 +1027,17 @@ interface BannerProps$1 extends GlobalProps, ActionSlots { */ dismissible?: boolean; /** - * Event handler when the banner is dismissed by the user. + * A callback that fires when the banner is dismissed by the user clicking the close button. * - * This does not fire when setting `hidden` manually. + * This doesn't fire when setting `hidden` manually. * - * The `hidden` property will be `false` when this event fires. + * The `hidden` property is `false` when this event fires. */ onDismiss?: (event: Event) => void; /** - * Event handler when the banner has fully hidden. + * A callback that fires when the banner has fully hidden, including after any hide animations have completed. * - * The `hidden` property will be `true` when this event fires. + * The `hidden` property is `true` when this event fires. * * @implementation If implementations animate the hiding of the banner, * this event must fire after the banner has fully hidden. @@ -936,18 +1045,20 @@ interface BannerProps$1 extends GlobalProps, ActionSlots { */ onAfterHide?: (event: Event) => void; /** - * Determines whether the banner is hidden. + * Controls whether the banner is visible or 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. + * When using a controlled component pattern and the banner is `dismissible`, + * update this property to `true` when the `dismiss` event fires. * - * If the banner is not `dismissible`, it can still be hidden by setting this property. + * You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`. * * @default false */ hidden?: boolean; } +/** + * @publicDocs + */ export interface DisplayProps { /** * Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). @@ -955,11 +1066,15 @@ export interface DisplayProps { * - `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. * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display + * Learn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display). + * * @default 'auto' */ display?: MaybeResponsive<'auto' | 'none'>; } +/** + * @publicDocs + */ export interface AccessibilityRoleProps { /** * Sets the semantic meaning of the component’s content. When set, @@ -973,6 +1088,37 @@ export interface AccessibilityRoleProps { */ accessibilityRole?: AccessibilityRole; } +/** + * Defines the semantic role of a component for assistive technologies like screen readers. + * + * Accessibility roles help users with disabilities understand the purpose and structure of content. + * These roles map to HTML elements and ARIA roles, providing semantic meaning beyond visual presentation. + * + * Use these roles to: + * - Improve navigation for screen reader users + * - Provide semantic structure to your UI + * - Ensure proper interpretation by assistive technologies + * + * Learn more about [ARIA roles](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles) in the MDN web docs. + * + * - `main`: Indicates the primary content area of the page. + * - `header`: Marks a component as a header containing introductory content or navigation. + * - `footer`: Designates content containing information like copyright, navigation links, or privacy statements. + * - `section`: Defines a generic thematic grouping of content that should have a heading or accessible label. + * - `aside`: Marks supporting content that relates to but is separate from the main content. + * - `navigation`: Identifies major groups of navigation links for moving around the site or page. + * - `ordered-list`: Represents a list where the order of items is meaningful. + * - `list-item`: Identifies an individual item within a list. + * - `list-item-separator`: Acts as a visual and semantic divider between items in a list. + * - `unordered-list`: Represents a list where the order of items is not meaningful. + * - `separator`: Creates a divider that separates and distinguishes sections of content. + * - `status`: Defines a live region for advisory information that is not urgent enough to be an alert. + * - `alert`: Marks important, time-sensitive information that requires the user's immediate attention. + * - `generic`: Creates a semantically neutral container element with no inherent meaning. + * - `presentation`: Removes semantic meaning from an element while preserving its visual appearance. + * - `none`: Synonym for `presentation`, removes semantic meaning while keeping visual styling. + * @publicDocs + */ export type AccessibilityRole = /** * Used to indicate the primary content. @@ -997,21 +1143,13 @@ export type AccessibilityRole = | 'footer' /** * Used to indicate a generic section. - * Sections should always have a `Heading` or an accessible name provided in the `accessibilityLabel` property. + * Sections should always have a heading or an accessible name provided in the `accessibilityLabel` property. * * In an HTML host `section` will render a `
` element. * Learn more about the [`
` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/section) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/region_role) in the MDN web docs. * */ | 'section' - /** - * Used to identify a perceivable section containing content that is relevant to a specific, author-specified purpose and sufficiently important that users will likely want to be able to navigate to the section easily. - * - * In an HTML host `region` will render as `
`. - * A region **must** have an accessible name provided via the `accessibilityLabel` property. - * Learn more about the [`region` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/region_role) in the MDN web docs. - */ - | 'region' /** * Used to designate a supporting section that relates to the main content. * @@ -1096,24 +1234,33 @@ export type AccessibilityRole = * Learn more about the [`none` role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/none_role) in the MDN web docs. */ | 'none'; +/** + * @publicDocs + */ export interface AccessibilityVisibilityProps { /** - * Changes the visibility of the element. + * Controls the visibility of the element for both visual and assistive technology users. * - * - `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. + * - `visible`: The element is visible to all users (both sighted users and screen readers). + * - `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information. + * - `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context. * * @default 'visible' */ accessibilityVisibility?: 'visible' | 'hidden' | 'exclusive'; } +/** + * @publicDocs + */ export interface LabelAccessibilityVisibilityProps { /** - * Changes the visibility of the component's label. + * Controls whether the label is visible to all users or only to screen readers. + * + * - `visible`: The label is shown to everyone (default). + * - `exclusive`: The label is visually hidden but still announced by screen readers. * - * - `visible`: the label is visible to all users. - * - `exclusive`: the label is visually hidden but remains in the accessibility tree. + * Use `exclusive` when the surrounding context makes the label redundant visually, + * but screen reader users still need it for clarity. * * @default 'visible' */ @@ -1122,35 +1269,42 @@ export interface LabelAccessibilityVisibilityProps { 'visible' | 'exclusive' >; } +/** + * Defines the padding size for elements, using the standard size scale or `none` for no padding. + * + * - `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing. + * - `none`: No padding. + * @publicDocs + */ export type PaddingKeyword = SizeKeyword | 'none'; +/** + * @publicDocs + */ export interface PaddingProps { /** - * 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: + * The padding applied to all edges of the component. * - * - 4 values: `block-start inline-end block-end inline-start` - * - 3 values: `block-start inline block-end` - * - 2 values: `block inline` + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values: + * - 1 value applies to all sides + * - 2 values apply to block (top/bottom) and inline (left/right) + * - 3 values apply to block-start (top), inline (left/right), and block-end (bottom) + * - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) * - * 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`. + * **Examples:** `base`, `large none`, `base large-100 base small` * - * A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. + * Use `auto` to inherit padding from the nearest container with removed padding. * * @default 'none' */ padding?: MaybeResponsive>; /** - * Adjust the block-padding. + * The block-direction padding (top and bottom in horizontal writing modes). * - * - `large none` means block-start padding is `large`, block-end padding is `none`. + * Accepts a single value for both sides or two space-separated values for block-start and block-end. * - * This overrides the block value of `padding`. + * **Example:** `large none` applies `large` to the top and `none` to the bottom. + * + * Overrides the block value from `padding`. * * @default '' - meaning no override */ @@ -1158,27 +1312,29 @@ export interface PaddingProps { MaybeTwoValuesShorthandProperty | '' >; /** - * Adjust the block-start padding. + * The block-start padding (top in horizontal writing modes). * - * This overrides the block-start value of `paddingBlock`. + * Overrides the block-start value from `paddingBlock`. * * @default '' - meaning no override */ paddingBlockStart?: MaybeResponsive; /** - * Adjust the block-end padding. + * The block-end padding (bottom in horizontal writing modes). * - * This overrides the block-end value of `paddingBlock`. + * Overrides the block-end value from `paddingBlock`. * * @default '' - meaning no override */ paddingBlockEnd?: MaybeResponsive; /** - * Adjust the inline padding. + * The inline-direction padding (left and right in horizontal writing modes). + * + * Accepts a single value for both sides or two space-separated values for inline-start and inline-end. * - * - `large none` means inline-start padding is `large`, inline-end padding is `none`. + * **Example:** `large none` applies `large` to the left and `none` to the right. * - * This overrides the inline value of `padding`. + * Overrides the inline value from `padding`. * * @default '' - meaning no override */ @@ -1186,101 +1342,134 @@ export interface PaddingProps { MaybeTwoValuesShorthandProperty | '' >; /** - * Adjust the inline-start padding. + * The inline-start padding (left in LTR writing modes, right in RTL). * - * This overrides the inline-start value of `paddingInline`. + * Overrides the inline-start value from `paddingInline`. * * @default '' - meaning no override */ paddingInlineStart?: MaybeResponsive; /** - * Adjust the inline-end padding. + * The inline-end padding (right in LTR writing modes, left in RTL). * - * This overrides the inline-end value of `paddingInline`. + * Overrides the inline-end value from `paddingInline`. * * @default '' - meaning no override */ paddingInlineEnd?: MaybeResponsive; } +/** + * Represents size values in pixels, percentages, or zero. + * + * - `${number}px`: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`). + * - `${number}%`: Relative size as a percentage of the parent container (such as `50%`, `100%`). + * - `0`: Zero size, equivalent to no dimension. + * @publicDocs + */ export type SizeUnits = `${number}px` | `${number}%` | `0`; +/** + * Represents size values that can also be set to `auto` for automatic sizing. + * + * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control. + * - `auto`: Automatically sizes based on content and layout constraints. + * @publicDocs + */ export type SizeUnitsOrAuto = SizeUnits | 'auto'; +/** + * Represents size values that can also be set to `none` to remove the size constraint. + * + * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control. + * - `none`: No size constraint, allowing unlimited growth. + * @publicDocs + */ export type SizeUnitsOrNone = SizeUnits | 'none'; +/** + * @publicDocs + */ export interface SizingProps { /** - * Adjust the block size. + * The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/block-size + * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control. + * - `auto`: Automatically sizes based on content and layout constraints. * * @default 'auto' */ blockSize?: MaybeResponsive; /** - * Adjust the minimum block size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size + * The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size). * * @default '0' */ minBlockSize?: MaybeResponsive; /** - * Adjust the maximum block size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size + * The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size). * * @default 'none' */ maxBlockSize?: MaybeResponsive; /** - * Adjust the inline size. + * The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size + * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control. + * - `auto`: Automatically sizes based on content and layout constraints. * * @default 'auto' */ inlineSize?: MaybeResponsive; /** - * Adjust the minimum inline size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size + * The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size). * * @default '0' */ minInlineSize?: MaybeResponsive; /** - * Adjust the maximum inline size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size + * The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size). * * @default 'none' */ maxInlineSize?: MaybeResponsive; } +/** + * @publicDocs + */ export type BorderStyleKeyword = | 'none' | 'solid' | 'dashed' | 'dotted' | 'auto'; +/** + * Defines the width of borders, using the standard size scale or `none` for no border. + * + * - `SizeKeyword`: Standard border widths from the size scale for consistent thickness. + * - `none`: No border width (removes the border). + * @publicDocs + */ export type BorderSizeKeyword = SizeKeyword | 'none'; +/** + * @publicDocs + */ export type BorderRadiusKeyword = SizeKeyword | 'max' | 'none'; /** * Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style. + * @publicDocs */ export type BorderShorthand = | BorderSizeKeyword | `${BorderSizeKeyword} ${ColorKeyword}` | `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`; +/** + * @publicDocs + */ export interface BorderProps { /** - * 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`. + * Applies a border using shorthand syntax to specify width, color, and style in a single property. * - * If the style is not specified, it will be `auto`. + * Accepts a size value, optionally followed by a color, optionally followed by a style. + * Omitted values use defaults: color defaults to `base`, style defaults to `auto`. * - * Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`. + * Individual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here. * * @example * // The following are equivalent: @@ -1291,82 +1480,85 @@ export interface BorderProps { */ border?: BorderShorthand; /** - * Set the width of the border. - * - * If set, it takes precedence over the `border` property's width. - * - * Like CSS, up to 4 values can be specified. - * - * If one value is specified, it applies to all sides. - * - * If two values are specified, they apply to the block sides and inline sides respectively. + * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property. * - * If three values are specified, they apply to the block-start, both inline sides, and block-end respectively. + * - `small`: Thin border for subtle definition. + * - `small-100`: Extra thin border for minimal emphasis. + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `none`: No border. * - * If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively. + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side: + * - One value: applies to all sides + * - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively + * - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively + * - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively * * @default '' - meaning no override */ borderWidth?: MaybeAllValuesShorthandProperty | ''; /** - * Set the style of the border. + * Controls the visual style of the border on all sides, such as solid, dashed, or dotted. * - * If set, it takes precedence over the `border` property's style. + * When set, this overrides the style value specified in the `border` property. * - * Like CSS, up to 4 values can be specified. - * - * If one value is specified, it applies to all sides. - * - * If two values are specified, they apply to the block sides and inline sides respectively. - * - * If three values are specified, they apply to the block-start, both inline sides, and block-end respectively. - * - * If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively. + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side: + * - One value: applies to all sides + * - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively + * - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively + * - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively * * @default '' - meaning no override */ borderStyle?: MaybeAllValuesShorthandProperty | ''; /** - * Set the color of the border. + * Controls the color of the border using the design system's color scale. * - * If set, it takes precedence over the `border` property's color. + * When set, this overrides the color value specified in the `border` property. + * Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed. * * @default '' - meaning no override */ borderColor?: ColorKeyword | ''; /** - * Set the radius of the border. + * Controls the roundedness of the element's corners using the design system's radius scale. * - * [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: + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values: + * - One value: applies to all corners + * - Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively + * - Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively + * - Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively * - * - 4 values: `start-start start-end end-end end-start` - * - 3 values: `start-start (start-end & end-start) start-end` - * - 2 values: `(start-start & end-end) (start-end & end-start)` - * - * For example: - * - `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`. - * - `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`. - * - `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`. - * - `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`. + * Examples: + * - `small-100`: All corners have `small-100` radius + * - `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none` + * - `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100` + * - `small-100 none large-100 base`: Each corner has its specified radius value * * @defaultValue 'none' */ borderRadius?: MaybeAllValuesShorthandProperty; } +/** + * @publicDocs + */ export interface OverflowProps { /** * Sets the overflow behavior of the element. * + * - `visible`: the content that extends beyond the element’s container is visible. * - `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. * * @default 'visible' */ overflow?: 'hidden' | 'visible'; } +/** + * @publicDocs + */ export interface BaseBoxProps extends AccessibilityVisibilityProps, BackgroundProps, @@ -1376,70 +1568,72 @@ export interface BaseBoxProps BorderProps, OverflowProps { /** - * The content of the Box. + * The content of the box. */ children?: ComponentChildren; /** - * 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. + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. */ accessibilityLabel?: string; } +/** + * @publicDocs + */ export interface BaseBoxPropsWithRole extends BaseBoxProps, AccessibilityRoleProps {} interface BoxProps$1 extends BaseBoxPropsWithRole, GlobalProps {} +/** + * @publicDocs + */ export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps { /** - * The behavior of the Button. + * The behavioral type of the button component, which determines what action it performs when activated. * - * - `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). + * - `submit`: Submits the nearest containing form. + * - `button`: Performs no default action, relying on the `onClick` handler for behavior. + * - `reset`: Resets all fields in the nearest containing form to their default values. * - * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set. + * This property is ignored if `href` or `commandFor`/`command` is set. * * @default 'button' */ type?: 'submit' | 'button' | 'reset'; /** - * Callback when the Button is activated. - * This will be called before the action indicated by `type`. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event + * A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event). */ onClick?: (event: Event) => void; /** - * Disables the Button meaning it cannot be clicked or receive focus. + * Whether the button is disabled, preventing it from being clicked or receiving focus. * * @default false */ disabled?: boolean; /** - * Replaces content with a loading indicator while a background action is being performed. - * - * This also disables the Button. + * Whether the button is in a loading state, which replaces the button content with a loading indicator and disables interactions. * * @default false */ loading?: boolean; } +/** + * @publicDocs + */ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps { /** - * 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. + * The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation. */ href?: string; /** * Specifies where to display the linked URL. * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target + * Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target). * - * 'auto': The target is automatically determined based on the origin of the URL. + * - `auto`: The target is automatically determined based on the origin of the URL. + * - `_blank`: Opens the URL in a new window or tab. + * - `_self`: Opens the URL in the same browsing context as the current one. + * - `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`. + * - `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`. * * @implementation Surfaces can set specific rules on how they handle each URL. * @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases. @@ -1449,187 +1643,186 @@ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps { */ target?: 'auto' | '_blank' | '_self' | '_parent' | '_top' | AnyString; /** - * 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. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download + * A filename that causes the browser to treat the linked URL as a download. Downloads only work for same-origin URLs or the `blob:` and `data:` schemes. Learn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download). */ download?: string; /** - * Callback when the link is activated. - * This will be called before navigating to the location specified by `href`. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event + * A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event). */ onClick?: (event: Event) => void; } +/** + * @publicDocs + */ export interface InteractionProps { /** - * 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. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor + * The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [commandfor attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor). */ commandFor?: string; /** - * Sets the action the `commandFor` should take when this clickable is activated. + * The action that the `commandFor` target should take when this component is activated. The supported actions vary by target component type. * - * See the documentation of particular components for the actions they support. + * - `--auto`: Performs the default action appropriate for the target component. + * - `--show`: Displays the target component if it's currently hidden. + * - `--hide`: Conceals the target component from view. + * - `--toggle`: Alternates the target component between visible and hidden states. + * - `--copy`: Copies the content of the target `ClipboardItem` to the system clipboard. * - * - `--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. + * Learn more about the [command attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command). * * @default '--auto' - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command */ command?: '--auto' | '--show' | '--hide' | '--toggle' | '--copy'; /** - * ID of a component that should respond to interest (e.g. hover and focus) on this component. + * The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information. */ interestFor?: string; } +/** + * @publicDocs + */ export interface BaseClickableProps extends ButtonBehaviorProps, LinkBehaviorProps {} interface ButtonProps$1 extends GlobalProps, BaseClickableProps { /** - * 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. + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. */ accessibilityLabel?: string; /** - * The content of the Button. + * The content displayed within the button component. */ children?: ComponentChildren; /** - * The type of icon to be displayed in the Button. + * An icon displayed inside the button, typically positioned before the button text. + * Use icons to help users quickly identify the button's action or to improve scannability. + * Accepts any icon name from the icon library or a custom string identifier. * * @default '' */ icon?: IconType | AnyString; /** - * The displayed inline width of the Button. + * The inline width (horizontal size) of the button component. * - * - `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. + * - `auto`: The button size depends on the surface and context. + * - `fill`: The button takes up 100% of the available inline space. + * - `fit-content`: The button takes up only the space needed to fit its content. * * @default 'auto' */ inlineSize?: 'auto' | 'fill' | 'fit-content'; /** - * Changes the visual appearance of the Button. + * The visual style variant of the button component, which controls its prominence and emphasis in the interface. * - * @default 'auto' - the variant is automatically determined by the Button's context + * @default 'auto' - the variant is automatically determined by the button's context */ variant?: 'auto' | 'primary' | 'secondary' | 'tertiary'; /** - * Sets the tone of the Button based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the component. + * + * - `critical`: Urgent problems or destructive actions. + * - `auto`: Automatically determined based on context. + * - `neutral`: General information without specific intent. * * @default 'auto' */ tone?: ToneKeyword; /** - * 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) + * The language of the button's text content. Use this when the button text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label). */ lang?: string; } interface ButtonGroupProps$1 extends GlobalProps, ActionSlots { /** - * The content of the ButtonGroup. + * The content of the button group, typically a collection of button or link components. */ children?: ComponentChildren; /** - * The gap between elements. + * The spacing between button elements within the group. + * * @default 'base' */ gap?: 'base' | 'none'; /** - * Label for the button group that describes the content of the group for screen reader users to understand what's included. + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. * * @implementation Used as a hidden heading or an aria-label on the wrapping element. */ accessibilityLabel?: string; } +/** + * @publicDocs + */ export interface BaseInputProps { /** - * An identifier for the field that is unique within the nearest containing form. + * The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form. */ name?: string; /** - * Disables the field, disallowing any interaction. + * Whether the field is disabled, preventing any user interaction. * * @default false */ disabled?: boolean; } +/** + * @publicDocs + */ export interface InputProps extends BaseInputProps { /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * A callback fired when the user has finished editing the field, such as when they blur the field or press Enter. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ onChange?: (event: Event) => void; /** - * Callback when the user makes any changes in the field. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * A callback fired when the user makes any changes in the field, such as typing a character. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). */ onInput?: (event: Event) => void; /** - * The current value for the field. If omitted, the field will be empty. + * The current value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. */ value?: string; /** - * The default value for the field. + * The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. After the user starts typing, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value, use `value` instead. * * @implementation `defaultValue` reflects to the `value` attribute. */ defaultValue?: string; } +/** + * @publicDocs + */ export interface MultipleInputProps extends BaseInputProps { /** - * Callback when the user has selected option(s). - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * A callback fired when the user has selected one or more options. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ onChange?: (event: Event) => void; /** - * Callback when the user has selected option(s). - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * A callback fired when the user selects or deselects options. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). */ onInput?: (event: Event) => void; /** - * An array of the `value`s of the selected options. + * An array of `value` attributes for the currently selected options. * - * This is a convenience prop for setting the `selected` prop on child options. + * When provided, this property automatically sets the `selected` state on child Option components that have matching `value` attributes. Options with values included in this array will be marked as selected, while others will be unselected. */ values?: string[]; } +/** + * @publicDocs + */ export interface FileInputProps extends BaseInputProps { /** - * Callback when the user has **finished selecting** a file or files. + * A callback fired when the user has finished selecting one or more files. */ onChange?: (event: Event) => void; /** - * Callback when the user makes any changes in the file selection. + * A callback fired when the user makes any changes to the file selection. */ onInput?: (event: Event) => void; /** * 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. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value + * The value is always the file's name prefixed with "C:\fakepath\", which isn't the real path of the file. Learn more about the [file input value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file#value). * * @default '' */ @@ -1644,81 +1837,81 @@ export interface FileInputProps extends BaseInputProps { */ files?: ReadonlyArray; } +/** + * @publicDocs + */ export interface FieldErrorProps { /** - * Indicate an error to the user. The field will be given a specific stylistic treatment - * to communicate problems that have to be resolved immediately. + * An error message to display to the user. When set, the field will be styled with error indicators to communicate problems that need to be resolved immediately. */ error?: string; } +/** + * @publicDocs + */ export interface BasicFieldProps extends FieldErrorProps, LabelAccessibilityVisibilityProps { /** - * 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. + * Whether the field requires a value before form submission. Displays a visual indicator and adds semantic meaning, but doesn't automatically validate or show errors. Use the `error` property to display validation messages. * * @default false */ required?: boolean; /** - * Content to use as the field label. + * The text label displayed above or alongside the field to describe its purpose. */ label?: string; } +/** + * @publicDocs + */ export interface FieldDetailsProps { /** - * 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. + * Additional helpful text displayed alongside the field to provide context, guidance, or instructions to the user. This content is accessible to both visual and screen reader users. */ details?: string; } +/** + * @publicDocs + */ export interface FieldProps extends BasicFieldProps, InputProps, FocusEventProps, FieldDetailsProps { /** - * A short hint that describes the expected value of the field. + * The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value. Unlike `defaultValue`, this is a temporary value that disappears after the user starts typing. */ placeholder?: string; } +/** + * @publicDocs + */ export interface BaseTextFieldProps extends FieldProps { /** - * The field cannot be edited by the user. It is focusable will be announced by screen readers. + * Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers. * * @default false */ readOnly?: boolean; } +/** + * @publicDocs + */ export interface FieldDecorationProps { /** - * 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. + * A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`. * - * 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. + * This text can't be edited by the user and is not included in the field's value. The suffix might not appear until the user interacts with the field. For example, an inline label might occupy the suffix position until the user focuses the field. * * @default '' */ suffix?: string; /** - * A value to be displayed immediately before the editable portion of the field. + * A non-editable text value 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 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. + * This text can't be edited by the user and is not included in the field's value. The prefix might not appear until the user interacts with the field. For example, an inline label might occupy the prefix position until the user focuses the field. * * @default '' */ @@ -1730,28 +1923,28 @@ export interface FieldDecorationProps { */ icon?: IconType | AnyString; /** - * Additional content to be displayed in the field. - * Commonly used to display an icon that activates a tooltip providing more information. + * Additional interactive content displayed within the field. + * + * Accepts Button and Clickable components with text content only. Commonly used for actions like clearing the field or opening additional information. */ accessory?: ComponentChildren; } +/** + * @publicDocs + */ export interface NumberConstraintsProps { /** - * The highest decimal or integer to be accepted for the field. - * When used with `step` the value will round down to the max number. + * The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum 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. + * Users can still type values higher than the maximum using the keyboard. Implement validation to enforce this constraint. * * @default Infinity */ max?: number; /** - * The lowest decimal or integer to be accepted for the field. - * When used with `step` the value will round up to the min number. + * The lowest decimal or integer value accepted for the field. When used with `step`, the value rounds up to the minimum 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. + * Users can still type values lower than the minimum using the keyboard. Implement validation to enforce this constraint. * * @default -Infinity */ @@ -1777,46 +1970,54 @@ export interface NumberConstraintsProps { */ controls?: 'auto' | 'stepper' | 'none'; } +/** + * @publicDocs + */ export interface MinMaxLengthProps { /** - * Specifies the maximum number of characters allowed. + * The maximum number of characters allowed in the field. * * @default Infinity */ maxLength?: number; /** - * Specifies the min number of characters allowed. + * The minimum number of characters required in the field. * * @default 0 */ minLength?: number; } +/** + * @publicDocs + */ export interface BaseSelectableProps { /** - * 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. + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. */ accessibilityLabel?: string; /** - * Disables the control, disallowing any interaction. + * Whether the control is disabled, preventing any user interaction. * * @default false */ disabled?: boolean; /** - * The value used in form data when the control is checked. + * The value submitted with form data when the control is checked or selected. */ value?: string; } +/** + * @publicDocs + */ export interface BaseOptionProps extends BaseSelectableProps { /** - * Whether the control is active. + * Whether the option is currently selected. * * @default false */ selected?: boolean; /** - * Whether the control is active by default. + * Whether the option is selected by default when first rendered. * * @implementation `defaultSelected` reflects to the `selected` attribute. * @@ -1824,21 +2025,24 @@ export interface BaseOptionProps extends BaseSelectableProps { */ defaultSelected?: boolean; } +/** + * @publicDocs + */ export interface BaseCheckableProps extends BaseSelectableProps, InteractionProps { /** - * Visual content to use as the control label. + * The visual text label displayed alongside the control to describe its purpose. */ label?: string; /** - * Whether the control is active. + * Whether the control is currently checked (for checkboxes) or toggled on (for switches). * * @default false */ checked?: boolean; /** - * Whether the control is active by default. + * Whether the control is checked by default when first rendered. * * @implementation `defaultChecked` reflects to the `checked` attribute. * @@ -1846,20 +2050,15 @@ export interface BaseCheckableProps */ defaultChecked?: boolean; /** - * An identifier for the control that is unique within the nearest - * containing `Form` component. + * The name attribute for the control, which must be unique within the nearest containing Form component. This name is used to identify the control's value when the form is submitted. */ name?: string; /** - * A callback that is run whenever the control is changed. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * A callback fired when the control's value changes. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ onChange?: (event: Event) => void; /** - * A callback that is run whenever the control is changed. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * A callback fired when the control's value changes. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). */ onInput?: (event: Event) => void; } @@ -1869,22 +2068,21 @@ interface CheckboxProps$1 FieldErrorProps, FieldDetailsProps { /** - * Whether to display the checkbox in an indeterminate state (neither checked or unchecked). + * Whether the checkbox displays in an indeterminate state (neither checked nor unchecked), typically used to indicate partial selection in hierarchical lists. * - * In terms of appearance, this takes priority over the `checked` prop. - * But this is purely a visual change. - * Whether the value is submitted along with a form is still down to the `checked` prop. + * This visual state takes priority over the `checked` prop in appearance only. + * The form submission value is still determined by the `checked` prop. * - * If `indeterminate` has not been explicitly set, and the `indeterminate` state hasn't been modified by the user (via clicking), - * then `indeterminate` returns the value of `defaultIndeterminate`. + * If `indeterminate` has not been explicitly set and hasn't been modified by user interaction, + * it returns the value of `defaultIndeterminate`. * * @implementation The `indeterminate` property doesn't reflect to any attribute. */ indeterminate?: boolean; /** - * Whether the checkbox is in an `indeterminate` state by default. + * Whether the checkbox is in an indeterminate state by default when first rendered. * - * Similar to `defaultValue` and `defaultChecked`, this value applies until `indeterminate` is set, or user changes the state of the checkbox. + * Similar to `defaultValue` and `defaultChecked`, this value applies until `indeterminate` is explicitly set or the user changes the checkbox state. * * @implementation `defaultIndeterminate` reflects to the `indeterminate` attribute. * @@ -1892,73 +2090,41 @@ interface CheckboxProps$1 */ defaultIndeterminate?: boolean; /** - * 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. + * Whether the checkbox must be checked before form submission. This adds semantic meaning and typically displays a visual indicator, but does not automatically validate or show errors. Use the `error` property to display validation messages. * * @default false */ required?: boolean; } +/** + * @publicDocs + */ export interface ChipProps$1 extends GlobalProps { /** - * The content of the chip. + * The text content displayed within the chip. */ children?: ComponentChildren; /** - * The graphic to display inside of the chip. + * The graphic element (typically an icon) displayed inside the chip. * * @implementation Only `s-icon` is supported. */ graphic?: ComponentChildren; /** - * A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers. + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. */ accessibilityLabel?: string; /** - * Modify the color to be more or less intense. + * The color intensity of the chip. Use `subdued` for less intense, `base` for standard, or `strong` for more intense coloring. * * @default 'base' */ color?: ColorKeyword; - /** - * Whether the chip is removable. - * - * @default false - */ - removable?: boolean; - /** - * Callback when the chip is removed. - */ - onRemove?: (event: Event) => void; - /** - * 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. - * - * @default false - */ - hidden?: boolean; - /** - * Event handler when the chip has fully hidden. - * - * The `hidden` property will be `true` when this event fires. - * - * @implementation If implementations animate the hiding of the chip, - * this event must fire after the chip has fully hidden. - * We can add an `onHide` event in future if we want to provide a hook for the start of the animation. - */ - onAfterHide?: (event: Event) => void; } interface ChipProps$2 extends ChipProps$1, GlobalProps {} interface ChoiceProps$1 extends GlobalProps, BaseOptionProps { /** - * Content to use as the choice label. + * The content displayed as the choice label. * * @implementation (StringChildren) The label is produced by extracting and * concatenating the text nodes from the provided content; any markup or @@ -1970,28 +2136,23 @@ interface ChoiceProps$1 extends GlobalProps, BaseOptionProps { */ children?: ComponentChildren | StringChildren; /** - * 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. + * Additional helpful text displayed alongside the choice to provide context, guidance, or instructions to the user. * * @implementation this content should be linked to the input with an `aria-describedby` attribute. */ details?: ComponentChildren; /** - * Set to `true` to associate a choice with the error passed to `ChoiceList` + * Whether this choice should be associated with an error state from the parent ChoiceList. * * @default false */ error?: boolean; /** - * Secondary content for a choice. + * Secondary descriptive content displayed beneath the choice label. */ secondaryContent?: ComponentChildren; /** - * Content to display when the option is selected. - * - * This can be used to provide additional information or options related to the choice. + * Content displayed when the choice is selected, useful for showing additional information or nested options related to this choice. */ selectedContent?: ComponentChildren; } @@ -2001,36 +2162,33 @@ interface ChoiceListProps$1 MultipleInputProps, FieldDetailsProps { /** - * Whether multiple choices can be selected. + * Whether users can select multiple choices simultaneously (checkboxes) or only one choice at a time (radio buttons). * * @default false */ multiple?: boolean; /** - * The choices a user can select from. - * - * Accepts `Choice` components. + * The collection of Choice components that users can select from. */ children?: ComponentChildren; /** - * Disables the field, disallowing any interaction. + * Whether the entire choice list is disabled, preventing any user interaction. * - * `disabled` on any child choices is ignored when this is true. + * When `true`, the `disabled` property on individual child Choice components is ignored. * * @default false */ disabled?: MultipleInputProps['disabled']; /** - * The variant of the choice grid. + * The layout variant for displaying the choices. * - * - `auto`: The variant is determined by the context. - * - `list`: The choices are displayed in a list. - * - `inline`: The choices are displayed on the inline axis. - * - `block`: The choices are displayed on the block axis. - * - `grid`: The choices are displayed in a grid. + * - `auto`: The variant is automatically determined by the context. + * - `list`: The choices are displayed in a vertical list. + * - `inline`: The choices are arranged horizontally along the inline axis. + * - `block`: The choices are arranged vertically along the block axis. + * - `grid`: The choices are displayed in a grid layout. * - * @implementation The `block`, `inline` and `grid` variants are more suitable for button looking choices, but it's at the - * discretion of each surface. + * @implementation The `block`, `inline` and `grid` variants are more suitable for button-styled choices, but it's at the discretion of each surface. * * @default 'auto' */ @@ -2041,27 +2199,15 @@ interface ClickableProps$1 BaseBoxProps, BaseClickableProps { /** - * Disables the clickable, and indicates to assistive technology that the loading is in progress. - * - * This also disables the clickable. + * Whether the component is in a loading state, which indicates to assistive technology that an action is in progress and prevents interaction. */ loading?: BaseClickableProps['loading']; /** - * 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. + * Whether the component is disabled, preventing clicks and focus. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You should apply disabled styling as needed. */ disabled?: BaseClickableProps['disabled']; /** - * 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) + * The language of the text content within the component. Useful when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label). * * @default '' */ @@ -2072,16 +2218,39 @@ interface ClickableChipProps$1 GlobalProps, InteractionProps { /** - * Callback when the chip is clicked. + * A callback fired when the chip is clicked. */ onClick?: (event: Event) => void; /** - * 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. + * The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation. */ href?: string; + /** + * Whether the chip displays a remove button for dismissal. When clicked, the `remove` callback fires. + * + * @default false + */ + removable?: boolean; + /** + * A callback fired when the chip's remove button is clicked. + */ + onRemove?: (event: Event) => void; + /** + * Whether the chip is hidden from view. When using controlled component pattern with `removable` chips, update this property when the `remove` event fires. For non-removable chips, manually toggle this property to show or hide the chip. + * + * @default false + */ + hidden?: boolean; + /** + * Event handler when the chip has fully hidden. + * + * The `hidden` property will be `true` when this event fires. + * + * @implementation If implementations animate the hiding of the chip, + * this event must fire after the chip has fully hidden. + * We can add an `onHide` event in future if we want to provide a hook for the start of the animation. + */ + onAfterHide?: (event: Event) => void; /** * Disables the chip, disallowing any interaction. * @@ -2089,63 +2258,57 @@ interface ClickableChipProps$1 */ disabled?: boolean; } -interface ColorPickerProps$1 extends GlobalProps, InputProps { +interface ColorPickerProps$1 + extends GlobalProps, + Omit { /** - * Allow user to select an alpha value. + * Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors. * * @default false */ alpha?: boolean; /** - * This callback will emit the value in hex. - * - * If the `alpha` prop is `true`, `onChange` will emit an 8-value hex (#RRGGBBAA). - * If the `alpha` prop is `false`, `onChange` will emit a 6-value hex (#RRGGBB). + * A callback that fires when the user finishes selecting a color. The value is always emitted in hexadecimal format: 8-value hex (`#RRGGBBAA`) when `alpha` is `true`, or 6-value hex (`#RRGGBB`) when `alpha` is `false`. */ onChange?: InputProps['onChange']; /** - * This callback will emit the value in hex. - * - * If the `alpha` prop is `true`, `onInput` will emit an 8-value hex (#RRGGBBAA). - * If the `alpha` prop is `false`, `onInput` will emit a 6-value hex (#RRGGBB). + * A callback that fires when the user makes any change to the color selection. The value is always emitted in hexadecimal format: 8-value hex (`#RRGGBBAA`) when `alpha` is `true`, or 6-value hex (`#RRGGBB`) when `alpha` is `false`. */ onInput?: InputProps['onChange']; /** - * The currently selected color. - * - * Supported formats include: - * - HSL @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl - * - HSLA @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsla - * - RGB @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb - * - RGBA @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb - * - Hex (3-value, 4-value, 6-value, 8-value) @see https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color + * The currently selected color value. Accepts multiple input formats: * - * For RGB and RGBA, both the legacy syntax (comma-separated) and modern syntax (space-separate) are supported. - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/rgb + * - Hex: `#RGB`, `#RGBA`, `#RRGGBB`, `#RRGGBBAA` (three, four, six, or eight digits) + * - RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated) + * - HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)` * - * If the value is invalid, the component will return an empty string ''. - * - * Note that the `onChange` handler will emit the value in hex. + * Returns an empty string if the value is invalid. The `onChange` handler always emits values in hex format. + */ + value?: string; + /** + * The initial color value when the field first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts interacting, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead. */ - value?: InputProps['value']; + defaultValue?: string; } +/** + * @publicDocs + */ export interface AutocompleteProps< AutocompleteField extends AnyAutocompleteField, > { /** - * 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. + * Controls browser autofill behavior for the field. * - * When set to `off`, you are indicating that this field contains sensitive - * information, or contents that are never saved, like one-time codes. + * Basic values: + * - `on` - Enables autofill without specifying content type (default) + * - `off` - Disables autofill for sensitive data or one-time codes * - * Alternatively, you can provide value which describes the - * specific data you would like to be entered into this field during autofill. + * Specific field values describe the expected data type. You can optionally prefix these with: + * - `section-${string}` - Scopes autofill to a specific form section (when multiple forms exist on the same page) + * - `shipping` or `billing` - Indicates whether the data is for shipping or billing purposes + * - Both section and group (for example, `section-primary shipping email`) * - * @see Learn more about the set of {@link https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens|autocomplete values} supported in browsers. + * Providing a specific autofill token helps browsers suggest more relevant saved data. Learn more about [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens). * * @default 'tel' for PhoneField * @default 'email' for EmailField @@ -2166,16 +2329,22 @@ export interface AutocompleteProps< * * Commonly used when there are multiple fields with the same autocomplete needs * in the same page. For example: 2 shipping address forms in the same page. + * @publicDocs */ export type AutocompleteSection = `section-${string}`; /** * The contact information group the autocomplete data should be sourced from. + * @publicDocs */ export type AutocompleteGroup = 'shipping' | 'billing'; /** * The contact information subgroup the autocomplete data should be sourced from. + * @publicDocs */ export type AutocompleteAddressGroup = 'fax' | 'home' | 'mobile' | 'pager'; +/** + * @publicDocs + */ export type AnyAutocompleteField = | 'additional-name' | 'address-level1' @@ -2241,6 +2410,43 @@ export type AnyAutocompleteField = | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`; +/** + * Represents autocomplete values that are valid for text input fields. + * This is a subset of `AnyAutocompleteField` containing only fields suitable for text-based inputs. + * + * Available values: + * - `name` - Full name + * - `given-name` - First name + * - `additional-name` - Middle name + * - `family-name` - Last name + * - `nickname` - Nickname or handle + * - `username` - Username for login + * - `honorific-prefix` - Name prefix (Mr., Mrs., Dr.) + * - `honorific-suffix` - Name suffix (Jr., Sr., III) + * - `organization` - Company or organization name + * - `organization-title` - Job title or position + * - `address-line1` - Street address (first line) + * - `address-line2` - Street address (second line) + * - `address-line3` - Street address (third line) + * - `address-level1` - State or province + * - `address-level2` - City or town + * - `address-level3` - District or locality + * - `address-level4` - Neighborhood or suburb + * - `street-address` - Complete street address (multi-line) + * - `postal-code` - Postal or ZIP code + * - `country` - Country code (US, CA, GB) + * - `country-name` - Country name (United States, Canada) + * - `language` - Preferred language + * - `sex` - Gender or sex + * - `one-time-code` - One-time codes for authentication + * - `transaction-currency` - Currency code (USD, EUR, GBP) + * - `cc-name` - Name on credit card + * - `cc-given-name` - First name on credit card + * - `cc-additional-name` - Middle name on credit card + * - `cc-family-name` - Last name on credit card + * - `cc-type` - Credit card type (Visa, Mastercard) + * @publicDocs + */ export type TextAutocompleteField = ExtractStrict< AnyAutocompleteField, | 'additional-name' @@ -2276,8 +2482,27 @@ export type TextAutocompleteField = ExtractStrict< >; interface ColorFieldProps$1 extends GlobalProps, - BaseTextFieldProps, - Pick { + Omit { + /** + * Whether to enable alpha (transparency) channel selection in the color picker, allowing users to choose semi-transparent colors. + * + * @default false + */ + alpha?: boolean; + /** + * The currently selected color value. Accepts multiple input formats: + * + * - Hex: `#RGB`, `#RGBA`, `#RRGGBB`, `#RRGGBBAA` (three, four, six, or eight digits) + * - RGB/RGBA: `rgb(255, 0, 0)` or `rgb(255 0 0)` (comma or space-separated) + * - HSL/HSLA: `hsl(0, 100%, 50%)` or `hsl(0 100% 50%)` + * + * Returns an empty string if the value is invalid. The `onChange` handler always emits values in hex format. + */ + value?: string; + /** + * The initial color value when the field first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts interacting, their input replaces it. Changing this property after the field has loaded has no effect. To update the field value at any time, use `value` instead. + */ + defaultValue?: string; autocomplete?: Extract< AutocompleteProps['autocomplete'], 'on' | 'off' @@ -2285,23 +2510,15 @@ interface ColorFieldProps$1 } interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps { /** - * 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. + * The default month to display in `YYYY-MM` format. Used until the `view` callback is set by user interaction or programmatically. Defaults to the current month in the user's locale. */ defaultView?: string; /** - * Displayed month in `YYYY-MM` format. - * - * `onViewChange` is called when this value changes. - * - * Defaults to `defaultView`. + * The currently displayed month in `YYYY-MM` format. When changed, the `viewchange` callback is triggered. Defaults to `defaultView`. */ view?: string; /** - * Called whenever the month to display changes. + * A callback fired whenever the displayed month changes in the calendar. * * @param view The new month to display in `YYYY-MM` format. */ @@ -2317,144 +2534,91 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps { */ type?: 'single' | 'multiple' | 'range'; /** - * Dates that can be selected. - * - * A comma-separated list of dates, date ranges. Whitespace is allowed after commas. + * Specifies which dates can be selected as a comma-separated list. An empty string (default) allows all dates. * - * The default `''` allows all dates. + * **Formats:** + * - `YYYY-MM-DD`: Single date + * - `YYYY-MM`: Whole month + * - `YYYY`: Whole year + * - `start--end`: Date range (inclusive, unbounded if start/end omitted) * - * - 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 `--`. + * **Examples:** + * - `2024-02--2025`: February 2024 through end of 2025 + * - `2024-05-09, 2024-05-11`: Only May 9th and 11th, 2024 * * @default "" - * - * @example - * `2024-02--2025` // allow any date from February 2024 to the end of 2025 - * `2024-02--` // allow any date from February 2024 to the end of the month - * `2024-05-09, 2024-05-11` // allow only the 9th and 11th of May 2024 */ allow?: string; /** - * Dates that cannot be selected. These subtract from `allow`. + * Specifies which dates can't be selected as a comma-separated list. These dates are excluded from those specified in `allow`. An empty string (default) has no effect. * - * A comma-separated list of dates, date ranges. Whitespace is allowed after commas. + * **Formats:** + * - `YYYY-MM-DD`: Single date + * - `YYYY-MM`: Whole month + * - `YYYY`: Whole year + * - `start--end`: Date range (inclusive, unbounded if start/end omitted) * - * 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 `--`. + * **Examples:** + * - `--2024-02`: All dates before February 2024 + * - `2024-05-09, 2024-05-11`: May 9th and 11th, 2024 * * @default "" - * - * @example - * `--2024-02` // disallow any date before February 2024 - * `2024-05-09, 2024-05-11` // disallow the 9th and 11th of May 2024 */ disallow?: string; /** - * 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. + * Specifies which days of the week can be selected as a comma-separated list. Further restricts dates from `allow` and `disallow`. An empty string (default) has no effect. * - * The default `''` has no effect on the result of `allow` and `disallow`. + * **Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday` * - * Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`. + * **Example:** `saturday, sunday` (only weekends) * * @default "" - * - * @example - * 'saturday, sunday' // allow only weekends within the result of `allow` and `disallow`. */ allowDays?: string; /** - * Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`. + * Specifies which days of the week can't be selected as a comma-separated list. Excludes days from `allowDays` and intersects with `allow` and `disallow`. An empty string (default) has no effect. * - * A comma-separated list of days. Whitespace is allowed after commas. + * **Valid days**: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday` * - * The default `''` has no effect on `allowDays`. - * - * Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`. + * **Example:** `saturday, sunday` (no weekends) * * @default "" - * - * @example - * 'saturday, sunday' // disallow weekends within the result of `allow` and `disallow`. */ disallowDays?: string; /** - * Default selected value. - * - * The default means no date is selected. + * The initially selected date(s) when the component first renders. An empty string means no date is initially 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. + * - Single date in `YYYY-MM-DD` format when `type` is set to `"single"` + * - Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `"range"` * * @default "" */ defaultValue?: string; /** - * Current selected value. - * - * The default means no date is selected. + * The currently selected date(s). An empty string 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. + * - Single date in `YYYY-MM-DD` format when `type` is set to `"single"` + * - Date range in `YYYY-MM-DD--YYYY-MM-DD` format (inclusive) when `type` is set to `"range"` * * @default "" */ value?: string; /** - * Callback when any date is selected. - * - * - If `type="single"`, fires when a date is selected and happens before `onChange`. - * - If `type="multiple"`, fires when a date is selected before `onChange`. - * - If `type="range"`, fires when a first date is selected (with the partial value formatted as `YYYY-MM-DD--`), and when the last date is selected before `onChange`. + * A callback fired when any date is selected, before `onChange`. When `type` is set to `"range"`, also fires when the first date is selected with a partial value formatted as `YYYY-MM-DD--`. */ onInput?: (event: Event) => void; /** - * Callback when the value is committed. - * - * - If `type="single"`, fires when a date is selected after `onInput`. - * - If `type="multiple"`, fires when a date is selected after `onInput`. - * - If `type="range"`, fires when a range is completed by selecting the end date after `onInput`. + * A callback fired when the date selection is committed and complete, after `onInput`. When `type` is set to `"range"`, fires only when the range is completed by selecting the end date. */ onChange?: (event: Event) => void; } interface DateFieldProps$1 extends GlobalProps, - BaseTextFieldProps, + Omit, Pick< DatePickerProps$1, | 'view' | 'defaultView' - | 'value' - | 'defaultValue' | 'allow' | 'disallow' | 'allowDays' @@ -2463,18 +2627,27 @@ interface DateFieldProps$1 >, AutocompleteProps { /** - * Callback when the user makes any changes in the field. - * Also triggered when a date is selected using the date picker popup before `onChange`. + * The initial date value when the field first renders, in `YYYY-MM-DD` format. An empty string means no date is initially selected. + * + * @default "" + */ + defaultValue?: string; + /** + * The currently selected date in `YYYY-MM-DD` format. An empty string means no date is selected. + * + * @default "" + */ + value?: string; + /** + * A callback fired when the user makes any changes in the field, including when selecting a date using the date picker popup. This fires before `onChange`. */ onInput?: (event: Event) => void; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. - * Also triggered when a date is selected using the date picker popup after `onInput`. + * A callback fired when the user has finished editing the field, such as when they blur the field or complete a date selection. This fires after `onInput`. */ onChange?: (event: Event) => void; /** - * Callback when the field has an invalid date. - * This callback will be called, if the date typed is invalid or disabled. + * A callback fired when the field contains an invalid date, either because the typed date is malformed, doesn't exist (e.g., February 31st), or is disabled by the `allow`/`disallow` constraints. * * Dates that don’t exist or have formatting errors are considered invalid. Some examples of invalid dates are: * - 2021-02-31: February doesn’t have 31 days @@ -2489,6 +2662,20 @@ interface DateFieldProps$1 */ onInvalid?: (event: Event) => void; } +/** + * Represents autocomplete values that are valid for date input fields. + * This is a subset of `AnyAutocompleteField` containing only fields suitable for date-based inputs. + * + * Available values: + * - `bday` - Complete birthday date + * - `bday-day` - Day component of a birthday (1-31) + * - `bday-month` - Month component of a birthday (1-12) + * - `bday-year` - Year component of a birthday (1990) + * - `cc-expiry` - Complete credit card expiration date + * - `cc-expiry-month` - Month component of a credit card expiration date (1-12) + * - `cc-expiry-year` - Year component of a credit card expiration date (2025) + * @publicDocs + */ export type DateAutocompleteField = ExtractStrict< AnyAutocompleteField, | 'bday' @@ -2501,13 +2688,19 @@ export type DateAutocompleteField = ExtractStrict< >; interface DividerProps$1 extends GlobalProps { /** - * Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values). + * The orientation of the divider line, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values). + * + * - `inline`: Horizontal divider for separating vertically stacked content + * - `block`: Vertical divider for separating horizontally arranged content * * @default 'inline' */ direction?: 'inline' | 'block'; /** - * Modify the color to be more or less intense. + * The visual prominence of the divider line. + * + * - `base`: Standard divider for most separations (default) + * - `strong`: More prominent divider for major section breaks * * @default 'base' */ @@ -2549,17 +2742,29 @@ interface EmailFieldProps$1 BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps {} +/** + * Represents autocomplete values that are valid for email input fields. + * This is a subset of `AnyAutocompleteField` containing only fields suitable for email inputs. + * + * Available values: + * - `email` - Primary email address + * - `home email` - Home email address + * - `mobile email` - Mobile device email address + * - `fax email` - Fax machine email address + * - `pager email` - Pager device email address + * @publicDocs + */ export type EmailAutocompleteField = ExtractStrict< AnyAutocompleteField, 'email' | `${AutocompleteAddressGroup} email` >; interface FormProps$1 extends GlobalProps { /** - * The content of the form. + * The form fields and content to be wrapped in the form element. */ children?: ComponentChildren; /** - * Whether the form is able to be submitted. + * Whether the form can be submitted. * * When set to `true`, this will also disable the implicit submit behavior of the form. * @@ -2570,14 +2775,14 @@ interface FormProps$1 extends GlobalProps { */ disabled?: boolean; /** - * A callback that is run when the form is submitted. + * A callback fired when the form is submitted. * - * Use `event.waitUntil` to signal how long it takes to save the data, - * and whether it was successful or not. + * Use `event.waitUntil` to signal how long it takes to save the data + * and whether the operation was successful. */ onSubmit?: (event: ExtendableEvent) => void; /** - * A callback that is run when the form is reset. + * A callback fired when the form is reset, typically via a reset button. */ onReset?: (event: Event) => void; } @@ -2604,30 +2809,37 @@ interface FunctionSettingsProps$1 extends GlobalProps, FormProps$1 { */ onError?: (event: AggregateErrorEvent) => void; } +/** + * @publicDocs + */ export interface FunctionSettingsError extends Error { /** * A unique identifier describing the “class” of error. These will match * the GraphQL error codes as closely as possible. For example the enums - * returned by the `metafieldsSet` mutation - * - * @see https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode + * returned by the `metafieldsSet` mutation. Learn more about [MetafieldsSetUserErrorCode](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldsSetUserErrorCode). */ code: string; name: 'FunctionSettingsError'; } +/** + * @publicDocs + */ export type SpacingKeyword = SizeKeyword | 'none'; +/** + * @publicDocs + */ export interface GapProps { /** - * Adjust spacing between elements. + * The spacing between child elements. * * A single value applies to both axes. - * A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively. + * A pair of values (e.g., `large-100 large-500`) can be used to set the inline and block axes respectively. * * @default 'none' */ gap?: MaybeResponsive>; /** - * Adjust spacing between elements in the block axis. + * The spacing between elements along the block axis (vertical spacing in horizontal writing modes). * * This overrides the row value of `gap`. * @@ -2635,7 +2847,7 @@ export interface GapProps { */ rowGap?: MaybeResponsive; /** - * Adjust spacing between elements in the inline axis. + * The spacing between elements along the inline axis (horizontal spacing in horizontal writing modes). * * This overrides the column value of `gap`. * @@ -2643,20 +2855,31 @@ export interface GapProps { */ columnGap?: MaybeResponsive; } +/** + * @publicDocs + */ export type BaselinePosition = 'baseline' | 'first baseline' | 'last baseline'; +/** + * @publicDocs + */ export type ContentDistribution = | 'space-between' | 'space-around' | 'space-evenly' | 'stretch'; +/** + * @publicDocs + */ export type ContentPosition = 'center' | 'start' | 'end'; +/** + * @publicDocs + */ export type OverflowPosition = | `unsafe ${ContentPosition}` | `safe ${ContentPosition}`; /** - * Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items + * Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis. Learn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items). + * @publicDocs */ export type JustifyItemsKeyword = | 'normal' @@ -2665,9 +2888,8 @@ export type JustifyItemsKeyword = | OverflowPosition | ContentPosition; /** - * Align items sets the align-self value on all direct children as a group. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items + * Align items sets the align-self value on all direct children as a group. Learn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items). + * @publicDocs */ export type AlignItemsKeyword = | 'normal' @@ -2676,9 +2898,8 @@ export type AlignItemsKeyword = | OverflowPosition | ContentPosition; /** - * Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content + * Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container. Learn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content). + * @publicDocs */ export type JustifyContentKeyword = | 'normal' @@ -2686,9 +2907,8 @@ export type JustifyContentKeyword = | OverflowPosition | ContentPosition; /** - *Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content + *Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis. Learn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content). + * @publicDocs */ export type AlignContentKeyword = | 'normal' @@ -2698,68 +2918,60 @@ export type AlignContentKeyword = | ContentPosition; interface GridProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps { /** - Define columns and specify their size. + Define columns and specify their size. Learn more about the [grid-template-columns property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns). - @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns @default 'none' */ gridTemplateColumns?: MaybeResponsive; /** - Define rows and specify their size. + Define rows and specify their size. Learn more about the [grid-template-rows property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows). - @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows @default 'none' */ gridTemplateRows?: MaybeResponsive; /** - Aligns the grid items along the inline (row) axis. + Aligns the grid items along the inline (row) axis. Learn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items). This overrides the inline value of `placeItems`. - @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items @default '' - meaning no override */ justifyItems?: MaybeResponsive; /** - Aligns the grid items along the block (column) axis. + Aligns the grid items along the block (column) axis. Learn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items). This overrides the block value of `placeItems`. - @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items @default '' - meaning no override */ alignItems?: MaybeResponsive; /** - A shorthand property for `justify-items` and `align-items`. + A shorthand property for `justify-items` and `align-items`. Learn more about the [place-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-items). - @see https://developer.mozilla.org/en-US/docs/Web/CSS/place-items @default 'normal normal' */ placeItems?: MaybeResponsive< `${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword >; /** - Aligns the grid along the inline (row) axis. + Aligns the grid along the inline (row) axis. Learn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content). This overrides the inline value of `placeContent`. - @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content @default '' - meaning no override */ justifyContent?: MaybeResponsive; /** - Aligns the grid along the block (column) axis. + Aligns the grid along the block (column) axis. Learn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content). This overrides the block value of `placeContent`. - @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content @default '' - meaning no override */ alignContent?: MaybeResponsive; /** - A shorthand property for `justify-content` and `align-content`. + A shorthand property for `justify-content` and `align-content`. Learn more about the [place-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/place-content). - @see https://developer.mozilla.org/en-US/docs/Web/CSS/place-content @default 'normal normal' */ placeContent?: MaybeResponsive< @@ -2768,39 +2980,46 @@ interface GridProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps { } interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole { /** - * Number of columns the item will span across - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column + * The number of grid columns this item spans across. Learn more about the [grid-column property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column). * * @default 'auto' */ gridColumn?: `span ${number}` | 'auto'; /** - * Number of rows the item will span across - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row + * The number of grid rows this item spans across. Learn more about the [grid-row property](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row). * * @default 'auto' */ gridRow?: `span ${number}` | 'auto'; } +/** + * @publicDocs + */ export interface BaseTypographyProps { /** - * Modify the color to be more or less intense. + * The color intensity of the text. Use `subdued` for less intense, `base` for standard, or `strong` for more intense coloring. * * @default 'base' */ color?: ColorKeyword; /** - * Sets the tone of the component, based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the component. + * + * - `auto`: Automatically determined based on context. + * - `neutral`: General information without specific intent. + * - `info`: Informational content or helpful tips. + * - `success`: Positive outcomes or successful states. + * - `caution`: Advisory notices that need attention. + * - `warning`: Important warnings about potential issues. + * - `critical`: Urgent problems or destructive actions. + * - `accent`: Highlighted or promotional content. + * - `custom`: Custom styling controlled by your theme. * * @default 'auto' */ tone?: ToneKeyword; /** - * Set the numeric properties of the font. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric + * Set the numeric properties of the font. Learn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric). * * @default 'auto' - inherit from the parent element */ @@ -2818,22 +3037,23 @@ export interface BaseTypographyProps { /** * 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) + * - `""`: The direction is inherited from parent elements (equivalent to not setting the attribute). + * - `auto`: The user agent determines the direction based on the content. + * - `ltr`: The languages written from left to right (such as English). + * - `rtl`: The languages written from right to left (such as Arabic). * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir + * Learn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir). * * @default '' */ dir?: 'ltr' | 'rtl' | 'auto' | ''; } +/** + * @publicDocs + */ export interface BlockTypographyProps { /** - * Truncates the text content to the specified number of lines. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp + * Truncates the text content to the specified number of lines. Learn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp). * * @default Infinity - no truncation is applied */ @@ -2844,7 +3064,7 @@ interface HeadingProps$1 AccessibilityVisibilityProps, BlockTypographyProps { /** - * The content of the Heading. + * The content of the heading. */ children?: ComponentChildren; /** @@ -2872,67 +3092,72 @@ interface IconProps$1 extends GlobalProps, Pick { /** - * Sets the tone of the icon, based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the component. + * + * - `auto`: Automatically determined based on context. + * - `neutral`: General information without specific intent. + * - `info`: Informational content or helpful tips. + * - `success`: Positive outcomes or successful states. + * - `caution`: Advisory notices that need attention. + * - `warning`: Important warnings about potential issues. + * - `critical`: Urgent problems or destructive actions. * * @default 'auto' */ tone?: ToneKeyword; /** - * Modify the color to be more or less intense. + * The color intensity of the icon. Use `subdued` for less intense, `base` for standard, or `strong` for more intense coloring. * * @default 'base' */ color?: ColorKeyword; /** - * Adjusts the size of the icon. + * The size of the icon. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size. * * @default 'base' */ size?: SizeKeyword; + /** + * The icon to display. Can be any icon name from the icon library or a custom string identifier. + */ type?: IconType | AnyString; } +/** + * @publicDocs + */ export interface BaseImageProps { /** - * 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. - * - * @default `''` - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt + * Alternative text that describes the image for accessibility. + * + * Provides a text description of the image for users with assistive technology + * and serves as a fallback when the image fails to load. A well-written description + * enables people with visual impairments to understand non-text content. + * + * When a screen reader encounters an image, it reads this description aloud. + * When an image fails to load, this text displays on screen, helping all users + * understand what content was intended. + * + * Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) + * and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt). + * + * @default '' */ alt?: string; /** - * A set of media conditions and their corresponding sizes. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes + * A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes). */ sizes?: string; /** * 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. + * When the image is loading or no `src` is provided, a placeholder is rendered. * * @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be - * reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src + * reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare. Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src). */ src?: string; /** - * A set of image sources and their width or pixel density descriptors. - * - * This overrides the `src` property. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset + * A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property. */ srcSet?: string; } @@ -2942,6 +3167,10 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps { * the role will be used by assistive technologies to help users * navigate the page. * + * - `img`: Identifies the element as an image that conveys meaningful information to users. + * - `presentation`: Removes semantic meaning, making the image purely decorative and ignored by screen readers. + * - `none`: Completely hides the element and its content from assistive technologies. + * * @default 'img' * * @implementation The `img` role doesn't need to be applied if @@ -2952,14 +3181,14 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps { | 'img' | ExtractStrict; /** - * The displayed inline width of the image. + * The inline width (horizontal size) 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. + * - `fill`: The image takes up 100% of the available inline space. + * - `auto`: The image is displayed at its natural size. * - * @default 'fill' + * Learn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width). * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width + * @default 'fill' */ inlineSize?: 'fill' | 'auto'; /** @@ -2973,20 +3202,18 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps { * 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`. * - * @default '1/1' + * Learn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio + * @default '1/1' */ aspectRatio?: | `${number}${optionalSpace}/${optionalSpace}${number}` | `${number}`; /** * Determines how the content of the image is resized to fit its container. - * The image is positioned in the center of the container. + * The image is positioned in the center of the container. Learn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit). * * @default 'contain' - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit */ objectFit?: 'contain' | 'cover'; /** @@ -2994,62 +3221,57 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps { * - `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. * + * Learn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading). + * * @default 'eager' - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading */ loading?: 'eager' | 'lazy'; /** - * Invoked when load completes successfully. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload + * A callback fired when the image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload). */ onLoad?: (event: Event) => void; /** - * Invoked on load error. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror + * A callback fired when the image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror). */ onError?: (event: Event) => void; } interface LinkProps$1 extends GlobalProps, LinkBehaviorProps { /** - * The content of the Link. + * The text or elements displayed as the link's content. */ children?: ComponentChildren; /** - * Sets the tone of the Link, based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the component. + * + * - `critical`: Urgent problems or destructive actions. + * - `auto`: Automatically determined based on context. + * - `neutral`: General information without specific intent. * * @default 'auto' */ tone?: ToneKeyword; /** - * 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. + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. */ accessibilityLabel?: string; /** - * 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) + * The language of the link's text content. Use this when the link text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label). */ lang?: string; } interface ListItemProps$1 extends GlobalProps { /** - * The content of the ListItem. + * The content displayed within the list item. */ children?: ComponentChildren; } interface MenuProps$1 extends GlobalProps { /** - * A label that describes the purpose or contents of the element. When set, - * it will be announced using assistive technologies and provide additional context. + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. */ accessibilityLabel?: string; /** - * The children define the actions to render inside the Menu. Only Button components are allowed as children of a Menu, and these Buttons can perform actions (using `onClick`) or link to other parts of the application (using `to`/ `href`). Any other component placed here will be ignored. + * The collection of Button components displayed as menu actions. Only Button components are allowed as children, which can perform actions using `onClick` or link to other parts of the application using `href`. Any other component type will be ignored. */ children?: ComponentChildren; } @@ -3067,32 +3289,32 @@ interface ModalProps$1 */ accessibilityLabel?: string; /** - * A title that describes the content of the Modal. + * A title that describes the content of the modal. * */ heading?: string; /** - * Adjust the padding around the Modal content. + * 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' + * `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. * * @default 'base' */ padding?: 'base' | 'none'; /** - * Adjust the size of the Modal. + * Adjust the size of the modal. * - * `max`: expands the Modal to its maximum size as defined by the host application, on both the horizontal and vertical axes. + * `max`: expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes. * * @default 'base' */ size?: SizeKeyword | 'max'; /** - * The content of the Modal. + * The content of the modal. */ children?: ComponentChildren; } @@ -3101,6 +3323,9 @@ interface MoneyFieldProps$1 BaseTextFieldProps, NumberConstraintsProps, AutocompleteProps {} +/** + * @publicDocs + */ export type MoneyAutocompleteField = ExtractStrict< AnyAutocompleteField, 'transaction-amount' @@ -3112,28 +3337,31 @@ interface NumberFieldProps$1 NumberConstraintsProps, FieldDecorationProps { /** - * Sets the virtual keyboard. + * Sets the virtual keyboard. Learn more about the [inputmode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode). * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode * @default 'decimal' */ inputMode?: 'decimal' | 'numeric'; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred - * the field after changing the value. - * Also fired after `onInput` on every step when interacting with the controls or the keyboard up and down arrows. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Callback when the user has **finished editing** a field, such as when they blur the field after changing the value. + * Also fired after `onInput` on every step when using keyboard up and down arrows. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ onChange?: (event: Event) => void; /** - * Callback when the user makes any changes in the field. - * Also fired before `onChange` on every step when interacting with the controls or the keyboard up and down arrows. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * A callback fired when the user makes any changes to the field value, including when using keyboard up/down arrows. This fires before `onChange`. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). */ onInput?: (event: Event) => void; } +/** + * Represents autocomplete values that are valid for number input fields. + * This is a subset of `AnyAutocompleteField` containing only fields suitable for numeric inputs. + * + * Available values: + * - `one-time-code` - One-time codes for authentication (OTP, 2FA codes) + * - `cc-number` - Credit card number + * - `cc-csc` - Credit card security code (CVV/CVC) + * @publicDocs + */ export type NumberAutocompleteField = ExtractStrict< AnyAutocompleteField, 'one-time-code' | 'cc-number' | 'cc-csc' @@ -3152,27 +3380,18 @@ interface OptionGroupProps$1 extends GlobalProps { */ disabled?: boolean; /** - * The user-facing label for this group of options. + * The label text displayed for this group of related options. */ label?: string; /** - * The options a user can select from. - * - * Accepts `Option` components. - */ - children?: ComponentChildren; -} -interface OrderedListProps$1 extends GlobalProps { - /** - * The content of the OrderededList. - * - * Accepts only `ListItem` components. + * The collection of option components that users can select from within this group. */ children?: ComponentChildren; } +interface OrderedListProps$1 extends GlobalProps {} interface PageProps$1 extends GlobalProps, ActionSlots { /** - * The content of the Page. + * The content of the page. */ children?: ComponentChildren; /** @@ -3212,34 +3431,30 @@ interface ParagraphProps$1 BlockTypographyProps, AccessibilityVisibilityProps { /** - * The content of the Paragraph. + * The text or elements displayed within the paragraph. */ children?: ComponentChildren; /** - * Provide semantic meaning and default styling to the paragraph. + * The semantic type of the paragraph, which provides meaning and default styling. * - * Other presentation properties on `s-paragraph` override the default styling. + * Other presentation properties on the paragraph can override the default styling. * * @default 'paragraph' */ type?: ParagraphType; } +/** + * @publicDocs + */ export type ParagraphType = /** - * Indicate the text is a structural grouping of related content. - * - * In an HTML host, the text will be rendered in an `

` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p + * Indicates the text is a structural grouping of related content. In an HTML host, the text will be rendered in a `

` element. Learn more about the [p element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p). */ | 'paragraph' /** - * Indicates the text is considered less important than the main content, but is still necessary for the reader to understand. - * It can be used for secondary content but also for disclaimers, terms and conditions, or legal information. - * - * Surfaces should apply a smaller font size than the default size. + * Indicates the text is considered less important than the main content but is still necessary for understanding. This can be used for secondary content, disclaimers, terms and conditions, or legal information. * - * In an HTML host, the text will be rendered in a `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small + * Surfaces should apply a smaller font size than the default. In an HTML host, the text will be rendered in a `` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small). */ | 'small'; interface PasswordFieldProps$1 @@ -3247,6 +3462,15 @@ interface PasswordFieldProps$1 BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps {} +/** + * Represents autocomplete values that are valid for password input fields. + * This is a subset of `AnyAutocompleteField` containing only fields suitable for password inputs. + * + * Available values: + * - `current-password` - Existing password for login or authentication + * - `new-password` - New password when creating an account or changing password + * @publicDocs + */ export type PasswordAutocompleteField = ExtractStrict< AnyAutocompleteField, 'new-password' | 'current-password' @@ -3262,86 +3486,44 @@ interface PopoverProps$1 */ children?: ComponentChildren; } -interface PressButtonProps$1 - extends GlobalProps, - Pick< - ButtonProps$1, - | 'accessibilityLabel' - | 'children' - | 'icon' - | 'inlineSize' - | 'lang' - | 'tone' - | 'variant' - | 'disabled' - | 'loading' - | 'onClick' - | 'onBlur' - | 'onFocus' - > { - /** - * Whether the button is pressed. - * - * @default false - */ - pressed?: boolean; - /** - * Whether the button is pressed by default. - * - * @default false - * - * @implementation `defaultPressed` reflects to the `pressed` attribute. - */ - defaultPressed?: boolean; -} interface QueryContainerProps$1 extends GlobalProps { /** * The content of the container. */ children?: ComponentChildren; /** - * The name of the container, which can be used in your container queries to target this container specifically. + * An identifier for this container that you can reference in CSS container queries to apply styles based on this specific container's size. * - * 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`. + * All QueryContainer components automatically receive a container name of `s-default`. You can omit the container name in your queries, so `@container (inline-size <= 300px)` is equivalent to `@container s-default (inline-size <= 300px)`. * - * 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. + * When you provide a custom `containerName`, it's added alongside `s-default`. For example, `containerName="product-card"` results in `s-default product-card` being set on the `container-name` CSS property, allowing you to target this container with `@container product-card (inline-size <= 300px)`. * - * @default '' + * Learn more about the [container-name property](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/container-name + * @default '' * * @implementation You must always have a CSS `container-name` of `s-default` for this component. */ containerName?: string; } -export type OverflowKeyword = 'auto' | 'hidden'; -export type ScrollSnapType = 'none' | 'mandatory' | 'proximity'; -export type ScrollAccessibilityRole = 'generic' | 'region'; interface SectionProps$1 extends GlobalProps, ActionSlots { /** - * The content of the Section. + * The content of the section. */ children?: ComponentChildren; /** - * 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. + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. */ accessibilityLabel?: string; /** - * A title that describes the content of the section. + * The heading text displayed at the top of the section. This heading provides a title for the section's content and automatically uses the appropriate semantic heading level (h2, h3, h4) based on nesting depth to maintain proper document structure. */ heading?: string; /** - * Adjust the padding of all edges. + * The amount of padding applied to all edges of the section. * - * - `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. + * - `base`: Applies standard padding appropriate for the section. Note that this might result in no padding if that's the right design decision for the context. + * - `none`: Removes all padding, useful when content like images needs to extend to the section's edges. Use Box with `padding="base"` for individual content areas that need padding. * * @default 'base' */ @@ -3354,59 +3536,61 @@ interface SelectProps$1 Omit, FocusEventProps { /** - * The options a user can select from. + * The selectable options displayed in the dropdown list. * - * Accepts `Option` and `OptionGroup` components. + * Accepts Option components for individual selectable items, and OptionGroup components to organize related options into logical groups with labels. */ children?: ComponentChildren; } interface SpinnerProps$1 extends GlobalProps { /** - * Adjusts the size of the spinner icon. + * The size of the spinner icon. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size. * * @default 'base' */ size?: SizeKeyword; /** - * 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. + * A label that describes the purpose or content of the component for assistive technologies like screen readers. Use this to provide additional context when the visible content alone doesn't clearly convey the component's purpose. */ accessibilityLabel?: string; } interface StackProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps { /** - * The content of the Stack. + * The elements arranged within the stack layout. */ children?: ComponentChildren; /** - * Sets how the children are placed within the Stack. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values). + * The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values). + * + * - `block`: Arranges children vertically (in horizontal writing modes). Content does not wrap. + * - `inline`: Arranges children horizontally (in horizontal writing modes). Content wraps to the next line if needed. * * @default 'block' * - * @implementation the content will wrap if the direction is 'inline', and not wrap if the direction is 'block' + * @implementation The content will wrap if the direction is 'inline', and not wrap if the direction is 'block'. */ direction?: MaybeResponsive<'block' | 'inline'>; /** - * Aligns the Stack along the main axis. + * Controls the distribution of children along the inline axis (horizontally in horizontal writing modes). + * + * Use this to position items along the primary axis of the stack - horizontally for inline stacks or vertically for block stacks when wrapped into multiple lines. Learn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content * @default 'normal' */ justifyContent?: MaybeResponsive; /** - * Aligns the Stack's children along the cross axis. + * Controls the alignment of children along the block axis (vertically in horizontal writing modes). + * + * Use this to align items perpendicular to the stack direction - vertically for inline stacks or horizontally for block stacks. Learn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items * @default 'normal' */ alignItems?: MaybeResponsive; /** - * Aligns the Stack along the cross axis. + * Controls the distribution of lines along the block axis when content wraps into multiple lines. + * + * This property only affects stacks with wrapping content. For single-line stacks, use `alignItems` instead. Learn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content * @default 'normal' */ alignContent?: MaybeResponsive; @@ -3417,6 +3601,9 @@ interface SwitchProps$1 BasicFieldProps, FieldDetailsProps, FieldErrorProps {} +/** + * @publicDocs + */ export interface PaginationProps { /** * Whether to use pagination controls. @@ -3425,11 +3612,11 @@ export interface PaginationProps { */ paginate?: boolean; /** - * Called when the previous page button is clicked. + * A callback fired when the previous page button is clicked. */ onPreviousPage?: (event: Event) => void; /** - * Called when the next page button is clicked. + * A callback fired when the next page button is clicked. */ onNextPage?: (event: Event) => void; /** @@ -3445,8 +3632,8 @@ export interface PaginationProps { */ hasPreviousPage?: boolean; /** - * 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. + * Whether the table is in a loading state, such as during initial page load or when loading the next page in a paginated table. + * When `true`, the table might be in an inert state that prevents user interaction. * * @default false */ @@ -3454,19 +3641,23 @@ export interface PaginationProps { } interface TableProps$1 extends GlobalProps, PaginationProps { /** - * The content of the Table. + * The table structure defining headers and data rows. + * + * Accepts table header row (for column headers) and table body (for data rows) components. Structure your table with a table header row first, followed by table body. */ children?: ComponentChildren; /** - * Input elements, such as SearchField, used to search and filter the table. + * Filter controls displayed above the table. + * + * Accepts input components like search field or select for filtering table data. These controls appear in a dedicated area above the table content. */ filters?: ComponentChildren; /** - * Sets the layout of the Table. + * The layout variant of the table. * - * - `list`: The Table is always displayed as a list. - * - `table`: The Table is always displayed as a table. - * - `auto`: The Table is displayed as a table on wide devices and as a list on narrow devices. + * - `list`: Always displays as a list layout. + * - `table`: Always displays as a traditional table layout. + * - `auto`: Automatically displays as a table on wide screens and as a list on narrow screens. * * @default 'auto' */ @@ -3474,59 +3665,80 @@ interface TableProps$1 extends GlobalProps, PaginationProps { } interface TableBodyProps$1 extends GlobalProps { /** - * The body of the table. May not have any semantic meaning in the Table's `list` variant. + * The data rows displayed in the table body. + * + * Accepts TableRow components, with each row representing a single record or entry in the table. */ children?: ComponentChildren; } interface TableCellProps$1 extends GlobalProps { /** - * The content of the table cell. + * The data value displayed in this cell. + * + * Accepts text content or inline components representing the cell's data value. */ children?: ComponentChildren; } +/** + * Represents the content designation for table columns when displayed in list variant on mobile devices. + * + * Available values: + * - `primary` - The most important content. Only one column can have this designation. + * - `secondary` - Supporting content displayed below primary. Only one column can have this designation. + * - `kicker` - Small label displayed above primary content with less visual prominence. Only one column can have this designation. + * - `inline` - Content displayed inline with primary content. + * - `labeled` - Each column displays as a heading-content pair. + * @publicDocs + */ export type ListSlotType = | 'primary' | 'secondary' | 'kicker' | 'inline' | 'labeled'; +/** + * Represents the format options for table headers that control styling and alignment of column content. + * + * Available values: + * - `base`: Standard format for text columns + * - `currency`: Right-aligned format for monetary values + * - `numeric`: Right-aligned format for numeric values + * @publicDocs + */ +export type HeaderFormat = 'base' | 'currency' | 'numeric'; interface TableHeaderProps$1 extends GlobalProps { /** - * The heading of the column in the `table` variant, and the label of its data in `list` variant. + * The column heading text. + * + * This text labels the column in table variant and appears as a label for data in list variant. */ children?: ComponentChildren; /** - * 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. + * The content designation for this column when the table displays in list variant on mobile devices. * * @default 'labeled' */ listSlot?: ListSlotType; /** - * 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. + * The format of the column that controls styling and alignment of cell content. * * @default 'base' */ - format?: 'base' | 'currency' | 'numeric'; + format?: HeaderFormat; } interface TableHeaderRowProps$1 extends GlobalProps { /** - * Contents of the table heading row; children should be `TableHeading` components. + * The column headers displayed in the table header row. + * + * Accepts TableHeader components, with each header defining a column and providing its label. */ children?: ComponentChildren; } interface TableRowProps$1 extends GlobalProps { /** - * The content of a TableRow, which should be `TableCell` components. + * The data cells displayed in this table row. + * + * Accepts TableCell components, with each cell containing a data value for the corresponding column. */ children?: ComponentChildren; /** @@ -3537,7 +3749,7 @@ interface TableRowProps$1 extends GlobalProps { * Which is why the target element must be in the table; so that keyboard and screen reader users can interact with it normally. * * @implementation no focus or keyboard affordances are introduced by this property. No aria attributes need to be added to the table row. - * @implementation the row and/or delegate should have some affordance that indicates it is clickable. This may be a background color, a border, a hover effect, etc. + * @implementation the row and/or delegate should have some affordance that indicates it is clickable. This may be a background color, a border, or a hover effect. */ clickDelegate?: string; } @@ -3548,11 +3760,11 @@ interface TextProps$1 DisplayProps, Pick { /** - * The content of the Text. + * The text content or inline elements displayed within the component. */ children?: ComponentChildren; /** - * Provide semantic meaning and default styling to the text. + * The semantic type of the text, which provides meaning and default styling. * * Other presentation properties on Text override the default styling. * @@ -3560,6 +3772,9 @@ interface TextProps$1 */ type?: TextType; } +/** + * @publicDocs + */ export type TextType = /** * Indicate the text is contact information. Typically used for addresses. @@ -3568,11 +3783,9 @@ export type TextType = * * Surfaces may apply styling to this type. * - * In an HTML host, the text will be rendered in an `

` element. + * In an HTML host, the text will be rendered in an `
` element. Learn more about the [address element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address). * * @implementation vertical alignment should be `baseline` (`vertical-align: baseline`) - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address */ | 'address' /** @@ -3580,8 +3793,7 @@ export type TextType = * * Surfaces should apply styling to this type to suggest its content no longer applies. * - * In an HTML host, the text will be rendered in a `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s + * In an HTML host, the text will be rendered in a `` element. Learn more about the [s element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s). */ | 'redundant' /** @@ -3590,8 +3802,7 @@ export type TextType = * * Surfaces should apply styling to this type to draw attention to the content. * - * In an HTML host, the text will be rendered in a `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark + * In an HTML host, the text will be rendered in a `` element. Learn more about the [mark element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark). */ | 'mark' /** @@ -3599,8 +3810,7 @@ export type TextType = * * Surfaces should apply styling to this type to distinguish it from surrounding text. Italicization is a common choice, but not required. * - * In an HTML host, the text will be rendered in an `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em + * In an HTML host, the text will be rendered in an `` element. Learn more about the [em element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em). */ | 'emphasis' /** @@ -3610,8 +3820,7 @@ export type TextType = * * Surfaces should italicize this content by default. * - * In an HTML host, the text will be rendered in a `` tag. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i + * In an HTML host, the text will be rendered in a `` tag. Learn more about the [i element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i). */ | 'offset' /** @@ -3619,8 +3828,7 @@ export type TextType = * * Surfaces should render this content bold by default. * - * In an HTML host, the text will be rendered in a `` tag. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong + * In an HTML host, the text will be rendered in a `` tag. Learn more about the [strong element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong). */ | 'strong' /** @@ -3629,8 +3837,7 @@ export type TextType = * * Surfaces should apply a smaller font size than the default size. * - * In an HTML host, the text will be rendered in a `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small + * In an HTML host, the text will be rendered in a `` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small). */ | 'small' /** @@ -3638,8 +3845,7 @@ export type TextType = * * Surfaces must not apply any default styling to this type. * - * In an HTML host, the text will be rendered in a `` tag. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span + * In an HTML host, the text will be rendered in a `` tag. Learn more about the [span element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span). */ | 'generic'; interface TextAreaProps$1 @@ -3648,7 +3854,7 @@ interface TextAreaProps$1 MinMaxLengthProps, AutocompleteProps { /** - * A number of visible text lines. + * The number of visible text lines displayed in the textarea, which controls its initial height. * * @default 2 */ @@ -3662,19 +3868,15 @@ interface TextFieldProps$1 FieldDecorationProps {} interface ThumbnailProps$1 extends GlobalProps, BaseImageProps { /** - * Invoked when load of provided image completes successfully. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload + * A callback fired when the thumbnail image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload). */ onLoad?: (event: Event) => void; /** - * Invoked on load error of provided image. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror + * A callback fired when the thumbnail image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror). */ onError?: (event: Event) => void; /** - * Adjusts the size the product thumbnail image. + * The size of the product thumbnail image. Available sizes range from `small-500` (smallest) to `large-500` (largest), with `base` providing the default size. * * @default 'base' */ @@ -3682,23 +3884,30 @@ interface ThumbnailProps$1 extends GlobalProps, BaseImageProps { } interface TooltipProps$1 extends GlobalProps { /** - * The content of the Tooltip. - */ - children?: ComponentChildren; -} -interface UnorderedListProps$1 extends GlobalProps { - /** - * The content of the UnorderededList. - * - * Accepts only `ListItem` components. + * The text or elements displayed inside the tooltip popup. */ children?: ComponentChildren; } +interface UnorderedListProps$1 extends GlobalProps {} interface URLFieldProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps {} +/** + * Represents autocomplete values that are valid for URL input fields. + * This is a subset of `AnyAutocompleteField` containing only fields suitable for URL inputs. + * + * Available values: + * - `url` - General URL or web address + * - `photo` - URL to a photo or image + * - `impp` - Instant messaging protocol URL + * - `home impp` - Home instant messaging protocol URL + * - `mobile impp` - Mobile instant messaging protocol URL + * - `fax impp` - Fax instant messaging protocol URL + * - `pager impp` - Pager instant messaging protocol URL + * @publicDocs + */ export type URLAutocompleteField = ExtractStrict< AnyAutocompleteField, 'url' | 'photo' | 'impp' | `${AutocompleteAddressGroup} impp` @@ -3706,6 +3915,9 @@ export type URLAutocompleteField = ExtractStrict< // // Preact Virtual DOM // ----------------------------------- +/** + * @publicDocs + */ export interface VNode

{ type: ComponentType

| string; props: P & { @@ -3713,8 +3925,7 @@ export interface VNode

{ }; key: Key; /** - * ref is not guaranteed by React.ReactElement, for compatibility reasons - * with popular react libs we define it as optional too + * The ref is not guaranteed by `React.ReactElement`. For compatibility with popular React libraries, this is defined as optional. */ ref?: Ref | null; /** @@ -3733,12 +3944,27 @@ export interface VNode

{ // // Preact Component interface // ----------------------------------- +/** + * @publicDocs + */ export type Key = string | number | any; +/** + * @publicDocs + */ export interface RefObject { current: T | null; } +/** + * @publicDocs + */ export type RefCallback = (instance: T | null) => void; +/** + * @publicDocs + */ export type Ref = RefObject | RefCallback | null; +/** + * @publicDocs + */ export type ComponentChild = | VNode | object @@ -3749,13 +3975,22 @@ export type ComponentChild = | null | undefined; type ComponentChildren$1 = ComponentChild[] | ComponentChild; +/** + * @publicDocs + */ export interface Attributes { key?: Key | undefined; jsx?: boolean | undefined; } +/** + * @publicDocs + */ export interface ErrorInfo { componentStack?: string; } +/** + * @publicDocs + */ export type RenderableProps = P & Readonly< Attributes & { @@ -3763,12 +3998,21 @@ export type RenderableProps = P & ref?: Ref; } >; +/** + * @publicDocs + */ export type ComponentType

= ComponentClass

| FunctionComponent

; +/** + * @publicDocs + */ export interface FunctionComponent

{ (props: RenderableProps

, context?: any): ComponentChildren$1; displayName?: string; defaultProps?: Partial

| undefined; } +/** + * @publicDocs + */ export interface ComponentClass

{ new (props: P, context?: any): Component; displayName?: string; @@ -3780,6 +4024,9 @@ export interface ComponentClass

{ ): Partial | null; getDerivedStateFromError?(error: any): Partial | null; } +/** + * @publicDocs + */ export interface Component

{ componentWillMount?(): void; componentDidMount?(): void; @@ -3848,82 +4095,29 @@ declare abstract class Component { // // Context // ----------------------------------- +/** + * @publicDocs + */ export interface Consumer extends FunctionComponent<{ children: (value: T) => ComponentChildren$1; }> {} +/** + * @publicDocs + */ export interface Provider extends FunctionComponent<{ value: T; children?: ComponentChildren$1; }> {} +/** + * @publicDocs + */ export interface Context extends Provider { Consumer: Consumer; Provider: Provider; displayName?: string; } -export type Styles = string; -declare const shadowRootSymbol: unique symbol; -export type RenderImpl = Omit & { - ShadowRoot: (element: any) => ComponentChildren$1; - styles?: Styles; - /** - * Only needed once in the root element, to inject global shadow CSS for all components. - */ - globalShadowCSS?: Styles; -}; -export interface ActivationEventEsque { - shiftKey: boolean; - metaKey: boolean; - ctrlKey: boolean; - button: number; -} -export interface ClickOptions { - /** - * The event you want to influence the synthetic click. - */ - sourceEvent?: ActivationEventEsque; -} -declare const BaseClass: typeof globalThis.HTMLElement; -export declare abstract class PreactCustomElement extends BaseClass { - /** @private */ - static get observedAttributes(): string[]; - /** @private */ - [shadowRootSymbol]: ShadowRoot | null; - constructor({ - styles, - ShadowRoot: renderFunction, - delegatesFocus, - globalShadowCSS, - ...options - }: RenderImpl); - - /** @private */ - setAttribute(name: string, value: string): void; - /** @private */ - attributeChangedCallback(name: string): void; - /** @private */ - connectedCallback(): void; - /** @private */ - disconnectedCallback(): void; - /** @private */ - adoptedCallback(): void; - /** - * Queue a run of the render function. - * You shouldn't need to call this manually - it should be handled by changes to @property values. - * @private - */ - queueRender(): void; - /** - * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`. - * - * For example, if the `sourceEvent` was a middle click, or has particular keys held down, - * components will attempt to produce the desired behavior on links, such as opening the page in the background tab. - * @private - * @param options - */ - click({sourceEvent}?: ClickOptions): void; -} type IconType$1 = | 'adjust' | 'affiliate' @@ -3935,7 +4129,6 @@ type IconType$1 = | 'alert-octagon' | 'alert-octagon-filled' | 'alert-triangle' - | 'align-horizontal-centers' | 'app-extension' | 'apps' | 'archive' @@ -3995,7 +4188,6 @@ type IconType$1 = | 'catalog-product' | 'categories' | 'channels' - | 'channels-filled' | 'chart-cohort' | 'chart-donut' | 'chart-funnel' @@ -4360,7 +4552,6 @@ type IconType$1 = | 'sort-ascending' | 'sort-descending' | 'sound' - | 'split' | 'sports' | 'star' | 'star-filled' diff --git a/packages/ui-extensions/src/surfaces/admin/docs-types.ts b/packages/ui-extensions/src/surfaces/admin/docs-types.ts deleted file mode 100644 index 0b84a7be08..0000000000 --- a/packages/ui-extensions/src/surfaces/admin/docs-types.ts +++ /dev/null @@ -1,45 +0,0 @@ -import type {CSSProperties} from 'react'; -import { - ReferenceEntityTemplateSchema, - CodeTabType, - ExampleType, - ExampleSectionSchema, - ExampleGroupType, -} from '@shopify/generate-docs'; - -// Don't allow all CSS properties to be used in the customStyles property -type AllowedCSSProperties = Pick; - -type AdminCodeTabType = CodeTabType & { - layout?: string; - customStyles?: AllowedCSSProperties; -}; - -interface CodeLinkType { - name: string; - url: string; - icon: string; -} - -interface AdminCodeblockType { - title: string; - tabs: AdminCodeTabType[]; - links?: CodeLinkType[]; -} - -type AdminExampleType = Omit & { - codeblock: AdminCodeblockType | AdminCodeblockType[]; -}; - -type AdminExampleGroupType = Omit & { - examples: AdminExampleType[]; -}; - -export interface AdminReferenceEntityTemplateSchema - extends Omit { - defaultExample?: AdminExampleType; - examples?: Omit & { - exampleGroups?: AdminExampleGroupType[] | null; - examples?: AdminExampleType[] | null; - }; -} diff --git a/packages/ui-extensions/src/surfaces/admin/extension-targets.ts b/packages/ui-extensions/src/surfaces/admin/extension-targets.ts index 5dc42d6046..f5c29ee181 100644 --- a/packages/ui-extensions/src/surfaces/admin/extension-targets.ts +++ b/packages/ui-extensions/src/surfaces/admin/extension-targets.ts @@ -13,6 +13,8 @@ import type { CustomerSegmentTemplateApi, CustomerSegmentTemplate, StandardApi, + IntentRenderApi, + AppHomeApi, } from './api'; import { ShouldRenderApi, @@ -22,10 +24,16 @@ import type {BlockExtensionComponents} from './components/BlockExtensionComponen import type {ActionExtensionComponents} from './components/ActionExtensionComponents'; import type {PrintActionExtensionComponents} from './components/PrintActionExtensionComponents'; import type {FunctionSettingsComponents} from './components/FunctionSettingsComponents'; +import type {FormExtensionComponents} from './components/FormExtensionComponents'; +/** + * Maps extension target identifiers to their corresponding extension types. Each target represents a specific location or context in the Shopify admin where extensions can render or execute. Use these targets to define where your extension appears and what capabilities it has access to. + * + * @publicDocs + */ export interface ExtensionTargets { /** - * Renders a [`CustomerSegmentTemplate`](/docs/api/admin-extensions/components/customersegmenttemplate) in the [customer segment editor](https://help.shopify.com/en/manual/customers/customer-segmentation/customer-segments). + * A runnable target that provides [customer segment templates](/docs/apps/build/marketing-analytics/customer-segments/build-a-template-extension) in the [customer segment editor](https://help.shopify.com/manual/customers/customer-segmentation/create-customer-segments). Use this target to provide pre-built segment templates that merchants can use as starting points for creating targeted customer groups based on custom criteria. */ 'admin.customers.segmentation-templates.data': RunnableExtension< CustomerSegmentTemplateApi<'admin.customers.segmentation-templates.data'>, @@ -34,9 +42,7 @@ export interface ExtensionTargets { // Blocks /** - * Renders an admin block in the product details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the product details page. Use this to show product-specific information, tools, or actions directly on the product page. */ 'admin.product-details.block.render': RenderExtension< BlockExtensionApi<'admin.product-details.block.render'>, @@ -44,9 +50,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the order details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the order details page. Use this to show order-specific information, fulfillment tools, or custom order actions. */ 'admin.order-details.block.render': RenderExtension< BlockExtensionApi<'admin.order-details.block.render'>, @@ -54,9 +58,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the discount details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A function settings target that appears when merchants create or edit a discount powered by your discount function, allowing them to configure function-specific settings. Use this to build custom configuration interfaces for discount function parameters. */ 'admin.discount-details.function-settings.render': RenderExtension< DiscountFunctionSettingsApi<'admin.discount-details.function-settings.render'>, @@ -64,9 +66,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the customer details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the customer details page. Use this to show customer-specific information, loyalty data, or custom customer actions. */ 'admin.customer-details.block.render': RenderExtension< BlockExtensionApi<'admin.customer-details.block.render'>, @@ -74,9 +74,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the collection details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the collection details page. Use this to show collection analytics, bulk product operations, or collection-specific tools. */ 'admin.collection-details.block.render': RenderExtension< BlockExtensionApi<'admin.collection-details.block.render'>, @@ -84,9 +82,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the draft order details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the draft order details page. Use this to show custom pricing calculations, special order handling tools, or order-specific information. */ 'admin.draft-order-details.block.render': RenderExtension< BlockExtensionApi<'admin.draft-order-details.block.render'>, @@ -94,9 +90,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the abandoned checkout details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the abandoned checkout details page. Use this to show cart recovery tools, abandonment analysis, or customer re-engagement options. */ 'admin.abandoned-checkout-details.block.render': RenderExtension< BlockExtensionApi<'admin.abandoned-checkout-details.block.render'>, @@ -104,9 +98,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the catalog details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the catalog details page. Use this to show catalog-specific settings, market information, or synchronization tools. */ 'admin.catalog-details.block.render': RenderExtension< BlockExtensionApi<'admin.catalog-details.block.render'>, @@ -114,9 +106,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the company details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the company details page. Use this to show B2B customer information, credit limits, or company-specific data. */ 'admin.company-details.block.render': RenderExtension< BlockExtensionApi<'admin.company-details.block.render'>, @@ -124,9 +114,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the company location details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the company location details page. Use this to show location-specific information, shipping preferences, or location management tools. */ 'admin.company-location-details.block.render': RenderExtension< BlockExtensionApi<'admin.company-location-details.block.render'>, @@ -134,9 +122,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the gift card details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the gift card details page. Use this to show gift card balance tracking, usage history, or custom gift card metadata. */ 'admin.gift-card-details.block.render': RenderExtension< BlockExtensionApi<'admin.gift-card-details.block.render'>, @@ -144,9 +130,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the product variant details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that displays inline content within the product variant details page. Use this to show variant-specific data, inventory tools, or variant configuration options. */ 'admin.product-variant-details.block.render': RenderExtension< BlockExtensionApi<'admin.product-variant-details.block.render'>, @@ -154,9 +138,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin block in the product details page. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A block target that provides custom reordering functionality on the product details page. Use this to help merchants rearrange product data. */ 'admin.product-details.reorder.render': RenderExtension< BlockExtensionApi<'admin.product-details.reorder.render'>, @@ -165,9 +147,7 @@ export interface ExtensionTargets { // Actions /** - * Renders an admin action extension in the product details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the product details page. Use this to create workflows for processing products, syncing data, or integrating with external systems. */ 'admin.product-details.action.render': RenderExtension< ActionExtensionApi<'admin.product-details.action.render'>, @@ -175,9 +155,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the catalog details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the catalog details page. Use this to create workflows for catalog management, market synchronization, or data exports. */ 'admin.catalog-details.action.render': RenderExtension< ActionExtensionApi<'admin.catalog-details.action.render'>, @@ -185,9 +163,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the company details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the company details page. Use this to create workflows for B2B customer management, credit operations, or company data synchronization. */ 'admin.company-details.action.render': RenderExtension< ActionExtensionApi<'admin.company-details.action.render'>, @@ -195,9 +171,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the gift card details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the gift card details page. Use this to create workflows for gift card processing, balance adjustments, or custom gift card operations. */ 'admin.gift-card-details.action.render': RenderExtension< ActionExtensionApi<'admin.gift-card-details.action.render'>, @@ -205,9 +179,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the order details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the order details page. Use this to create workflows for order processing, fulfillment operations, or external system integrations. */ 'admin.order-details.action.render': RenderExtension< ActionExtensionApi<'admin.order-details.action.render'>, @@ -215,9 +187,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the customer details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the customer details page. Use this to create workflows for customer data management, loyalty operations, or CRM integrations. */ 'admin.customer-details.action.render': RenderExtension< ActionExtensionApi<'admin.customer-details.action.render'>, @@ -225,9 +195,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the customer segment details page. Open this extension from the "Use segment" button. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears from the **Use segment** button on the customer segment details page. Use this to create workflows for marketing campaigns, email operations, or segment-based actions. */ 'admin.customer-segment-details.action.render': RenderExtension< ActionExtensionApi<'admin.customer-segment-details.action.render'>, @@ -235,9 +203,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the product index page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the product index page. Use this to create workflows for product management, catalog operations, or inventory synchronization. */ 'admin.product-index.action.render': RenderExtension< ActionExtensionApi<'admin.product-index.action.render'>, @@ -245,9 +211,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the order index page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the order index page. Use this to create workflows for order management, reporting, or fulfillment operations. */ 'admin.order-index.action.render': RenderExtension< ActionExtensionApi<'admin.order-index.action.render'>, @@ -255,9 +219,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the customer index page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the customer index page. Use this to create workflows for customer management, marketing operations, or bulk data processing. */ 'admin.customer-index.action.render': RenderExtension< ActionExtensionApi<'admin.customer-index.action.render'>, @@ -265,9 +227,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the discount index page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the discount index page. Use this to create workflows for discount management, promotional operations, or bulk discount updates. */ 'admin.discount-index.action.render': RenderExtension< ActionExtensionApi<'admin.discount-index.action.render'>, @@ -275,9 +235,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the collection details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the collection details page. Use this to create workflows for collection management, product operations, or merchandising tools. */ 'admin.collection-details.action.render': RenderExtension< ActionExtensionApi<'admin.collection-details.action.render'>, @@ -285,9 +243,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the collection index page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the collection index page. Use this to create workflows for collection management, bulk operations, or catalog organization. */ 'admin.collection-index.action.render': RenderExtension< ActionExtensionApi<'admin.collection-index.action.render'>, @@ -295,9 +251,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the abandoned checkout page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the abandoned checkout details page. Use this to create workflows for cart recovery, customer engagement, or checkout analysis. */ 'admin.abandoned-checkout-details.action.render': RenderExtension< ActionExtensionApi<'admin.abandoned-checkout-details.action.render'>, @@ -305,9 +259,15 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the product variant details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the abandoned checkout index page. Use this to create workflows for cart recovery, bulk customer engagement, or checkout analysis across multiple abandoned carts. + */ + 'admin.abandoned-checkout-index.action.render': RenderExtension< + ActionExtensionApi<'admin.abandoned-checkout-index.action.render'>, + ActionExtensionComponents + >; + + /** + * An action target that appears in the **More actions** menu on the product variant details page. Use this to create workflows for variant management, inventory operations, or data synchronization. */ 'admin.product-variant-details.action.render': RenderExtension< ActionExtensionApi<'admin.product-variant-details.action.render'>, @@ -315,9 +275,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the draft order details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the draft order details page. Use this to create workflows for draft order processing, custom pricing, or order preparation tools. */ 'admin.draft-order-details.action.render': RenderExtension< ActionExtensionApi<'admin.draft-order-details.action.render'>, @@ -325,9 +283,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the draft orders page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the draft order index page. Use this to create workflows for draft order management, bulk operations, or order conversion tools. */ 'admin.draft-order-index.action.render': RenderExtension< ActionExtensionApi<'admin.draft-order-index.action.render'>, @@ -335,9 +291,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the discount details page. Open this extension from the "More Actions" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the discount details page. Use this to create workflows for discount management, promotion analysis, or discount synchronization. */ 'admin.discount-details.action.render': RenderExtension< ActionExtensionApi<'admin.discount-details.action.render'>, @@ -345,10 +299,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the order fulfilled card. Open this extension from the "3-dot" menu inside the order fulfilled card. - * Note: This extension will only be visible on orders which were fulfilled by your app. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the actions menu inside the order fulfilled card, visible only on orders fulfilled by your app. Use this to create workflows for fulfillment operations, tracking updates, or post-fulfillment actions. */ 'admin.order-fulfilled-card.action.render': RenderExtension< ActionExtensionApi<'admin.order-fulfilled-card.action.render'>, @@ -358,9 +309,7 @@ export interface ExtensionTargets { // Bulk Actions /** - * Renders an admin action extension in the product index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A selection action target that appears in the **More actions** menu on the product index page when multiple products are selected. Use this to create workflows for bulk product operations, batch updates, or mass data processing. */ 'admin.product-index.selection-action.render': RenderExtension< ActionExtensionApi<'admin.product-index.selection-action.render'>, @@ -368,9 +317,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the order index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A selection action target that appears in the **More actions** menu on the order index page when multiple orders are selected. Use this to create workflows for bulk order operations, batch fulfillment, or mass order processing. */ 'admin.order-index.selection-action.render': RenderExtension< ActionExtensionApi<'admin.order-index.selection-action.render'>, @@ -378,9 +325,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the customer index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A selection action target that appears in the **More actions** menu on the customer index page when multiple customers are selected. Use this to create workflows for bulk customer operations, mass email campaigns, or batch data updates. */ 'admin.customer-index.selection-action.render': RenderExtension< ActionExtensionApi<'admin.customer-index.selection-action.render'>, @@ -388,9 +333,15 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the draft order page when multiple resources are selected. Open this extension from the "3-dot" menu. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **More actions** menu on the discount index page when multiple discounts are selected. Use this to create workflows for bulk discount operations or batch data updates. + */ + 'admin.discount-index.selection-action.render': RenderExtension< + ActionExtensionApi<'admin.discount-index.selection-action.render'>, + ActionExtensionComponents + >; + + /** + * A selection action target that appears in the **More actions** menu on the draft order index page when multiple draft orders are selected. Use this to create workflows for bulk draft order operations, batch conversions, or mass order processing. */ 'admin.draft-order-index.selection-action.render': RenderExtension< ActionExtensionApi<'admin.draft-order-index.selection-action.render'>, @@ -398,9 +349,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the product details page when a selling plan group is present. Open this extension from the "Purchase Options card". - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **Purchase Options** card on the product details page when a selling plan group is present. Use this to create workflows for subscription management, selling plan configuration, or purchase option operations. */ 'admin.product-purchase-option.action.render': RenderExtension< PurchaseOptionsCardConfigurationApi<'admin.product-purchase-option.action.render'>, @@ -408,9 +357,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin action extension in the product variant details page when a selling plan group is present. Open this extension from the "Purchase Options card". - * - * See the [list of available components](/docs/api/admin-extensions/components). + * An action target that appears in the **Purchase Options** card on the product variant details page when a selling plan group is present. Use this to create workflows for variant-specific subscription management, selling plan configuration, or purchase option operations. */ 'admin.product-variant-purchase-option.action.render': RenderExtension< PurchaseOptionsCardConfigurationApi<'admin.product-variant-purchase-option.action.render'>, @@ -420,9 +367,7 @@ export interface ExtensionTargets { // Print actions and bulk print actions /** - * Renders an admin print action extension in the order index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A print action target that appears in the **Print** menu on the order details page. Use this to generate custom documents such as packing slips, shipping labels, or invoices. */ 'admin.order-details.print-action.render': RenderExtension< PrintActionExtensionApi<'admin.order-details.print-action.render'>, @@ -430,9 +375,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin print action extension in the product index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A print action target that appears in the **Print** menu on the product details page. Use this to generate custom documents such as product labels, barcode sheets, or specification sheets. */ 'admin.product-details.print-action.render': RenderExtension< PrintActionExtensionApi<'admin.product-details.print-action.render'>, @@ -440,9 +383,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin print action extension in the order index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A print action target that appears in the **Print** menu on the order index page when multiple orders are selected. Use this to generate batch documents such as combined packing slips, shipping manifests, or bulk invoices. */ 'admin.order-index.selection-print-action.render': RenderExtension< PrintActionExtensionApi<'admin.order-index.selection-print-action.render'>, @@ -450,9 +391,7 @@ export interface ExtensionTargets { >; /** - * Renders an admin print action extension in the product index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A print action target that appears in the **Print** menu on the product index page when multiple products are selected. Use this to generate batch documents such as combined product labels, barcode sheets, or catalog pages. */ 'admin.product-index.selection-print-action.render': RenderExtension< PrintActionExtensionApi<'admin.product-index.selection-print-action.render'>, @@ -462,9 +401,7 @@ export interface ExtensionTargets { // Other /** - * Renders Product Configuration on product details and product variant details - * - * See the [tutorial](/docs/apps/selling-strategies/bundles/product-config) for more information + * A configuration target that renders product configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product details page. Use this to define bundle component selections, customization options, or product configuration rules. */ 'admin.product-details.configuration.render': RenderExtension< ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>, @@ -472,9 +409,7 @@ export interface ExtensionTargets { >; /** - * Renders Product Configuration on product details and product variant details - * - * See the [tutorial](/docs/apps/selling-strategies/bundles/product-config) for more information + * A configuration target that renders product variant configuration settings for [product bundles](/docs/apps/build/product-merchandising/bundles/product-configuration-extension/add-merchant-config-ui) and customizable products on the product variant details page. Use this to define variant-specific bundle components, customization options, or configuration rules. */ 'admin.product-variant-details.configuration.render': RenderExtension< ProductVariantDetailsConfigurationApi<'admin.product-variant-details.configuration.render'>, @@ -482,23 +417,23 @@ export interface ExtensionTargets { >; /** - * Renders Order Routing Rule Configuration on order routing settings. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions. + * @private */ 'admin.settings.internal-order-routing-rule.render': RenderExtension< OrderRoutingRuleApi<'admin.settings.internal-order-routing-rule.render'>, FunctionSettingsComponents >; + /** + * A function settings target that renders within order routing settings, allowing merchants to configure order routing rule functions. Use this to build custom configuration interfaces for order routing function parameters. + */ 'admin.settings.order-routing-rule.render': RenderExtension< OrderRoutingRuleApi<'admin.settings.order-routing-rule.render'>, FunctionSettingsComponents >; /** - * Renders Validation Settings within a given validation's add and edit views. - * - * See the [list of available components](/docs/api/admin-extensions/components). + * A function settings target that renders within a validation's add and edit views, allowing merchants to configure validation function settings. Use this to build custom configuration interfaces for validation function parameters and rules. */ 'admin.settings.validation.render': RenderExtension< ValidationSettingsApi<'admin.settings.validation.render'>, @@ -507,7 +442,7 @@ export interface ExtensionTargets { // Admin action shouldRender targets /** - * Controls the render state of an admin action extension in the product details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the product details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on product properties, user permissions, or external data. */ 'admin.product-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.product-details.action.should-render'>, @@ -515,7 +450,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the catalog details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the catalog details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on catalog properties, user permissions, or external data. */ 'admin.catalog-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.catalog-details.action.should-render'>, @@ -523,7 +458,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the company details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the company details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on company properties, user permissions, or external data. */ 'admin.company-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.company-details.action.should-render'>, @@ -531,7 +466,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the gift card details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the gift card details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on gift card properties, user permissions, or external data. */ 'admin.gift-card-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.gift-card-details.action.should-render'>, @@ -539,7 +474,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the order details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on order properties, fulfillment status, or external data. */ 'admin.order-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.order-details.action.should-render'>, @@ -547,7 +482,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the customer details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the customer details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on customer properties, user permissions, or external data. */ 'admin.customer-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.customer-details.action.should-render'>, @@ -555,7 +490,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the customer segment details page. Open this extension from the "Use segment" button. + * A non-rendering target that controls whether the customer segment details action appears from the **Use segment** button. Use this to conditionally show or hide your action based on segment properties, user permissions, or external data. */ 'admin.customer-segment-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.customer-segment-details.action.should-render'>, @@ -563,7 +498,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the product index page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the product index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data. */ 'admin.product-index.action.should-render': RunnableExtension< ShouldRenderApi<'admin.product-index.action.should-render'>, @@ -571,7 +506,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the order index page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data. */ 'admin.order-index.action.should-render': RunnableExtension< ShouldRenderApi<'admin.order-index.action.should-render'>, @@ -579,7 +514,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the customer index page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the customer index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data. */ 'admin.customer-index.action.should-render': RunnableExtension< ShouldRenderApi<'admin.customer-index.action.should-render'>, @@ -587,7 +522,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the discount index page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the discount index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data. */ 'admin.discount-index.action.should-render': RunnableExtension< ShouldRenderApi<'admin.discount-index.action.should-render'>, @@ -595,7 +530,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the collection details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the collection details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on collection properties, user permissions, or external data. */ 'admin.collection-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.collection-details.action.should-render'>, @@ -603,7 +538,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the collection index page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the collection index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data. */ 'admin.collection-index.action.should-render': RunnableExtension< ShouldRenderApi<'admin.collection-index.action.should-render'>, @@ -611,7 +546,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the abandoned checkout page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the abandoned checkout details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on checkout properties, user permissions, or external data. */ 'admin.abandoned-checkout-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.abandoned-checkout-details.action.should-render'>, @@ -619,7 +554,15 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the product variant details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the abandoned checkout index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data. + */ + 'admin.abandoned-checkout-index.action.should-render': RunnableExtension< + ShouldRenderApi<'admin.abandoned-checkout-index.action.should-render'>, + ShouldRenderOutput + >; + + /** + * A non-rendering target that controls whether the product variant details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on variant properties, user permissions, or external data. */ 'admin.product-variant-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.product-variant-details.action.should-render'>, @@ -627,7 +570,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the draft order details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the draft order details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on draft order properties, user permissions, or external data. */ 'admin.draft-order-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.draft-order-details.action.should-render'>, @@ -635,7 +578,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the draft orders page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the draft order index action appears in the **More actions** menu. Use this to conditionally show or hide your action based on user permissions, store configuration, or external data. */ 'admin.draft-order-index.action.should-render': RunnableExtension< ShouldRenderApi<'admin.draft-order-index.action.should-render'>, @@ -643,7 +586,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the discount details page. Open this extension from the "More Actions" menu. + * A non-rendering target that controls whether the discount details action appears in the **More actions** menu. Use this to conditionally show or hide your action based on discount properties, user permissions, or external data. */ 'admin.discount-details.action.should-render': RunnableExtension< ShouldRenderApi<'admin.discount-details.action.should-render'>, @@ -651,8 +594,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the order fulfilled card. Open this extension from the "3-dot" menu inside the order fulfilled card. - * Note: This extension will only be visible on orders which were fulfilled by your app. + * A non-rendering target that controls whether the order fulfilled card action appears in the actions menu. Use this to conditionally show or hide your action based on fulfillment properties, user permissions, or external data. */ 'admin.order-fulfilled-card.action.should-render': RunnableExtension< ShouldRenderApi<'admin.order-fulfilled-card.action.should-render'>, @@ -662,7 +604,7 @@ export interface ExtensionTargets { // Admin bulk action shouldRender targets /** - * Controls the render state of an admin action extension in the product index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime. + * A non-rendering target that controls whether the product index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data. */ 'admin.product-index.selection-action.should-render': RunnableExtension< ShouldRenderApi<'admin.product-index.selection-action.should-render'>, @@ -670,7 +612,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the order index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime. + * A non-rendering target that controls whether the order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data. */ 'admin.order-index.selection-action.should-render': RunnableExtension< ShouldRenderApi<'admin.order-index.selection-action.should-render'>, @@ -678,7 +620,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the customer index page when multiple resources are selected. Open this extension from the "More Actions" menu of the resource list. The resource ids are available to this extension at runtime. + * A non-rendering target that controls whether the customer index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data. */ 'admin.customer-index.selection-action.should-render': RunnableExtension< ShouldRenderApi<'admin.customer-index.selection-action.should-render'>, @@ -686,7 +628,15 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin action extension in the draft order page when multiple resources are selected. Open this extension from the "3-dot" menu. + * A non-rendering target that controls whether the discount index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data. + */ + 'admin.discount-index.selection-action.should-render': RunnableExtension< + ShouldRenderApi<'admin.discount-index.selection-action.should-render'>, + ShouldRenderOutput + >; + + /** + * A non-rendering target that controls whether the draft order index selection action appears in the **More actions** menu. Use this to conditionally show or hide your bulk action based on selection criteria, user permissions, or external data. */ 'admin.draft-order-index.selection-action.should-render': RunnableExtension< ShouldRenderApi<'admin.draft-order-index.selection-action.should-render'>, @@ -696,7 +646,7 @@ export interface ExtensionTargets { // Admin print action and bulk print action shouldRender targets /** - * Controls the render state of an admin print action extension in the order index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime. + * A non-rendering target that controls whether the order details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on order properties, user permissions, or external data. */ 'admin.order-details.print-action.should-render': RunnableExtension< ShouldRenderApi<'admin.order-details.print-action.should-render'>, @@ -704,7 +654,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin print action extension in the product index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime. + * A non-rendering target that controls whether the product details print action appears in the **Print** menu. Use this to conditionally show or hide your print action based on product properties, user permissions, or external data. */ 'admin.product-details.print-action.should-render': RunnableExtension< ShouldRenderApi<'admin.product-details.print-action.should-render'>, @@ -712,7 +662,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin print action extension in the order index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime. + * A non-rendering target that controls whether the order index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data. */ 'admin.order-index.selection-print-action.should-render': RunnableExtension< ShouldRenderApi<'admin.order-index.selection-print-action.should-render'>, @@ -720,7 +670,7 @@ export interface ExtensionTargets { >; /** - * Controls the render state of an admin print action extension in the product index page when multiple resources are selected. Open this extension from the "Print" menu of the resource list. The resource ids are available to this extension at runtime. + * A non-rendering target that controls whether the product index selection print action appears in the **Print** menu. Use this to conditionally show or hide your bulk print action based on selection criteria, user permissions, or external data. */ 'admin.product-index.selection-print-action.should-render': RunnableExtension< ShouldRenderApi<'admin.product-index.selection-print-action.should-render'>, @@ -728,12 +678,31 @@ export interface ExtensionTargets { >; /** - * Provides tools data for the admin tools functionality. + * A runnable target that enables your app to expose data to [Sidekick](/docs/apps/build/sidekick/build-app-data). Use this target to register tools that Sidekick can invoke to search your app's data and answer merchant questions. */ 'admin.app.tools.data': RunnableExtension< StandardApi<'admin.app.tools.data'>, undefined >; + + /** + * Renders an admin extension for handling app intents. + */ + 'admin.app.intent.render': RenderExtension< + IntentRenderApi<'admin.app.intent.render'>, + FormExtensionComponents + >; + + /** + * Renders an admin extension on the app home page. + */ + 'admin.app.home.render': RenderExtension< + AppHomeApi<'admin.app.home.render'>, + FormExtensionComponents | 'Modal' | 'Page' | 'AppNav' + >; } +/** + * A string literal union of all valid extension target identifiers. Use this type to specify where your admin UI extension should render, such as `admin.product-details.block.render` for a block on product details pages or `admin.order-details.action.render` for an action on order details pages. The target determines the extension's location, available APIs, and UI components. + */ export type ExtensionTarget = keyof ExtensionTargets; diff --git a/packages/ui-extensions/src/surfaces/checkout.ts b/packages/ui-extensions/src/surfaces/checkout.ts index 72aafda260..61ba12e56f 100644 --- a/packages/ui-extensions/src/surfaces/checkout.ts +++ b/packages/ui-extensions/src/surfaces/checkout.ts @@ -126,9 +126,7 @@ export type { MetafieldChangeResultError, MetafieldChangeResultSuccess, MetafieldChangeResult, - MetafieldRemoveChange, MetafieldRemoveCartChange, - MetafieldUpdateChange, MetafieldUpdateCartChange, NoteChange, NoteChangeResult, diff --git a/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts b/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts index f0816945db..a18fb1732e 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts @@ -3,6 +3,7 @@ import type { AutocompleteAddress, } from './shared'; +/** @publicDocs */ export interface AddressAutocompleteFormatSuggestionApi { /** * The autocomplete suggestion that the buyer selected during checkout. @@ -16,6 +17,7 @@ interface Target { selectedSuggestion: AddressAutocompleteSuggestion; } +/** @publicDocs */ export interface AddressAutocompleteFormatSuggestionOutput { /** * The formatted address that will be used to populate the native address fields. diff --git a/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/shared.ts b/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/shared.ts index 30620433c9..6129df8944 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/shared.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/shared.ts @@ -4,6 +4,7 @@ import type {MailingAddress} from '../../../checkout'; * An address object used to auto-populate the address form fields. * * All fields are optional + * @publicDocs */ export interface AutocompleteAddress extends Pick< @@ -35,6 +36,7 @@ export interface AutocompleteAddress longitude?: number; } +/** @publicDocs */ export interface AddressAutocompleteSuggestion { /** * The address suggestion text presented to the buyer in the list of autocomplete suggestions. @@ -72,6 +74,7 @@ export interface AddressAutocompleteSuggestion { formattedAddress?: AutocompleteAddress; } +/** @publicDocs */ export interface MatchedSubstring { /** * The start location of the matched substring in the suggestion label text. diff --git a/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts b/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts index a627d211a2..2723832999 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts @@ -9,7 +9,6 @@ import type { I18n, Language, Market, - Metafield, SessionToken, Shop, Storage, @@ -24,6 +23,7 @@ import type { Timezone, } from '../../../../shared'; +/** @publicDocs */ export interface AddressAutocompleteStandardApi< Target extends | 'purchase.address-autocomplete.suggest' @@ -88,23 +88,11 @@ export interface AddressAutocompleteStandardApi< /** * The details about the location, language, and currency of the customer. For utilities to easily * format and translate content based on these details, you can use the - * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) + * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#properties-propertydetail-i18n) * object instead. */ localization: Localization; - /** - * The metafields that apply to the current checkout. - * - * Metafields are stored locally on the client and are applied to the order object after the checkout completes. - * They are shared by all extensions running on checkout, and - * persist for as long as the customer is working on this checkout. - * - * Once the order is created, you can query these metafields using the - * [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01) - */ - metafields: Metafield[]; - /** * The method used to query the Storefront GraphQL API with a prefetched token. * @@ -122,7 +110,7 @@ export interface AddressAutocompleteStandardApi< * * If the previous token expires, this value will reflect a new session token with a new signature and expiry. * - * Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/session-token) for more information. + * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens). */ sessionToken: SessionToken; diff --git a/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/suggest.ts b/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/suggest.ts index 5a147d1272..d80499b16c 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/suggest.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/suggest.ts @@ -2,6 +2,7 @@ import type {CountryCode} from '../../../checkout'; import type {AddressAutocompleteSuggestion} from './shared'; +/** @publicDocs */ export interface AddressAutocompleteSuggestApi { /** * The signal that the extension should listen to for cancellation requests. @@ -51,11 +52,12 @@ interface Target { selectedCountryCode?: CountryCode; } +/** @publicDocs */ export interface AddressAutocompleteSuggestOutput { /** * An array of address autocomplete suggestions to show to the buyer. - * - * > Note: Only the first five suggestions will be displayed to the buyer. + * Checkout displays up to five address suggestions. Return no more + * than five. Additional suggestions are ignored. */ suggestions: AddressAutocompleteSuggestion[]; } diff --git a/packages/ui-extensions/src/surfaces/checkout/api/announcement/announcement.ts b/packages/ui-extensions/src/surfaces/checkout/api/announcement/announcement.ts index 0005fe3f06..ea09b6467b 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/announcement/announcement.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/announcement/announcement.ts @@ -1,3 +1,4 @@ +/** @publicDocs */ export interface Announcement { announcement: { close(): void; diff --git a/packages/ui-extensions/src/surfaces/checkout/api/cart-line/cart-line-item.ts b/packages/ui-extensions/src/surfaces/checkout/api/cart-line/cart-line-item.ts index 7f8a6f0d1e..582c4565ac 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/cart-line/cart-line-item.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/cart-line/cart-line-item.ts @@ -1,9 +1,17 @@ import type {SubscribableSignalLike} from '../../shared'; import type {CartLine} from '../standard/standard'; +/** @publicDocs */ export interface CartLineItemApi { /** - * The cart line the extension is attached to. Until version `2023-04`, this property was a `ReadonlySignalLike`. + * The cart line that this extension is attached to. Use this to read the + * line item's merchandise, quantity, cost, and attributes. + * + * Available only on the corresponding item target. Shipping option item + * targets expose shipping option properties; pickup location item targets + * expose pickup location properties. + * + * > Note: Until version `2023-04`, this property was a `ReadonlySignalLike`. */ target: SubscribableSignalLike; } diff --git a/packages/ui-extensions/src/surfaces/checkout/api/checkout/checkout.ts b/packages/ui-extensions/src/surfaces/checkout/api/checkout/checkout.ts index 5470dce200..046527eb42 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/checkout/checkout.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/checkout/checkout.ts @@ -6,280 +6,361 @@ import type { } from '../shared'; /** - * Removes a note + * Clears the buyer's note from the checkout. Pass this to `applyNoteChange()` to remove any existing note. + * @publicDocs */ export interface NoteRemoveChange { /** - * The type of the `NoteRemoveChange` API. + * Identifies this as a note removal. Set this when creating a change to clear the buyer's note. */ type: 'removeNote'; } /** - * An Update to a note on the order. - * for example, the buyer could request detailed packaging instructions in an order note + * Sets or replaces the buyer's note on the checkout. Pass this to `applyNoteChange()` to update the note. + * @publicDocs */ export interface NoteUpdateChange { /** - * The type of the `NoteUpdateChange` API. + * Identifies this as a note update. Set this when creating a change to set or replace the buyer's note. */ type: 'updateNote'; /** - * The new value of the note. + * The text to set as the buyer's note. This replaces any existing note entirely rather than appending to it. */ note: string; } +/** + * The input for `applyNoteChange()`. Pass either a `NoteUpdateChange` (with `type: 'updateNote'`) to set the note or a `NoteRemoveChange` (with `type: 'removeNote'`) to clear it. + * @publicDocs + */ export type NoteChange = NoteRemoveChange | NoteUpdateChange; +/** + * The result of a successful note change. The `type` property is `'success'`. + * @publicDocs + */ export interface NoteChangeResultSuccess { /** - * The type of the `NoteChangeResultSuccess` API. + * Indicates that the note change was applied successfully. */ type: 'success'; } +/** + * The result of a failed note change. Check the `message` property for details about what went wrong. + * @publicDocs + */ export interface NoteChangeResultError { /** - * The type of the `NoteChangeResultError` API. + * Indicates that the note change couldn't be applied. Check the `message` property for details. */ type: 'error'; /** * A message that explains the error. This message is useful for debugging. - * It is **not** localized, and therefore should not be presented directly + * It isn't localized and shouldn't be displayed to the buyer. + * + * Render your own localized error text rather than displaying this message * to the buyer. */ message: string; } +/** + * The result of calling `applyNoteChange()`. Use the `type` property to determine whether the change succeeded or failed. + * @publicDocs + */ export type NoteChangeResult = NoteChangeResultSuccess | NoteChangeResultError; /** - * Updates an attribute on the order. If an attribute with the - * provided key does not already exist, it gets created. + * Updates an attribute on the cart and checkout. If an attribute with the + * provided key doesn't already exist, then it gets created. + * @publicDocs */ export interface AttributeUpdateChange { /** - * The type of the `AttributeUpdateChange` API. + * Identifies this as an attribute update or creation. Set this when creating a change to add or replace an attribute value. */ type: 'updateAttribute'; /** - * Key of the attribute to add or update + * The key of the attribute to add or update. If an attribute with this key + * already exists, then its value is replaced. */ key: string; /** - * Value for the attribute to add or update + * The new value for the attribute. */ value: string; } /** - * Removes an attribute on the order if an attribute with the - * provided key already exists. + * Removes an attribute from the checkout. Pass this to `applyAttributeChange()` to delete an attribute by key. If the key doesn't exist, then the change has no effect. + * @publicDocs */ export interface AttributeRemoveChange { /** - * The type of the `AttributeRemoveChange` API. + * Identifies this as an attribute removal. Set this when creating a change to delete an attribute by key. */ type: 'removeAttribute'; /** - * Key of the attribute to remove + * The key of the attribute to remove. */ key: string; } +/** + * The input for `applyAttributeChange()`. Pass either an `AttributeUpdateChange` (with `type: 'updateAttribute'`) to set the attribute or an `AttributeRemoveChange` (with `type: 'removeAttribute'`) to delete it. + * @publicDocs + */ export type AttributeChange = AttributeUpdateChange | AttributeRemoveChange; /** - * The returned result of a successful update to an attribute. + * The result of a successful attribute change. The `type` property is `'success'`. + * @publicDocs */ export interface AttributeChangeResultSuccess { /** - * The type of the `AttributeChangeResultSuccess` API. + * Indicates that the attribute change was applied successfully. */ type: 'success'; } /** - * The returned result of an unsuccessful update to an attribute - * with a message detailing the type of error that occurred. + * The result of a failed attribute change. Check the `message` property for details about what went wrong. + * @publicDocs */ export interface AttributeChangeResultError { /** - * The type of the `AttributeChangeResultError` API. + * Indicates that the attribute change couldn't be applied. Check the `message` property for details. */ type: 'error'; /** * A message that explains the error. This message is useful for debugging. - * It is **not** localized, and therefore should not be presented directly - * to the buyer. + * It isn't localized and shouldn't be displayed to the buyer. */ message: string; } +/** + * The result of calling `applyAttributeChange()`. Use the `type` property to determine whether the change succeeded or failed. + * @publicDocs + */ export type AttributeChangeResult = | AttributeChangeResultSuccess | AttributeChangeResultError; +/** + * The result of a successful cart line change. The `type` property is `'success'`. + * @publicDocs + */ export interface CartLineChangeResultSuccess { /** - * Indicates that the line item was changed successfully. + * Indicates that the cart line change was applied successfully. */ type: 'success'; } +/** + * The result of a failed cart line change. Check the `message` property for details about what went wrong. + * @publicDocs + */ export interface CartLineChangeResultError { /** - * Indicates that the line item was not changed successfully. Refer to the `message` property for details about the error. + * Indicates that the line item wasn't changed successfully. Refer to the `message` property for details about the error. */ type: 'error'; /** * A message that explains the error. This message is useful for debugging. - * It is **not** localized, and therefore should not be presented directly + * It isn't localized and shouldn't be displayed to the buyer. + * + * Render your own localized error text rather than displaying this message * to the buyer. */ message: string; } +/** + * The result of calling `applyCartLinesChange()`. Use the `type` property to determine whether the change succeeded or failed. + * @publicDocs + */ export type CartLineChangeResult = | CartLineChangeResultSuccess | CartLineChangeResultError; +/** + * The input for `applyCartLinesChange()`. Use the `type` property to specify the operation. + * + * - `CartLineAddChange` (`type: 'addCartLine'`): Adds a new line item to the cart. + * - `CartLineRemoveChange` (`type: 'removeCartLine'`): Removes an existing line item. + * - `CartLineUpdateChange` (`type: 'updateCartLine'`): Updates an existing line item's quantity, variant, or attributes. + * @publicDocs + */ export type CartLineChange = | CartLineAddChange | CartLineRemoveChange | CartLineUpdateChange; +/** + * Adds a new line item to the cart. Pass this to `applyCartLinesChange()` to add a product variant with a specified quantity and optional attributes. + * @publicDocs + */ export interface CartLineAddChange { /** - * An identifier for changes that add line items. + * Identifies this as a line item addition. Set this when creating a change to add a new product to the cart. */ type: 'addCartLine'; /** - * The merchandise ID being added. + * The globally-unique identifier of the product variant to add. * @example 'gid://shopify/ProductVariant/123' */ merchandiseId: string; /** - * The quantity of the merchandise being added. + * The number of items to add. Must be a positive integer. */ quantity: number; /** - * The attributes associated with the line item. + * Custom key-value attributes to attach to the new line item. */ attributes?: Attribute[]; /** - * The identifier of the selling plan that the merchandise is being purchased - * with. + * The identifier of the [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) to associate with this line item, such as a subscription or pre-order plan. */ sellingPlanId?: SellingPlan['id']; /** - * The identifier for the associated parent cart line. + * The parent cart line to associate the new item with, identified by either `lineId` or `merchandiseId`. Use this when adding child items to a bundle. */ parent?: {lineId: string} | {merchandiseId: string}; } +/** + * Removes an existing line item from the cart. Pass this to `applyCartLinesChange()` to remove a specified quantity of a line item. + * @publicDocs + */ export interface CartLineRemoveChange { /** - * An identifier for changes that remove line items. + * Identifies this as a line item removal. Set this when creating a change to remove a product from the cart. */ type: 'removeCartLine'; /** - * Line Item ID. + * The unique identifier of the cart line to remove. Look up the current ID from `lines` before calling, because cart line IDs aren't stable. * @example 'gid://shopify/CartLine/123' */ id: string; /** - * The quantity being removed for this line item. + * The number of items to remove from this line. */ quantity: number; } +/** + * Updates an existing line item in the cart. Pass this to `applyCartLinesChange()` to change a line item's quantity, variant, selling plan, or attributes. + * @publicDocs + */ export interface CartLineUpdateChange { /** - * An identifier for changes that update line items. + * Identifies this as a line item update. Set this when creating a change to modify a line item's quantity, variant, or attributes. */ type: 'updateCartLine'; /** - * Line Item ID. + * The unique identifier of the cart line to update. Look up the current ID from `lines` before calling, because cart line IDs aren't stable. * @example 'gid://shopify/CartLine/123' */ id: string; /** - * The new merchandise ID for the line item. + * The new product variant to swap in for this line item. Only provide this if you want to change the variant. * @example 'gid://shopify/ProductVariant/123' */ merchandiseId?: string; /** - * The new quantity for the line item. + * The new quantity for this line item. Only provide this if you want to change the quantity. */ quantity?: number; /** - * The new attributes for the line item. + * The new custom key-value attributes for this line item. Replaces all existing attributes when provided. */ attributes?: Attribute[]; /** - * The identifier of the selling plan that the merchandise is being purchased - * with or `null` to remove the the product from the selling plan. + * The [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) to associate with this line item. Pass `null` to remove the item from its current selling plan. */ sellingPlanId?: SellingPlan['id'] | null; /** - * The identifier for the associated parent cart line. + * The parent cart line to associate this item with. Use this when updating the parent relationship for bundled items. */ parent?: {lineId: string} | {merchandiseId: string}; } +/** + * The input for `applyDiscountCodeChange()`. Pass either a `DiscountCodeAddChange` (with `type: 'addDiscountCode'`) to apply a code or a `DiscountCodeRemoveChange` (with `type: 'removeDiscountCode'`) to remove it. + * @publicDocs + */ export type DiscountCodeChange = | DiscountCodeAddChange | DiscountCodeRemoveChange; +/** + * The result of calling `applyDiscountCodeChange()`. Use the `type` property to determine whether the change succeeded or failed. + * @publicDocs + */ export type DiscountCodeChangeResult = | DiscountCodeChangeResultSuccess | DiscountCodeChangeResultError; +/** + * Applies a discount code to the checkout. Pass this to `applyDiscountCodeChange()` to add a code. + * @publicDocs + */ export interface DiscountCodeAddChange { /** - * The type of the `DiscountCodeChange` API. + * Identifies this as a discount code addition. Set this when creating a change to apply a discount code to the checkout. */ type: 'addDiscountCode'; /** - * The code for the discount (case-insensitive) + * The discount code to apply. Codes are case-insensitive. */ code: string; } +/** + * Removes a discount code from the checkout. Pass this to `applyDiscountCodeChange()` to remove a code. + * @publicDocs + */ export interface DiscountCodeRemoveChange { /** - * The type of the `DiscountCodeChange` API. + * Identifies this as a discount code removal. Set this when creating a change to remove a discount code from the checkout. */ type: 'removeDiscountCode'; /** - * The code for the discount (case-insensitive) + * The discount code to remove. Codes are case-insensitive. */ code: string; } +/** + * The result of a successful discount code change. The `type` property is `'success'`. + * @publicDocs + */ export interface DiscountCodeChangeResultSuccess { /** * Indicates that the discount code change was applied successfully. @@ -287,50 +368,74 @@ export interface DiscountCodeChangeResultSuccess { type: 'success'; } +/** + * The result of a failed discount code change. Check the `message` property for details about what went wrong. + * @publicDocs + */ export interface DiscountCodeChangeResultError { /** - * Indicates that the discount code change failed. + * Indicates that the discount code change couldn't be applied. Check the `message` property for details. */ type: 'error'; /** * A message that explains the error. This message is useful for debugging. - * It is **not** localized, and therefore should not be presented directly - * to the buyer. + * It isn't localized and shouldn't be displayed to the buyer. */ message: string; } +/** + * The input for `applyGiftCardChange()`. Pass either a `GiftCardAddChange` (with `type: 'addGiftCard'`) to apply a gift card or a `GiftCardRemoveChange` (with `type: 'removeGiftCard'`) to remove it. + * @publicDocs + */ export type GiftCardChange = GiftCardAddChange | GiftCardRemoveChange; +/** + * The result of calling `applyGiftCardChange()`. Use the `type` property to determine whether the change succeeded or failed. + * @publicDocs + */ export type GiftCardChangeResult = | GiftCardChangeResultSuccess | GiftCardChangeResultError; +/** + * Applies a gift card to the checkout. Pass this to `applyGiftCardChange()` to add a gift card. + * @publicDocs + */ export interface GiftCardAddChange { /** - * The type of the `GiftCardChange` API. + * Identifies this as a gift card addition. Set this when creating a change to apply a gift card to the checkout. */ type: 'addGiftCard'; /** - * Gift card code. + * The full gift card code to apply to the checkout. */ code: string; } +/** + * Removes a gift card from the checkout. Pass this to `applyGiftCardChange()` to remove a gift card. + * @publicDocs + */ export interface GiftCardRemoveChange { /** - * The type of the `GiftCardChange` API. + * Identifies this as a gift card removal. Set this when creating a change to remove a gift card from the checkout. */ type: 'removeGiftCard'; /** - * The full gift card code, or the last four digits of the code. + * The gift card code to remove. You can pass either the full code or + * just the last four characters. */ code: string; } +/** + * The result of a successful gift card change. The `type` property is `'success'`. + * @publicDocs + */ export interface GiftCardChangeResultSuccess { /** * Indicates that the gift card change was applied successfully. @@ -338,42 +443,33 @@ export interface GiftCardChangeResultSuccess { type: 'success'; } +/** + * The result of a failed gift card change. Check the `message` property for details about what went wrong. + * @publicDocs + */ export interface GiftCardChangeResultError { /** - * Indicates that the gift card change failed. + * Indicates that the gift card change couldn't be applied. Check the `message` property for details. */ type: 'error'; /** * A message that explains the error. This message is useful for debugging. - * It is **not** localized, and therefore should not be presented directly + * It isn't localized and shouldn't be displayed to the buyer. + * + * Render your own localized error text rather than displaying this message * to the buyer. */ message: string; } -/** Removes a metafield. */ -export interface MetafieldRemoveChange { - /** - * The type of the `MetafieldRemoveChange` API. - */ - type: 'removeMetafield'; - - /** - * The name of the metafield to remove. - */ - key: string; - - /** - * The namespace of the metafield to remove. - */ - namespace: string; -} - -/** Removes a cart metafield. */ +/** + * Removes a cart [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to delete a metafield by key and namespace. + * @publicDocs + */ export interface MetafieldRemoveCartChange { /** - * The type of the `MetafieldRemoveChange` API. + * Identifies this as a cart metafield removal. Set this when creating a change to delete an existing metafield by key and namespace. */ type: 'removeCartMetafield'; @@ -389,45 +485,23 @@ export interface MetafieldRemoveCartChange { } /** - * Updates a metafield. If a metafield with the - * provided key and namespace does not already exist, it gets created. - */ -export interface MetafieldUpdateChange { - /** - * The type of the `MetafieldUpdateChange` API. - */ - type: 'updateMetafield'; - - /** The name of the metafield to update. */ - key: string; - - /** The namespace of the metafield to add. */ - namespace: string; - - /** The new information to store in the metafield. */ - value: string | number; - - /** - * The metafield’s information type. - */ - valueType: 'integer' | 'string' | 'json_string'; -} - -/** - * Updates a cart metafield. If a metafield with the - * provided key and namespace does not already exist, it gets created. + * Creates or updates a cart [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields). Pass this to `applyMetafieldChange()` to set a metafield value. If a metafield with the provided key and namespace doesn't already exist, then it gets created. + * @publicDocs */ export interface MetafieldUpdateCartChange { /** - * The type of the `MetafieldUpdateChange` API. + * Identifies this as a cart metafield creation or update. Set this when creating a change to set a metafield value. */ type: 'updateCartMetafield'; + /** + * The metafield data to set on the cart. If a metafield with this key and namespace already exists, then its value is replaced. + */ metafield: { /** The name of the metafield to update. */ key: string; - /** The namespace of the metafield to add. */ + /** The namespace of the metafield to update. */ namespace?: string; /** The new information to store in the metafield. */ @@ -435,170 +509,210 @@ export interface MetafieldUpdateCartChange { /** * The metafield’s information type. - * See the [`metafields documentation`](https://shopify.dev/docs/apps/custom-data/metafields/types) for a list of supported types. + * See the [metafield types documentation](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types) for a list of supported types. */ type: string; }; } +/** + * The input for `applyMetafieldChange()`. Use the `type` property to specify the operation. + * + * - `MetafieldRemoveCartChange` (`type: 'removeCartMetafield'`): Removes an existing cart [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields). + * - `MetafieldUpdateCartChange` (`type: 'updateCartMetafield'`): Creates or updates a cart metafield. + * @publicDocs + */ export type MetafieldChange = - | MetafieldRemoveChange - | MetafieldUpdateChange | MetafieldRemoveCartChange | MetafieldUpdateCartChange; +/** + * The result of a successful metafield change. The `type` property is `'success'`. + * @publicDocs + */ export interface MetafieldChangeResultSuccess { /** - * The type of the `MetafieldChangeResultSuccess` API. + * Indicates that the metafield change was applied successfully. */ type: 'success'; } +/** + * The result of a failed metafield change. Check the `message` property for details about what went wrong. + * @publicDocs + */ export interface MetafieldChangeResultError { /** - * The type of the `MetafieldChangeResultError` API. + * Indicates that the metafield change couldn't be applied. Check the `message` property for details. */ type: 'error'; /** * A message that explains the error. This message is useful for debugging. - * It is **not** localized, and therefore should not be presented directly + * It isn't localized and shouldn't be displayed to the buyer. + * + * Render your own localized error text rather than displaying this message * to the buyer. */ message: string; } +/** + * The result of calling `applyMetafieldChange()`. Use the `type` property to determine whether the change succeeded or failed. + * @publicDocs + */ export type MetafieldChangeResult = | MetafieldChangeResultSuccess | MetafieldChangeResultError; +/** + * Updates the buyer's shipping address on the checkout. Pass this to `applyShippingAddressChange()` to modify specific address fields without replacing the entire address. + * @publicDocs + */ export interface ShippingAddressUpdateChange { /** - * The type of the `ShippingAddressUpdateChange` API. + * Identifies this as a shipping address update. This is the only supported change type for `applyShippingAddressChange()`. */ type: 'updateShippingAddress'; /** * Fields to update in the shipping address. You only need to provide - * values for the fields you want to update — any fields you do not list - * will keep their current values. + * values for the fields you want to update. Any fields you don't list + * keep their current values. */ address: Partial; } +/** + * The input for `applyShippingAddressChange()`. Currently only supports `ShippingAddressUpdateChange` (with `type: 'updateShippingAddress'`). + * @publicDocs + */ export type ShippingAddressChange = ShippingAddressUpdateChange; /** - * The returned result of a successful update to the shipping address. + * The result of a successful shipping address change. The `type` property is `'success'` and `errors` is `null`. + * @publicDocs */ export interface ShippingAddressChangeResultSuccess { /** - * The type of the `ShippingAddressChangeResultSuccess` API. + * Indicates that the shipping address change was applied successfully. */ type: 'success'; + /** + * Always `null` for a successful address change. Present so that you can + * check `result.errors` without narrowing the union type first. + */ errors: null; } /** - * An error corresponding to a particular field from a given change + * An error corresponding to a particular field from a given change. Use the `field` property to determine which address field caused the error. + * @publicDocs */ export interface ShippingAddressChangeFieldError { /** - * field key from MailingAddress where the error occurred + * The `MailingAddress` field that caused the error, such as `'countryCode'` or `'zip'`. The value is `undefined` if the error isn't specific to a single field. */ field?: keyof MailingAddress; /** * A message that explains the error. This message is useful for debugging. - * It is **not** localized, and therefore should not be presented directly - * to the buyer. + * It isn't localized and shouldn't be displayed to the buyer. */ message: string; } /** - * The returned result of an update to the shipping address - * with a messages detailing the type of errors that occurred. + * The result of a failed shipping address change. Check the `errors` array for field-level details about what went wrong. + * @publicDocs */ export interface ShippingAddressChangeResultError { /** - * The type of the `ShippingAddressChangeResultError` API. + * Indicates that the shipping address change couldn't be applied. Check the `errors` array for field-level details. */ type: 'error'; /** - * The errors corresponding to particular fields from a given change + * The list of field-level errors that prevented the address change. Each entry identifies which address field failed and why. */ errors: ShippingAddressChangeFieldError[]; } +/** + * The result of calling `applyShippingAddressChange()`. Use the `type` property to determine whether the change succeeded or failed. On failure, the `errors` array contains field-level details. + * @publicDocs + */ export type ShippingAddressChangeResult = | ShippingAddressChangeResultSuccess | ShippingAddressChangeResultError; +/** + * @publicDocs + * Methods for modifying the checkout, including cart lines, discount codes, gift cards, metafields, notes, attributes, and the shipping address. Each method returns a promise that resolves with a result indicating success or failure. + */ export interface CheckoutApi { /** - * Performs an update on an attribute attached to the cart and checkout. If - * successful, this mutation results in an update to the value retrieved - * through the [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property. + * Updates or removes an attribute on the cart and checkout. On success, the + * [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/attributes#properties-propertydetail-attributes) property updates to reflect the change. + * + * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. * - * > Note: This method will return an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `attributes.canUpdateAttributes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. + * @deprecated Use cart metafields instead. */ applyAttributeChange(change: AttributeChange): Promise; /** - * Performs an update on the merchandise line items. It resolves when the new - * line items have been negotiated and results in an update to the value - * retrieved through the - * [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines) - * property. + * Adds, removes, or updates line items in the cart. The returned promise resolves when the change has been applied by the server, and the [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-lines#properties-propertydetail-lines) property updates with the new state. * - * > Note: This method will return an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. + * Accepts a single change per call. To make multiple changes, call this + * method separately for each one. + * + * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `lines.canAddCartLine` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. */ applyCartLinesChange(change: CartLineChange): Promise; /** - * Performs an update on the discount codes. - * It resolves when the new discount codes have been negotiated and results in an update - * to the value retrieved through the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property. + * Adds or removes a discount code on the checkout. The returned promise resolves when the change has been applied by the server, and the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/discounts#properties-propertydetail-discountcodes) property updates with the new state. * * > Caution: - * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call. + * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves discount codes through a network call. * - * > Note: This method will return an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. + * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `discounts.canUpdateDiscountCodes` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. */ applyDiscountCodeChange( change: DiscountCodeChange, ): Promise; /** - * Performs an update on the gift cards. - * It resolves when gift card change have been negotiated and results in an update - * to the value retrieved through the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property. + * Adds or removes a gift card from the checkout. The returned promise resolves when the change has been applied by the server, and the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/gift-cards#properties-propertydetail-appliedgiftcards) property updates with the new state. + * + * Unlike other write operations, gift card changes aren't gated by a cart + * instruction flag. * * > Caution: - * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call. + * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#network-access) if your extension retrieves gift card codes through a network call. * - * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. + * > Note: This method returns an error if the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. */ applyGiftCardChange(change: GiftCardChange): Promise; /** - * Performs an update on a piece of metadata attached to the checkout. If - * successful, this mutation results in an update to the value retrieved - * through the [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property. + * Creates, updates, or removes a cart metafield on the checkout. On success, the + * [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/metafields#properties-propertydetail-metafields) property updates to reflect the change. + * + * Cart metafields are copied to order metafields at order creation time if there's a matching order metafield definition with the [`cart to order copyable`](https://shopify.dev/docs/apps/build/metafields/use-metafield-capabilities#cart-to-order-copyable) capability enabled. * - * > Note: This method will return an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. + * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `metafields.canSetCartMetafields` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. */ applyMetafieldChange(change: MetafieldChange): Promise; /** - * Performs an update on the note attached to the cart and checkout. If - * successful, this mutation results in an update to the value retrieved - * through the [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property. + * Sets or removes the buyer's note on the checkout. On success, the + * [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/note#properties-propertydetail-note) + * property updates to reflect the change. * - * > Note: This method will return an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. + * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `notes.canUpdateNote` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. */ applyNoteChange(change: NoteChange): Promise; @@ -608,14 +722,13 @@ export interface CheckoutApi { experimentalIsShopAppStyle?: boolean; /** - * Performs an update of the shipping address. Shipping address changes will - * completely overwrite the existing shipping address added by the user without - * any prompts. If successful, this mutation results in an update to the value - * retrieved through the `shippingAddress` property. + * Updates the buyer's shipping address on the checkout. The provided fields + * are merged into the existing address without prompting the buyer. On success, + * the `shippingAddress` property updates to reflect the change. * - * > Note: This method will return an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cart-instructions#standardapi-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. + * > Note: This method returns an error if the [cart instruction](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#properties-propertydetail-instructions) `delivery.canSelectCustomAddress` is false, or the buyer is using an accelerated checkout method, such as Apple Pay or Google Pay. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ applyShippingAddressChange?( change: ShippingAddressChange, diff --git a/packages/ui-extensions/src/surfaces/checkout/api/docs.ts b/packages/ui-extensions/src/surfaces/checkout/api/docs.ts index 9fe7332956..ac4825a81a 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/docs.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/docs.ts @@ -2,103 +2,134 @@ import type {StandardApi} from './standard/standard'; import type {CheckoutApi} from './checkout/checkout'; import type {CartLineItemApi} from './cart-line/cart-line-item'; -/** +/* * These types are used to generate the documentation for the API and decipher which properties are available for which APIs. * If you are adding a new property and you'd like it to be documented in the API section, then you'll need to specify the property in the appropriate interface below. * * Note: These are not exported as part of the package, they are only used for documentation purposes. */ +/** @publicDocs */ export interface Docs_Standard_AddressApi extends Pick {} +/** @publicDocs */ export interface Docs_Checkout_AddressApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_AttributesApi extends Pick {} +/** @publicDocs */ export interface Docs_Checkout_AttributesApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_BuyerIdentityApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_BuyerJourneyApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_CartInstructionsApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_CartLinesApi extends Pick {} +/** @publicDocs */ export interface Docs_Checkout_CartLinesApi extends Pick {} +/** @publicDocs */ export interface Docs_CartLineItem_CartLinesApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_CostApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_LocalizationApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_LocalizedFieldsApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_MetafieldsApi - extends Pick {} + extends Pick {} +/** @publicDocs */ export interface Docs_Checkout_MetafieldsApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_DeliveryApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_CheckoutTokenApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_ExtensionMetaApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_CheckoutSettingsApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_ShopApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_NoteApi extends Pick {} +/** @publicDocs */ export interface Docs_Checkout_NoteApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_PaymentOptionsApi extends Pick< StandardApi, 'availablePaymentOptions' | 'selectedPaymentOptions' > {} +/** @publicDocs */ export interface Docs_Standard_GiftCardsApi extends Pick {} +/** @publicDocs */ export interface Docs_Checkout_GiftCardsApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_DiscountsApi extends Pick {} +/** @publicDocs */ export interface Docs_Checkout_DiscountsApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_SessionTokenApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_SettingsApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_StorageApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_QueryApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_AnalyticsApi extends Pick {} +/** @publicDocs */ export interface Docs_Standard_CustomerPrivacyApi extends Pick {} - -export interface Docs_Standard_Ui extends Pick {} diff --git a/packages/ui-extensions/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts b/packages/ui-extensions/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts index 6829ee4b8e..4d86eb8b0d 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts @@ -1,27 +1,36 @@ import type {SubscribableSignalLike} from '../../shared'; +/** @publicDocs */ export interface OrderConfirmation { order: { /** - * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created. + * A globally unique identifier for the order. This becomes the + * [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) object ID in the + * GraphQL Admin API after the order is created. + * + * @example 'gid://shopify/Order/123' */ id: string; }; /** - * A randomly generated alpha-numeric identifier for the order. - * For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present. + * A randomly generated alpha-numeric identifier for the order, distinct + * from `order.id`. The value is `undefined` for orders that were created + * before this field was introduced. All recent orders have a number. + * + * Optional. Might not be present for orders created before 2024. */ number?: string; /** - * Whether this is the customer's first order. + * Whether this is the customer's first completed order with this shop. `true` means the buyer hasn't placed an order here before. Use this to show first-purchase messaging or trigger welcome offers. */ isFirstOrder: boolean; } +/** @publicDocs */ export interface OrderConfirmationApi { /** - * Order information that's available post-checkout. + * The order details available after the buyer completes checkout, including the order ID, order number, and whether it's the buyer's first purchase. */ orderConfirmation: SubscribableSignalLike; } diff --git a/packages/ui-extensions/src/surfaces/checkout/api/payment/payment-option-item.ts b/packages/ui-extensions/src/surfaces/checkout/api/payment/payment-option-item.ts index b53c7d69e2..f0d0d48460 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/payment/payment-option-item.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/payment/payment-option-item.ts @@ -1,9 +1,11 @@ import type {SubscribableSignalLike} from '../../shared'; +/** @publicDocs */ export type PaymentMethodAttributesResult = | PaymentMethodAttributesResultSuccess | PaymentMethodAttributesResultError; +/** @publicDocs */ export interface PaymentMethodAttributesResultSuccess { /** * Indicates that the payment method attributes were set successfully. @@ -11,6 +13,7 @@ export interface PaymentMethodAttributesResultSuccess { type: 'success'; } +/** @publicDocs */ export interface PaymentMethodAttributesResultError { /** * Indicates that the payment method attributes were not set successfully. @@ -27,14 +30,17 @@ export interface PaymentMethodAttributesResultError { /** * A key-value pair that represents an attribute of a payment method. + * @publicDocs */ export interface PaymentMethodAttribute { key: string; value: string | number | boolean; } +/** @publicDocs */ export type PaymentMethodAttributesChange = PaymentMethodAttributesUpdateChange; +/** @publicDocs */ export interface PaymentMethodAttributesUpdateChange { /** * The type of the `PaymentMethodAttributesChange` API. @@ -47,6 +53,7 @@ export interface PaymentMethodAttributesUpdateChange { attributes: PaymentMethodAttribute[]; } +/** @publicDocs */ export interface PaymentOptionItemApi { /** * Sets the attributes of the related payment method. diff --git a/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-location-item.ts b/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-location-item.ts index 366f1133d5..31a4a8f80c 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-location-item.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-location-item.ts @@ -1,14 +1,23 @@ import type {SubscribableSignalLike} from '../../shared'; import type {PickupLocationOption} from '../standard/standard'; +/** @publicDocs */ export interface PickupLocationItemApi { /** - * The pickup location the extension is attached to. + * The pickup location that this extension is attached to. Use this to read the location's name, address, and other details. + * + * Available only on the corresponding item target. Shipping option item + * targets expose shipping option properties; pickup location item targets + * expose pickup location properties. */ target: SubscribableSignalLike; /** - * Whether the pickup location is currently selected. + * Whether the buyer has selected the target pickup location. When `true`, the target location is the buyer's active choice. When `false`, the buyer has chosen a different pickup location. + * + * Available only on the corresponding item target. Shipping option item + * targets expose shipping option properties; pickup location item targets + * expose pickup location properties. */ isTargetSelected: SubscribableSignalLike; } diff --git a/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-location-list.ts b/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-location-list.ts index a01f572e6e..421fef63b3 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-location-list.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-location-list.ts @@ -1,8 +1,11 @@ import type {SubscribableSignalLike} from '../../shared'; +/** @publicDocs */ export interface PickupLocationListApi { /** - * Whether the customer location input form is shown to the buyer. + * Whether the location search form is currently visible to the buyer. + * Use this to conditionally render UI that depends on the buyer actively + * searching for pickup locations. */ isLocationFormVisible: SubscribableSignalLike; } diff --git a/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-point-list.ts b/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-point-list.ts index 7f8e33479c..ba33442f48 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-point-list.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/pickup/pickup-point-list.ts @@ -1,8 +1,11 @@ import type {SubscribableSignalLike} from '../../shared'; +/** @publicDocs */ export interface PickupPointListApi { /** - * Whether the customer location input form is shown to the buyer. + * Reflects which view was active when the extension loaded. When the + * buyer moves to the next view, the extension restarts with the + * current value rather than updating in place. */ isLocationFormVisible: SubscribableSignalLike; } diff --git a/packages/ui-extensions/src/surfaces/checkout/api/redeemable/redeemable.ts b/packages/ui-extensions/src/surfaces/checkout/api/redeemable/redeemable.ts index 7d4dd1869e..479ced1ae9 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/redeemable/redeemable.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/redeemable/redeemable.ts @@ -1,7 +1,9 @@ +/** @publicDocs */ export type RedeemableChangeResult = | RedeemableChangeResultSuccess | RedeemableChangeResultError; +/** @publicDocs */ export interface RedeemableChangeResultSuccess { /** * Indicates that the redeemable change was applied successfully. @@ -9,6 +11,7 @@ export interface RedeemableChangeResultSuccess { type: 'success'; } +/** @publicDocs */ export interface RedeemableChangeResultError { /** * Indicates that the redeemable change was not applied successfully. @@ -25,14 +28,17 @@ export interface RedeemableChangeResultError { /** * A key-value pair that represents an attribute of a redeemable payment method. + * @publicDocs */ export interface RedeemableAttribute { key: string; value: string; } +/** @publicDocs */ export type RedeemableChange = RedeemableAddChange; +/** @publicDocs */ export interface RedeemableAddChange { /** * The type of the `RedeemableChange` API. @@ -50,6 +56,7 @@ export interface RedeemableAddChange { identifier: string; } +/** @publicDocs */ export interface RedeemableApi { /** * Applies a redeemable change to add a redeemable payment method. diff --git a/packages/ui-extensions/src/surfaces/checkout/api/shared.ts b/packages/ui-extensions/src/surfaces/checkout/api/shared.ts index 142b438238..1ccbdcaa78 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/shared.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/shared.ts @@ -1,14 +1,19 @@ import type {CountryCode} from '../../../shared'; +/** @publicDocs */ export interface ValidationError { /** - * Error message to be displayed to the buyer. + * The error message to display to the buyer. Use this to explain what + * went wrong and how to fix it. */ message: string; /** - * The checkout UI field that the error is associated with. + * The checkout UI field that the error is associated with. When provided, + * checkout highlights the matching field so the buyer knows where to fix + * the issue. The value is `undefined` if the error isn't tied to a + * specific field. * - * Example: `$.cart.deliveryGroups[0].deliveryAddress.countryCode` + * @example '$.cart.deliveryGroups[0].deliveryAddress.countryCode' * * See the [supported targets](https://shopify.dev/docs/api/functions/reference/cart-checkout-validation/graphql#supported-targets) * for more information. @@ -16,135 +21,181 @@ export interface ValidationError { target?: string; } +/** + * A [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) represents a recurring or deferred purchasing option for a product, such as a subscription, pre-order, or try-before-you-buy plan. The merchant configures selling plans to define how and when the buyer is charged. + * @publicDocs + */ export interface SellingPlan { /** - * A globally-unique identifier. + * A globally-unique identifier for the selling plan in the format + * `gid://shopify/SellingPlan/`. Use this to reference the specific + * selling plan associated with a line item. + * * @example 'gid://shopify/SellingPlan/1' */ id: string; /** - * Whether purchasing the selling plan will result in multiple deliveries. + * Whether purchasing through this selling plan results in multiple + * deliveries. `true` for subscription plans with recurring fulfillment, + * `false` for one-time pre-orders or try-before-you-buy plans. */ recurringDeliveries: boolean; } +/** @publicDocs */ export interface Attribute { /** - * The key for the attribute. + * The identifier for the attribute. Each key must be unique within the + * set of attributes on the cart or checkout. If you call + * `applyAttributeChange()` with a key that already exists, then the + * existing value is replaced. + * + * @example 'gift_wrapping' */ key: string; /** - * The value for the attribute. + * The value associated with the attribute key. This is a freeform string + * that can store any information the buyer or app provides. + * + * Attribute values are always strings. To store structured data, serialize + * it to JSON and parse it when reading. + * + * @example 'Please use red wrapping paper' */ value: string; } +/** @publicDocs */ export interface MailingAddress { /** - * The buyer's full name. + * The buyer's full name, typically a combination of first and last name. + * The value is `undefined` if the buyer didn't provide a name. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'John Doe' */ name?: string; /** - * The buyer's first name. + * The buyer's first name. Use this alongside `lastName` when you need to + * display or process name parts separately. The value is `undefined` if + * the buyer didn't provide a first name or the store doesn't collect + * split names. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'John' */ firstName?: string; /** - * The buyer's last name. + * The buyer's last name. Use this alongside `firstName` when you need to + * display or process name parts separately. The value is `undefined` if + * the buyer didn't provide a last name or the store doesn't collect + * split names. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'Doe' */ lastName?: string; /** - * The buyer's company name. + * The buyer's company name. The value is `undefined` if the buyer didn't + * enter a company or the store doesn't collect company names. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'Shopify' */ company?: string; /** - * The first line of the buyer's address, including street name and number. + * The first line of the street address, including the street number and + * name. The value is `undefined` if the buyer hasn't entered an address yet. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example '151 O'Connor Street' */ address1?: string; /** - * The second line of the buyer's address, like apartment number, suite, etc. + * The second line of the buyer's address, such as apartment number, suite, + * or unit. The value is `undefined` if the buyer didn't provide a second + * address line. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'Ground floor' */ address2?: string; /** - * The buyer's city. + * The city, town, or village of the address. The value is `undefined` if + * the buyer hasn't entered a city yet. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'Ottawa' */ city?: string; /** - * The buyer's postal or ZIP code. + * The postal code or ZIP code of the address, used for mail sorting and + * delivery routing. The value is `undefined` if the buyer hasn't entered + * one yet or the country doesn't use postal codes. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'K2P 2L8' */ zip?: string; /** - * The ISO 3166 Alpha-2 format for the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html. + * The two-letter country code in [ISO 3166 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + * format. The value is `undefined` if the buyer hasn't selected a country + * yet. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'CA' for Canada. */ countryCode?: CountryCode; /** - * The buyer's province code, such as state, province, prefecture, or region. + * The province, state, prefecture, or region code of the address. The + * format varies by country. The value is `undefined` if the buyer hasn't + * selected one yet or the country doesn't have provinces. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'ON' for Ontario. */ provinceCode?: string; /** - * The buyer's phone number. + * The phone number associated with the address, typically in international + * format. The value is `undefined` if the buyer didn't provide a phone + * number or the store doesn't collect phone numbers. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * - * @example '+1 613 111 2222'. + * @example '+1 613 111 2222' */ phone?: string; } +/** @publicDocs */ export interface ShippingAddress extends MailingAddress { /** - * Specifies whether the address should be saved to the buyer's account. + * Controls whether the address is saved to the buyer's account. When + * `true`, the address won't be saved and is only used for this checkout. + * When `false` or `undefined`, the address might be saved to the buyer's + * account for future use. */ oneTimeUse?: boolean; } diff --git a/packages/ui-extensions/src/surfaces/checkout/api/shipping/shipping-option-item.ts b/packages/ui-extensions/src/surfaces/checkout/api/shipping/shipping-option-item.ts index 538d57943c..b29bee7754 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/shipping/shipping-option-item.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/shipping/shipping-option-item.ts @@ -1,29 +1,44 @@ import type {SubscribableSignalLike} from '../../shared'; import type {ShippingOption} from '../standard/standard'; +/** @publicDocs */ export interface ShippingOptionItemApi { /** - * The shipping option the extension is attached to. + * The shipping option that this extension is attached to. Use this to read the option's cost, carrier, delivery estimate, and other details. + * + * Available only on the corresponding item target. Shipping option item + * targets expose shipping option properties; pickup location item targets + * expose pickup location properties. */ target: SubscribableSignalLike; /** - * Whether the shipping option the extension is attached to is currently selected in the UI. + * Whether the buyer has selected the target shipping option. When `true`, the target option is the buyer's active choice. When `false`, the buyer has chosen a different shipping option. + * + * Available only on the corresponding item target. Shipping option item + * targets expose shipping option properties; pickup location item targets + * expose pickup location properties. */ isTargetSelected: SubscribableSignalLike; /** - * The render mode of the shipping option. + * The render mode of this shipping option, indicating how the extension is displayed in the checkout UI. + * + * @deprecated Do not rely on render context. This target can render inside an overlay, so use inline UI instead of opening overlays such as modals. */ renderMode: ShippingOptionItemRenderMode; } /** * The render mode of a shipping option. + * + * @publicDocs */ export interface ShippingOptionItemRenderMode { /** - * Whether the shipping option is rendered in an overlay. + * Whether the shipping option is rendered in an overlay. When `true`, the extension appears in a modal or sheet on top of the checkout page. When `false`, the extension renders inline within the shipping options list. + * + * @deprecated Do not rely on render context. Use inline UI instead of opening overlays such as modals. */ overlay: boolean; } diff --git a/packages/ui-extensions/src/surfaces/checkout/api/shipping/shipping-option-list.ts b/packages/ui-extensions/src/surfaces/checkout/api/shipping/shipping-option-list.ts index 33e8a23027..cf6651ebb8 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/shipping/shipping-option-list.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/shipping/shipping-option-list.ts @@ -6,13 +6,14 @@ import type { Money, } from '../standard/standard'; +/** @publicDocs */ export interface ShippingOptionListApi { /** - * The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type. + * The delivery group list that this extension is attached to. Use this to access all delivery groups and their options. The value is `undefined` when there aren't any delivery groups for the given type. */ target: SubscribableSignalLike; /** - * The list of selection groups available to the buyers. The property will be undefined when no such groups are available. + * The list of delivery selection groups available to the buyer, which let buyers choose between grouped delivery options. The value is `undefined` when no selection groups are available. */ deliverySelectionGroups: SubscribableSignalLike< DeliverySelectionGroup[] | undefined @@ -20,45 +21,50 @@ export interface ShippingOptionListApi { } /** - * The delivery group list the extension is associated to. + * A collection of delivery groups that share the same group type. + * @publicDocs */ export interface DeliveryGroupList { /** - * The group type of the delivery group list. + * The type of delivery groups in this list. This is the same `DeliveryGroupType` used on `DeliveryGroup.groupType`. + * + * - `'oneTimePurchase'`: Items bought as a single, non-recurring purchase. + * - `'subscription'`: Items bought through a [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries. */ groupType: DeliveryGroupType; /** - * The delivery groups that compose this list. + * The delivery groups in this list. Each group contains cart lines and available delivery options for those items. */ deliveryGroups: DeliveryGroup[]; } /** - * A selection group for delivery options. + * A named group of delivery options that the buyer can select as a unit. + * @publicDocs */ export interface DeliverySelectionGroup { /** - * The handle of the selection group. + * A unique identifier for this selection group. */ handle: string; /** - * If the selection group is selected. + * Whether the buyer has selected this delivery selection group. When `true`, the associated delivery options are active. When `false`, the buyer has selected a different group. */ selected: boolean; /** - * The localized title of the selection group. + * The localized display title of this selection group, suitable for rendering in the checkout UI. */ title: string; /** - * The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles. + * The delivery options that belong to this selection group. Each reference's `handle` matches a delivery option handle in the associated delivery group. */ associatedDeliveryOptions: DeliveryOptionReference[]; /** - * The sum of each delivery option's cost. + * The combined cost of all delivery options in this group before discounts. */ cost: Money; /** - * The sum of each delivery option's cost after discounts. + * The combined cost of all delivery options in this group after discounts have been applied. This is what the buyer actually pays. */ costAfterDiscounts: Money; } diff --git a/packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts b/packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts index 8409bb6113..bf4875aefd 100644 --- a/packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts +++ b/packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts @@ -22,23 +22,21 @@ import type {SubscribableSignalLike} from '../../shared'; export type {ApiVersion, Capability} from '../../../../shared'; /** - * A key-value storage object for the extension. - * - * Stored data is only available to this specific extension - * and any of its instances. - * - * The storage backend is implemented with `localStorage` and - * should persist across the buyer's checkout session. - * However, data persistence isn't guaranteed. + * Key-value storage for a specific extension. Use storage to save + * preferences or cached data that should survive page reloads without + * requiring a backend call. Stored data is only available to this + * specific extension. The storage backend is implemented with + * `localStorage` and data persistence isn't guaranteed. */ export interface Storage { /** * Read and return a stored value by key. * * The stored data is deserialized from JSON and returned as - * its original primitive. + * its original type. * - * Returns `null` if no stored data exists. + * Returns the stored value for the given key, or `null` when no value + * exists. Doesn't throw on a missing key. */ read(key: string): Promise; @@ -50,13 +48,15 @@ export interface Storage { write(key: string, data: any): Promise; /** - * Delete stored data by key. + * Deletes a previously stored value by key. */ delete(key: string): Promise; } /** - * The meta information about an extension target. + * Metadata about the running extension, including its API version, target, + * capabilities, and editor context. Use this to read configuration details or + * conditionally render content based on where the extension is running. */ export interface Extension { /** @@ -67,27 +67,15 @@ export interface Extension { apiVersion: ApiVersion; /** - * The allowed capabilities of the extension, defined - * in your [shopify.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file. - * - * * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API. - * - * * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls. - * - * * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior. - * - * * [`collect_buyer_consent.sms_marketing`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing. - * - * * [`collect_buyer_consent.customer_privacy`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services. - * - * * [`iframe.sources`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe. + * The allowed capabilities of the extension, defined in your + * [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file. */ capabilities: SubscribableSignalLike; /** * Information about the editor where the extension is being rendered. * - * If the value is undefined, then the extension is not running in an editor. + * If the value is undefined, then the extension isn't running in an editor. */ editor?: Editor; @@ -95,7 +83,7 @@ export interface Extension { * A Boolean to show whether your extension is currently rendered to the screen. * * Shopify might render your extension before it's visible in the UI, - * typically to pre-render extensions that will appear on a later step of the + * typically to pre-render extensions that appear on a later step of the * checkout. * * Your extension might also continue to run after the customer has navigated away @@ -110,12 +98,12 @@ export interface Extension { scriptUrl: string; /** - * The identifier that specifies where in Shopify’s UI your code is being - * injected. This will be one of the targets you have included in your - * extension’s configuration file. + * The identifier that specifies where in Shopify's UI your code is being + * injected. This is one of the targets you've included in your + * extension's configuration file. * * @example 'purchase.checkout.block.render' - * @see https://shopify.dev/docs/api/checkout-ui-extensions/latest/extension-targets-overview + * @see https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets */ target: Target; @@ -125,93 +113,147 @@ export interface Extension { * * For unpublished extensions, the value is `undefined`. * + * Don't use this property as a stable identifier in development environments. + * It becomes available only after the extension is published. + * * @example 3.0.10 */ version?: string; } +/** + * Information about the editor environment when an extension is rendered + * inside the checkout editor. The value is `undefined` when the extension + * is not rendering in an editor. + */ export interface Editor { /** - * Indicates whether the extension is rendering in the checkout editor. + * Indicates whether the extension is rendering in the [checkout editor](https://shopify.dev/docs/apps/checkout). Always `'checkout'`. */ type: 'checkout'; } /** - * Metadata associated with the checkout. + * Metadata associated with the checkout. See the [metafields documentation](https://shopify.dev/docs/apps/build/custom-data/metafields) for more information on how metafields work. + * @publicDocs */ export interface Metafield { /** - * The name of the metafield. It must be between 3 and 30 characters in - * length (inclusive). + * The name of the metafield. + * + * @example 'delivery_instructions' */ key: string; /** * A container for a set of metafields. You need to define a custom * namespace for your metafields to distinguish them from the metafields - * used by other apps. This must be between 2 and 20 characters in length (inclusive). + * used by other apps. + * + * @example 'my_app' */ namespace: string; /** - * The information to be stored as metadata. Always stored as a string, regardless of the metafield's type. + * The information to be stored as metadata. */ value: string | number; - /** The metafield’s information type. */ + /** + * The metafield's information type. + * + * - `'integer'`: A whole number value. + * - `'string'`: A plain text value. + * - `'json_string'`: A JSON-encoded string value. + */ valueType: 'integer' | 'string' | 'json_string'; } /** - * Represents a custom metadata attached to a resource. + * Represents a custom [metafield](https://shopify.dev/docs/apps/build/custom-data/metafields) attached to a resource such as a product, variant, customer, or shop. + * @publicDocs */ export interface AppMetafield { - /** The key name of a metafield. */ + /** + * The identifier for the metafield within its namespace, such as `'ingredients'` or `'shipping_weight'`. + */ key: string; /** - * The namespace for a metafield. + * The namespace that the metafield belongs to. Namespaces group related metafields and prevent naming collisions between different apps. * - * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information. + * App owned metafield namespaces are returned using the `$app` format. See [app owned metafields](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information. */ namespace: string; - /** The value of a metafield. */ + /** + * The value of a metafield, stored as a string regardless of the underlying type. For JSON metafields, parse the string to access structured data. + */ value: string; - /** The metafield’s information type. */ + /** + * The metafield's information type. + * + * - `'boolean'`: A true or false value. + * - `'float'`: A decimal number value. + * - `'integer'`: A whole number value. + * - `'json_string'`: A JSON-encoded string value. + * - `'string'`: A plain text value. + */ valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string'; - /** The metafield's type name. */ + /** + * The metafield's [type name](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`. This is the full type identifier, whereas `valueType` is a simplified category. + */ type: string; } /** - * Represents a custom metadata attached to a resource. + * Represents a custom metadata attached to the cart. Unlike `AppMetafield`, cart metafield values are always strings and don't include a `valueType` discriminator. + * + * Cart [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields) are set by extensions using `applyMetafieldChange()` and can be copied to order metafields at order creation time. + * @publicDocs */ export interface CartMetafield { - /** The key name of a metafield. */ + /** + * The key name of a metafield, such as `'delivery_instructions'` or `'gift_message'`. Together with `namespace`, this uniquely identifies the metafield on the cart. + */ key: string; - /** The namespace for a metafield. */ + /** + * The namespace for a metafield, such as `'custom'` or `'my_app'`. Together with `key`, this uniquely identifies the metafield on the cart. + */ namespace: string; - /** The value of a metafield. */ + /** + * The string value stored in the cart metafield. Unlike `AppMetafield`, cart metafield values are always strings. + */ value: string; - /** The metafield's type name. */ + /** + * The metafield's [type name](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-data-types), such as `'single_line_text_field'` or `'json'`. + */ type: string; } /** - * The metafield owner. + * The Shopify resource that a metafield is attached to. Each entry identifies a specific resource by its type and globally-unique ID, so you can trace where the data comes from. + * @publicDocs */ export interface AppMetafieldEntryTarget { /** - * The type of the metafield owner. + * The kind of Shopify resource this metafield belongs to: * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`. + * - `'customer'`: The customer who placed the order. + * - `'product'`: A product in the merchant's catalog. + * - `'shop'`: The merchant's shop. + * - `'shopUser'`: A staff member or collaborator account on the shop. + * - `'variant'`: A specific variant of a product. + * - `'company'`: A [B2B](https://shopify.dev/docs/apps/build/b2b) company associated with the order. + * - `'companyLocation'`: A location belonging to a [B2B](https://shopify.dev/docs/apps/build/b2b) company. + * - `'cart'`: The cart associated with the checkout. + * + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`. */ type: | 'customer' @@ -223,32 +265,41 @@ export interface AppMetafieldEntryTarget { | 'companyLocation' | 'cart'; - /** The numeric owner ID that is associated with the metafield. */ + /** + * The globally-unique identifier of the Shopify resource, in [GID](https://shopify.dev/docs/api/usage/gids) format. Use this value to match the metafield to a specific resource in your extension or when querying the [Storefront API](https://shopify.dev/docs/api/storefront). + * + * @example 'gid://shopify/Product/123' + */ id: string; } /** - * A metafield associated with the shop or a resource on the checkout. + * An entry that pairs a Shopify resource with one of its [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields). Each entry contains a `target` identifying which resource the metafield belongs to and a `metafield` object with the actual data. + * @publicDocs */ export interface AppMetafieldEntry { /** - * The target that is associated to the metadata. + * The Shopify resource that this metafield is attached to, including the resource type (such as `'product'` or `'customer'`) and its globally-unique ID. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`. + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data) when the type is `customer`, `company` or `companyLocation`. */ target: AppMetafieldEntryTarget; - /** The metadata information. */ + /** + * The metafield data, including the namespace, key, value, and content type. Use the `namespace` and `key` together to uniquely identify the metafield within its resource. + */ metafield: AppMetafield; } +/** @publicDocs */ export type Version = string; +/** @publicDocs */ export type CheckoutToken = string; /** - * This returns a translated string matching a key in a locale file. - * - * @example translate("banner.title") + * Translates a key from your extension's locale files into a localized string. + * Supports interpolation with placeholder replacements and pluralization + * via the special `count` option. */ export interface I18nTranslate { ( @@ -259,6 +310,11 @@ export interface I18nTranslate { : (string | ReplacementType)[]; } +/** + * Utilities for translating strings, formatting currencies, numbers, + * and dates according to the buyer's locale. Use the I18n API alongside + * the Localization API to build fully localized extensions. + */ export interface I18n { /** * Returns a localized number. @@ -266,7 +322,7 @@ export interface I18n { * This function behaves like the standard `Intl.NumberFormat()` * with a style of `decimal` applied. It uses the buyer's locale by default. * - * @param options.inExtensionLocale - if true, use the extension's locale + * @param options.inExtensionLocale - If true, uses the extension's locale. */ formatNumber: ( number: number | bigint, @@ -279,7 +335,7 @@ export interface I18n { * This function behaves like the standard `Intl.NumberFormat()` * with a style of `currency` applied. It uses the buyer's locale by default. * - * @param options.inExtensionLocale - if true, use the extension's locale + * @param options.inExtensionLocale - If true, uses the extension's locale. */ formatCurrency: ( number: number | bigint, @@ -289,14 +345,11 @@ export interface I18n { /** * Returns a localized date value. * - * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses - * the buyer's locale by default. Formatting options can be passed in as + * This function behaves like the standard [`Intl.DateTimeFormat()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) and uses + * the buyer's locale by default. Formatting [options](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options) can be passed in as * options. * - * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0 - * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options - * - * @param options.inExtensionLocale - if true, use the extension's locale + * @param options.inExtensionLocale - If true, uses the extension's locale. */ formatDate: ( date: Date, @@ -315,127 +368,140 @@ export interface I18n { translate: I18nTranslate; } +/** @publicDocs */ export interface Language { /** - * The BCP-47 language tag. It may contain a dash followed by an ISO 3166-1 alpha-2 region code. - * - * @example 'en' for English, or 'en-US' for English local to United States. - * @see https://en.wikipedia.org/wiki/IETF_language_tag - * @see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 + * The [BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language tag that identifies the language. This is a standardized code that might include a base language and an optional region subtag separated by a dash. For example, `'en'` represents English and `'en-US'` represents English as used in the United States. The region subtag follows the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) standard. */ isoCode: string; } +/** @publicDocs */ export interface Currency { /** - * The ISO-4217 code for this currency. - * @see https://www.iso.org/iso-4217-currency-codes.html + * The three-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format, such as `'USD'`, `'EUR'`, or `'CAD'`. */ isoCode: CurrencyCode; } +/** + * A [Shopify Market](https://shopify.dev/docs/apps/build/markets) that represents a group of one or more regions for international selling. + * @publicDocs + */ export interface Market { /** - * A globally-unique identifier for a market. + * A globally-unique identifier for the market in the format `gid://shopify/Market/`. */ id: string; /** - * The human-readable, shop-scoped identifier for the market. + * The human-readable, shop-scoped identifier for the market, such as `'us'` or `'eu'`. Merchants define these handles when configuring [Shopify Markets](https://shopify.dev/docs/apps/build/markets). */ handle: string; } +/** + * The buyer's language, country, currency, and timezone context. Use this + * to adapt your extension to the buyer's region and display localized content. + */ export interface Localization { /** - * The currency that the customer sees for money amounts in the checkout. + * The currency that the buyer sees for money amounts in the checkout. Use this value to format prices and totals in the buyer's expected currency. */ currency: SubscribableSignalLike; /** - * The buyer’s time zone. + * The buyer's time zone, based on their browser or account settings. Use this value to format dates and times relative to the buyer's local time. */ timezone: SubscribableSignalLike; /** - * The language the customer sees in the checkout. + * The language the buyer sees in the checkout. This reflects the language selected by the buyer or determined by their browser settings, and might differ from the languages your extension supports. */ language: SubscribableSignalLike; /** - * This is the customer's language, as supported by the extension. - * If the customer's actual language is not supported by the extension, - * then this is the language that is used for translations. - * - * For example, if the customer's language is 'fr-CA' but your extension - * only supports translations for 'fr', then the `isoCode` for this - * language is 'fr'. If your extension does not provide french - * translations at all, then this value is the default locale for your - * extension (that is, the one matching your .default.json file). + * The best available language match for your extension based on the buyer's language. If the buyer's language is `'fr-CA'` but your extension supports only `'fr'`, this returns `'fr'`. If your extension doesn't support any variant of the buyer's language, this falls back to your extension's default locale (the `.default.json` translation file). Use this value to load the correct translation file for your extension. */ extensionLanguage: SubscribableSignalLike; /** - * The country context of the checkout. This value carries over from the - * context of the cart, where it was used to contextualize the storefront - * experience. It will update if the buyer changes the country of their - * shipping address. If the country is unknown, then the value is undefined. + * The country context of the checkout, carried over from the cart. It updates when the buyer changes their shipping address country. Use this value to display region-specific content such as local support information or regional policies. The value is `undefined` if the buyer's country is unknown. + * + * Derived from the buyer's shipping address. Returns `undefined` until the + * buyer enters a shipping address. */ country: SubscribableSignalLike; /** - * The [market](https://shopify.dev/docs/apps/markets) context of the - * checkout. This value carries over from the context of the cart, where it - * was used to contextualize the storefront experience. It will update if the - * buyer changes the country of their shipping address. If the market is unknown, - * then the value is undefined. + * The [market](/docs/apps/build/markets) context of the checkout, + * carried over from the cart context. Markets group countries and + * regions with shared pricing, languages, and domains. The market + * context updates when the buyer changes the country of their + * shipping address. The value is `undefined` if the market is unknown. * - * > Caution: This field is deprecated and will be removed in a future version. - * - * @deprecated Deprecated as of version `2025-04` + * @deprecated Merchants now manage which extensions load for each + * market, so extensions no longer need to check this value. */ market: SubscribableSignalLike; } +/** @publicDocs */ export interface LocalizedField { + /** + * The identifier for the localized field, indicating the type of information + * collected (for example, a tax credential or shipping credential for a + * specific country). + */ key: LocalizedFieldKey; + + /** + * The localized display label for the field, suitable for rendering in the UI. + * + * @example 'CPF/CNPJ' for a Brazilian tax credential + */ title: string; + + /** + * The current value entered by the buyer for this field. + */ value: string; } /** * Provides details on the buyer's progression through the checkout. + * @publicDocs */ export interface BuyerJourney { /** * Installs a function for intercepting and preventing progress on checkout. * * This returns a promise that resolves to a teardown function. Calling the - * teardown function will remove the interceptor. + * teardown function removes the interceptor. * - * To block checkout progress, you must set the [block_progress](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress) + * To block checkout progress, you must set the [block_progress](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#block-progress) * capability in your extension's configuration. * * If you do, then you're expected to inform the buyer why navigation was blocked, * either by passing validation errors to the checkout UI or rendering the errors in your extension. - * * - * It is good practice to show a warning in the checkout editor when the merchant has not given permission for your extension - * to block checkout progress. + * + * If the merchant hasn't allowed your extension to block checkout progress, show a warning in the [checkout editor](https://shopify.dev/docs/apps/build/checkout/test-checkout-ui-extensions#test-the-extension-in-the-checkout-editor). + * + * @deprecated Use a cart and checkout validation function instead. The buyer + * journey intercept will be removed in a future version of the API. */ intercept(interceptor: Interceptor): Promise<() => void>; /** - * This subscribable value will be true if the buyer completed submitting their order. - * - * For example, when viewing the **Order status** page after submitting payment, the buyer will have completed their order. + * Whether the buyer has completed submitting their order. When `true`, the buyer is on the order status page after submitting payment. When `false`, the buyer is still in the checkout flow. */ completed: SubscribableSignalLike; /** - * All possible steps a buyer can take to complete the checkout. These steps may vary depending on the type of checkout or the shop's configuration. + * All possible steps the buyer can take to complete checkout. These steps vary depending on whether the checkout is one-page or three-page, and on the shop's configuration. */ steps: SubscribableSignalLike; /** - * What step of checkout the buyer is currently on. + * The step of checkout the buyer is currently on. The value is `undefined` if the current step can't be determined. */ activeStep: SubscribableSignalLike; } @@ -467,92 +533,107 @@ type BuyerJourneyStepHandle = */ interface BuyerJourneyStepReference { /** - * The handle that uniquely identifies the buyer journey step. + * The handle identifying which step the buyer is on, such as `'information'`, + * `'shipping'`, or `'payment'`. See `BuyerJourneyStepHandle` for all values. */ handle: BuyerJourneyStepHandle; } +/** @publicDocs */ export interface BuyerJourneyStep { /** - * The handle that uniquely identifies the buyer journey step. + * The handle that uniquely identifies the buyer journey step, such as `'information'`, `'shipping'`, or `'payment'`. */ handle: BuyerJourneyStepHandle; /** - * The localized label of the buyer journey step. + * The localized label of the buyer journey step, suitable for rendering in navigation UI. */ label: string; /** - * The url of the buyer journey step. This property leverages the `shopify:` protocol - * E.g. `shopify:cart` or `shopify:checkout/information`. + * The URL of the buyer journey step, using the `shopify:` protocol. + * + * @example 'shopify:cart' + * @example 'shopify:checkout/information' */ to: string; /** - * The disabled state of the buyer journey step. This value will be true if the buyer has not reached the step yet. + * Whether this step is disabled. When `true`, the buyer hasn't reached this step yet and can't navigate to it. When `false`, the step is accessible. * - * For example, if the buyer has not reached the `shipping` step yet, `shipping` would be disabled. + * For example, if the buyer hasn't reached the `shipping` step yet, then `shipping` is disabled. */ disabled: boolean; } +/** @publicDocs */ export interface StandardApi { /** - * The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event. + * Tracks custom events and sends visitor information to + * [Web Pixels](https://shopify.dev/docs/apps/marketing). Use `publish()` to emit events + * and `visitor()` to submit buyer contact details. */ analytics: Analytics; /** - * Gift Cards that have been applied to the checkout. + * The gift cards that have been applied to the checkout. Each entry includes + * the last four characters of the gift card code, the amount used at + * checkout, and the card's remaining balance. */ appliedGiftCards: SubscribableSignalLike; /** * The cart instructions used to create the checkout and possibly limit extension capabilities. * - * These instructions should be checked prior to performing any actions that may be affected by them. + * These instructions should be checked before performing any actions that might be affected by them. * * For example, if you intend to add a discount code via the `applyDiscountCodeChange` method, * check `discounts.canUpdateDiscountCodes` to ensure it's supported in this checkout. * - * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. - * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information. + * > Caution: Check cart instructions before calling select APIs, as + * > some may not be available. See the + * > [Cart Instructions API](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/cart-instructions#examples) + * > for more information. * */ instructions: SubscribableSignalLike; /** * The metafields requested in the - * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) + * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) * file. These metafields are updated when there's a change in the merchandise items * being purchased by the customer. * - * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` is not supported. See [app owned metafields](/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information. + * App owned metafields are supported and are returned using the `$app` format. The fully qualified reserved namespace format such as `app--{your-app-id}[--{optional-namespace}]` isn't supported. See [app owned metafields](https://shopify.dev/docs/apps/build/custom-data/ownership#reserved-prefixes) for more information. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ appMetafields: SubscribableSignalLike; /** - * The custom attributes left by the customer to the merchant, either in their cart or during checkout. + * The custom key-value attributes attached to the cart or checkout. These are set by the buyer or by an extension using `applyAttributeChange()`. The list is empty if no attributes have been added. */ attributes: SubscribableSignalLike; /** - * All available payment options. + * All payment options available to the buyer for this checkout, such as + * credit cards, wallets, and local payment methods. The list depends on + * the shop's payment configuration and the buyer's region. + * + * The set of payment options can change when the buyer updates their + * address or cart, so subscribe to changes rather than reading once + * during initialization. Each option exposes `handle` and `type` only. + * Provider names, logos, fees, and installment terms aren't available. */ availablePaymentOptions: SubscribableSignalLike; /** - * Information about the buyer that is interacting with the checkout. + * Information about the buyer that's interacting with the checkout. The property is available only if the extension has access to protected customer data. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ buyerIdentity?: BuyerIdentity; /** - * Provides details on the buyer's progression through the checkout. - * - * Refer to [buyer journey](https://shopify.dev/docs/api/checkout-ui-extensions/apis/buyer-journey#examples) - * examples for more information. + * Provides details on the buyer's progression through the checkout and lets you intercept navigation to validate data before the buyer continues. */ buyerJourney: BuyerJourney; @@ -564,97 +645,91 @@ export interface StandardApi { /** * A stable ID that represents the current checkout. * + * The value is `undefined` when the checkout hasn't been created on the server yet. + * + * Use this to correlate checkout sessions across your extension, web pixels, and backend systems. + * * This matches the `data.checkout.token` field in a [checkout-related WebPixel event](https://shopify.dev/docs/api/web-pixels-api/standard-events/checkout_started#properties-propertydetail-data) * and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object). + * + * Can be `undefined`. Handle the `undefined` state before using the value. */ checkoutToken: SubscribableSignalLike; /** - * Details on the costs the buyer will pay for this checkout. + * The cost breakdown for the current checkout, including subtotal, shipping, tax, and total amounts. These values update as the buyer progresses through checkout and costs like shipping and tax are calculated. */ cost: CartCost; /** - * A list of delivery groups containing information about the delivery of the items the customer intends to purchase. + * The delivery groups for this checkout. Each group contains one or more cart lines and the available delivery options (shipping, pickup point, or pickup location) for those items. + * + * Empty until the buyer enters enough address information for Shopify to + * calculate shipping rates. */ deliveryGroups: SubscribableSignalLike; /** - * A list of discount codes currently applied to the checkout. + * The discount codes currently applied to the checkout. The list is empty if no discount codes have been applied. Use `applyDiscountCodeChange()` to add or remove codes. */ discountCodes: SubscribableSignalLike; /** - * Discounts that have been applied to the entire cart. + * The discount allocations applied to the entire cart, including automatic discounts, code-based discounts, and custom discounts from [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Each allocation indicates how much was discounted and how the discount was triggered. */ discountAllocations: SubscribableSignalLike; /** - * The meta information about the extension. + * Metadata about the running extension, including the current target, API version, + * capabilities, and editor context. Use this to conditionally render content + * based on where the extension is running. */ extension: Extension; /** - * The identifier that specifies where in Shopify’s UI your code is being - * injected. This will be one of the targets you have included in your - * extension’s configuration file. + * The identifier that specifies where in Shopify's UI your code is being + * injected. This is one of the targets you've included in your + * extension's configuration file. * * @example 'purchase.checkout.block.render' - * @see https://shopify.dev/docs/api/checkout-ui-extensions/latest/extension-targets-overview + * @see https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/extension-targets-overview * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets * - * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead. + * @deprecated Use `extension.target` instead. */ extensionPoint: Target; /** - * Utilities for translating content and formatting values according to the current - * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization) - * of the checkout. - * - * Refer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#examples) - * for more information. + * Utilities for translating strings, formatting currencies, numbers, and dates + * according to the buyer's locale. Use alongside + * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization) + * to build fully localized extensions. */ i18n: I18n; /** - * A list of lines containing information about the items the customer intends to purchase. + * The list of line items the buyer intends to purchase. Each entry includes the merchandise, quantity, cost, and any custom attributes. Use `applyCartLinesChange()` to add, remove, or update line items. */ lines: SubscribableSignalLike; /** - * The details about the location, language, and currency of the customer. For utilities to easily - * format and translate content based on these details, you can use the - * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n) + * The buyer's language, country, currency, and timezone context. For + * formatting and translation helpers, use the + * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/localization#properties-propertydetail-i18n) * object instead. */ localization: Localization; - /** - * The metafields that apply to the current checkout. - * - * Metafields are stored locally on the client and are applied to the order object after the checkout completes. - * - * These metafields are shared by all extensions running on checkout, and - * persist for as long as the customer is working on this checkout. - * - * Once the order is created, you can query these metafields using the - * [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01) - * - * > Tip: - * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later. - */ - metafields: SubscribableSignalLike; - /** * A note left by the customer to the merchant, either in their cart or during checkout. + * + * The value is `undefined` if the buyer hasn't entered a note. Use this to display or react to order-level instructions such as delivery preferences or gift messages. */ note: SubscribableSignalLike; /** * The method used to query the Storefront GraphQL API with a prefetched token. * - * Refer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/storefront-api) for more information. */ query: >( query: string, @@ -662,70 +737,74 @@ export interface StandardApi { ) => Promise<{data?: Data; errors?: GraphQLError[]}>; /** - * Payment options selected by the buyer. + * The payment options the buyer has currently selected. This updates as + * the buyer changes their payment method. The array can contain multiple + * entries when the buyer splits payment across methods (for example, a + * gift card and a credit card). + * + * Each option exposes `handle` and `type` only. Provider names, logos, + * fees, and installment terms aren't available. */ selectedPaymentOptions: SubscribableSignalLike; /** * The session token providing a set of claims as a signed JSON Web Token (JWT). * - * The token has a TTL of 5 minutes. + * The token has a TTL of five minutes. * - * If the previous token expires, this value will reflect a new session token with a new signature and expiry. + * If the previous token expires, this value reflects a new session token with a new signature and expiry. * - * Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/session-token) for more information. + * Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens). */ sessionToken: SessionToken; /** * The settings matching the settings definition written in the - * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file. + * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file. * - * Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/settings#examples) for more information. + * Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/settings#examples) for more information. * - * > Note: When an extension is being installed in the editor, the settings will be empty until - * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings. + * > Note: When an extension is being installed in the editor, the settings are empty until + * a merchant sets a value. In that case, this object updates in real time as a merchant fills in the settings. */ settings: SubscribableSignalLike; /** * The proposed customer shipping address. During the information step, the address * updates when the field is committed (on change) rather than every keystroke. - * An address value is only present if delivery is required. Otherwise, the - * subscribable value is undefined. + * The property is available only if the extension has access to protected customer + * data. When available, the subscribable value is `undefined` if delivery isn't required. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ shippingAddress?: SubscribableSignalLike; /** * The proposed customer billing address. The address updates when the field is - * committed (on change) rather than every keystroke. + * committed (on change) rather than every keystroke. The property is available only + * if the extension has access to protected customer data. The subscribable value is + * `undefined` if the billing address hasn't been provided yet. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ billingAddress?: SubscribableSignalLike; - /** The shop where the checkout is taking place. */ + /** + * The store where the checkout is taking place, including the shop name, + * storefront URL, `.myshopify.com` subdomain, and a globally-unique ID. + */ shop: Shop; /** - * The key-value storage for the extension. - * - * It uses `localStorage` and should persist across the customer's current checkout session. - * - * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout. + * Key-value storage that persists across page loads within the current checkout + * session. Data is shared across all activated targets associated with + * this extension. * - * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, - * each activated extension target had its own storage. + * > Caution: Data persistence isn't guaranteed and storage is cleared when the + * buyer starts a new checkout. */ storage: Storage; - /** - * Methods to interact with the extension’s UI. - */ - ui: Ui; - /** * The renderer version being used for the extension. * @@ -739,265 +818,272 @@ export interface StandardApi { customerPrivacy: SubscribableSignalLike; /** - * Allows setting and updating customer privacy consent settings and tracking consent metafields. + * Enables setting and updating customer privacy consent settings and tracking consent metafields. * - * > Note: Requires the [`customer_privacy` capability](https://shopify.dev/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) to be set to `true`. + * > Note: Requires the [`collect_buyer_consent` capability](/docs/apps/build/customer-accounts/capabilities#collect-buyer-consent) to be set to `true`. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ applyTrackingConsentChange: ApplyTrackingConsentChangeType; /** - * The API for reading additional fields that are required in checkout under certain circumstances. - * For example, some countries require additional fields for customs information or tax identification numbers. + * Additional region-specific fields required during checkout, such as tax identification numbers (Brazil's CPF/CNPJ) or customs credentials. The property is available only if the extension has access to protected customer data. The array is empty if the current checkout doesn't require any localized fields. */ localizedFields?: SubscribableSignalLike; } -export interface Ui { - /** - * Allows the extension to close an overlay programmatically. - * - * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover). - */ - overlay: Overlay; -} - -interface Overlay { - /** - * Closes the overlay with the given ID. - */ - close(overlayId: string): void; -} - +/** + * Authenticates requests between your extension and your app backend. + * Use session tokens to verify the identity of the buyer and the shop + * context when making server-side API calls. The token is a signed JWT + * that contains claims such as the customer ID, shop domain, and expiration. + * + * The `sub` claim in the decoded token is present only when the buyer is + * logged in and the app has permission to read customer accounts. Absent for + * anonymous buyers. + */ export interface SessionToken { /** * Requests a session token that hasn't expired. You should call this method every * time you need to make a request to your backend in order to get a valid token. - * This method will return cached tokens when possible, so you don’t need to worry + * This method returns cached tokens when possible, so you don't need to worry * about storing these tokens yourself. */ get(): Promise; } +/** + * Information about the buyer who is completing the checkout. + * + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). The `customer` and `purchasingCompany` properties require level 1 access. The `email` and `phone` properties require level 2 access. + * @publicDocs + */ export interface BuyerIdentity { /** - * The buyer's customer account. The value is undefined if the buyer isn’t a + * The buyer's customer account, including their ID and whether they've accepted marketing. The value is `undefined` if the buyer isn't a * known customer for this shop or if they haven't logged in yet. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ customer: SubscribableSignalLike; /** - * The email address of the buyer that is interacting with the cart. - * The value is `undefined` if the app does not have access to customer data. + * The email address the buyer provided during checkout. The value is `undefined` if the app doesn't have access to customer data. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ email: SubscribableSignalLike; /** - * The phone number of the buyer that is interacting with the cart. - * The value is `undefined` if the app does not have access to customer data. + * The phone number the buyer provided during checkout. The value is `undefined` if no phone number was provided or the app doesn't have access to customer data. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ phone: SubscribableSignalLike; /** - * Provides details of the company and the company location that the business customer is purchasing on behalf of. - * This includes information that can be used to identify the company and the company location that the business - * customer belongs to. + * The company and company location that a B2B (business-to-business) customer is purchasing on behalf of. Use this to identify the business context of the order. The value is `undefined` if the buyer isn't a B2B customer. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ purchasingCompany: SubscribableSignalLike; } /** - * The information about a company that the business customer is purchasing on behalf of. + * The company and location that the [B2B](https://shopify.dev/docs/apps/build/b2b) customer is purchasing on behalf of. This is present only when the buyer is logged in as a business customer. + * @publicDocs */ export interface PurchasingCompany { /** - * Includes information of the company that the business customer is purchasing on behalf of. + * The company the B2B customer belongs to. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ company: Company; /** - * Includes information of the company location that the business customer is purchasing on behalf of. + * The specific company location associated with this B2B purchase. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ location: CompanyLocation; } +/** @publicDocs */ export interface Company { /** - * The company ID. + * A globally-unique identifier for the company in the format `gid://shopify/Company/`. + * + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * @example 'gid://shopify/Company/123' */ id: string; /** - * The name of the company. + * The company's display name. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ name: string; /** - * The external ID of the company that can be set by the merchant. + * A merchant-defined external identifier for the company. The value is `undefined` if the merchant hasn't set one. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ externalId?: string; } +/** @publicDocs */ export interface CompanyLocation { /** - * The company location ID. + * A globally-unique identifier for the company location in the format `gid://shopify/CompanyLocation/`. + * + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * @example 'gid://shopify/CompanyLocation/123' */ id: string; /** - * The name of the company location. + * The display name of the company location. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ name: string; /** - * The external ID of the company location that can be set by the merchant. + * A merchant-defined external identifier for the company location. The value is `undefined` if the merchant hasn't set one. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ externalId?: string; } +/** @publicDocs */ export interface AppliedGiftCard { /** - * The last four characters of the applied gift card's code. + * The last four characters of the applied gift card's code. The full code isn't exposed for security reasons. Use this value to display which card is applied. */ lastCharacters: string; /** - * The amount of the applied gift card that will be used when the checkout is completed. + * The amount of the applied gift card that's used when the checkout is completed. This might be less than `balance` if the order total is lower than the card's remaining balance. */ amountUsed: Money; /** - * The current balance of the applied gift card prior to checkout completion. + * The current balance of the applied gift card before checkout completion. This reflects the full remaining value on the card, not just the amount being applied to this order. */ balance: Money; } +/** + * Metadata about the merchant's store, including its name, storefront + * URL, `.myshopify.com` subdomain, and a globally-unique ID. + */ export interface Shop { /** - * The shop ID. + * A globally-unique identifier for the shop in the format `gid://shopify/Shop/`. + * * @example 'gid://shopify/Shop/123' */ id: string; /** - * The name of the shop. + * The display name of the shop as configured by the merchant in Shopify admin. */ name: string; /** - * The primary storefront URL. - * - * > Caution: - * > As of version `2024-04` this value will no longer have a trailing slash. + * The primary storefront URL for the shop, such as `'https://example.myshopify.com'`. Use this to build links back to the merchant's online store. */ storefrontUrl?: string; /** - * The shop's myshopify.com domain. + * The shop's unique `.myshopify.com` subdomain, such as `'example.myshopify.com'`. This domain is permanent and doesn't change even if the merchant adds a custom domain. */ myshopifyDomain: string; } +/** @publicDocs */ export interface CartCost { /** - * A `Money` value representing the subtotal value of the items in the cart at the current - * step of checkout. + * The sum of all line item prices at the current step of checkout, before shipping and taxes are applied. Use this value to display the base cost of the items the buyer purchased. */ subtotalAmount: SubscribableSignalLike; /** - * A `Money` value representing the total shipping a buyer can expect to pay at the current - * step of checkout. This value includes shipping discounts. Returns undefined if shipping - * has not been negotiated yet, such as on the information step. + * The total shipping cost after shipping discounts have been applied. The value is `undefined` if shipping hasn't been calculated yet, such as when the buyer is still on the information step. + * + * `undefined` until the buyer selects a shipping method (typically after the + * information step). */ totalShippingAmount: SubscribableSignalLike; /** - * A `Money` value representing the total tax a buyer can expect to pay at the current - * step of checkout or the total tax included in product and shipping prices. Returns - * undefined if taxes are unavailable. + * The total tax the buyer can expect to pay, or the total tax already included in product and shipping prices (for tax-inclusive regions). The value is `undefined` if taxes haven't been calculated yet. + * + * `undefined` when taxes haven't been calculated or aren't available for the + * buyer's region. */ totalTaxAmount: SubscribableSignalLike; /** - * A `Money` value representing the minimum a buyer can expect to pay at the current - * step of checkout. This value excludes amounts yet to be negotiated. For example, - * the information step might not have delivery costs calculated. + * The minimum total at the current step of checkout. Costs not yet calculated, such as shipping on the information step, aren't included. Gift cards and store credits are excluded from this total. */ totalAmount: SubscribableSignalLike; } +/** @publicDocs */ export interface CartLine { /** - * These line item IDs are not stable at the moment, they might change after - * any operations on the line items. You should always look up for an updated - * ID before any call to `applyCartLinesChange` because you'll need the ID to - * create a `CartLineChange` object. + * A unique identifier for the cart line in the format `gid://shopify/CartLine/`. This ID isn't stable and can change after any cart operation, so avoid persisting it. Always look up the current ID before calling `applyCartLinesChange()`, because you'll need it to create a `CartLineChange` object. + * * @example 'gid://shopify/CartLine/123' */ id: string; /** - * The merchandise being purchased. + * The product variant or other merchandise associated with this line item. Use this to access product details such as the title, image, SKU, and selected options. */ merchandise: Merchandise; /** - * The quantity of the merchandise being purchased. + * The number of units of this merchandise that the buyer purchased. */ quantity: number; /** - * The details about the cost components attributed to the cart line. + * The cost breakdown for this line item, including the total price after any line-level discounts have been applied. */ cost: CartLineCost; /** - * The line item additional custom attributes. + * Custom key-value attributes attached to this cart line, such as gift messages or engraving text. Use `applyCartLinesChange()` to update these values. */ attributes: Attribute[]; /** - * Discounts applied to the cart line. + * Discounts applied to this cart line, including code-based, automatic, and custom discounts. Each allocation shows the discounted amount and how the discount was triggered. */ discountAllocations: CartDiscountAllocation[]; /** - * Sub lines of the merchandise line. If no sub lines are present, this will be an empty array. + * The individual components of a [bundle](https://shopify.dev/docs/apps/build/product-merchandising/bundles) line item. Each component represents a separate product within the bundle. Returns an empty array if the line item isn't a bundle. */ lineComponents: CartLineComponentType[]; /** - * The relationship details between cart lines. + * The parent line item that this line belongs to, or `null` if this is a + * top-level line item. Used to identify lines added as children of a bundle + * or other grouped product. */ parentRelationship: CartLineParentRelationship | null; } +/** @publicDocs */ export interface CartLineParentRelationship { /** * The parent cart line that a cart line is associated with. */ parent: { /** - * These line item IDs are not stable at the moment, they might change after - * any operations on the line items. You should always look up for an updated + * These line item IDs aren't stable at the moment, and they might change after + * any operations on the line items. Always look up an updated * ID before any call to `applyCartLinesChange` because you'll need the ID to * create a `CartLineChange` object. * @example 'gid://shopify/CartLine/123' @@ -1008,170 +1094,195 @@ export interface CartLineParentRelationship { type CartLineComponentType = CartBundleLineComponent; +/** + * An individual component within a bundled cart line. Each `CartLine` that represents a bundle has a `lineComponents` array containing these components. + * @publicDocs + */ export interface CartBundleLineComponent { + /** + * Identifies this as a bundle line component. This is currently the only component type. + */ type: 'bundle'; /** - * A unique identifier for the bundle line component. - * - * This ID is not stable. If an operation updates the line items in any way, all IDs could change. + * A unique identifier for this component within the bundle, in the format `gid://shopify/CartLineComponent/`. This ID isn't stable and might change after any operation that updates the line items. * * @example 'gid://shopify/CartLineComponent/123' */ id: string; /** - * The merchandise of this bundle line component. + * The product variant included in this bundle component. Use this to display product details for individual items within a bundle. */ merchandise: Merchandise; /** - * The quantity of merchandise being purchased. + * The number of units of this component included in the bundle. */ quantity: number; /** - * The cost attributed to this bundle line component. + * The cost breakdown for this bundle component, including the total amount after any per-item discounts. */ cost: CartLineCost; /** - * Additional custom attributes for the bundle line component. + * Custom key-value pairs attached to this bundle component, such as personalization options specific to this item within the bundle. * * @example [{key: 'engraving', value: 'hello world'}] */ attributes: Attribute[]; } +/** @publicDocs */ export interface CartLineCost { /** - * The total amount after reductions the buyer can expect to pay that is directly attributable to a single - * cart line. + * The total price the buyer pays for this line item after all line-level discounts have been applied, but before order-level discounts, taxes, and shipping. */ totalAmount: Money; } +/** @publicDocs */ export interface Money { /** - * The price amount. + * The decimal amount of the price. For example, `29.99` represents twenty-nine dollars and ninety-nine cents. */ amount: number; /** - * The ISO 4217 format for the currency. + * The three-letter currency code in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. + * * @example 'CAD' for Canadian dollar */ currencyCode: CurrencyCode; } +/** @publicDocs */ export type Merchandise = ProductVariant; +/** @publicDocs */ export interface BaseMerchandise { /** - * The merchandise ID. + * A globally unique identifier for the merchandise. + * + * @example 'gid://shopify/ProductVariant/123' */ id: string; } +/** @publicDocs */ export interface ProductVariant extends BaseMerchandise { + /** + * Identifies the merchandise as a product variant. This is currently the only merchandise type in checkout. + */ type: 'variant'; /** - * A globally-unique identifier. + * A globally-unique identifier for the product variant in the format `gid://shopify/ProductVariant/`. + * * @example 'gid://shopify/ProductVariant/123' */ id: string; /** - * The product variant’s title. + * The display title of the product variant, such as "Small" or "Red / Large". This is the variant-specific label, not the parent product title. */ title: string; /** - * The product variant's subtitle. + * A secondary description for the variant that provides additional context, such as a color or size combination. The value is `undefined` if no subtitle is available. */ subtitle?: string; /** - * Image associated with the product variant. This field falls back to the product - * image if no image is available. + * The image associated with the product variant. Falls back to the product image if the variant doesn't have its own. The value is `undefined` if neither the variant nor the product has an image. */ image?: ImageDetails; /** - * List of product options applied to the variant. + * The product options applied to this variant, such as size, color, or material. Each entry contains the option name and the selected value. */ selectedOptions: SelectedOption[]; /** - * The product object that the product variant belongs to. + * The parent product that this variant belongs to. Use this to access the product's ID, vendor, and type. */ product: Product; /** - * Whether or not the product requires shipping. + * Whether this product variant requires physical shipping. When `true`, the buyer must provide a shipping address. Returns `false` for digital products, gift cards, and services. */ requiresShipping: boolean; /** - * The selling plan associated with the merchandise. + * The [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) associated with this variant, such as a subscription or pre-order plan. The value is `undefined` if the item isn't being purchased through a selling plan. */ sellingPlan?: SellingPlan; /** - * The product variant's sku. + * The stock keeping unit (SKU) assigned to this variant by the merchant, used for inventory tracking. The value is `undefined` if no SKU has been set. */ sku?: string; } +/** @publicDocs */ export interface Product { /** - * A globally-unique identifier. + * A globally-unique identifier for the product in the format `gid://shopify/Product/`. + * + * @example 'gid://shopify/Product/123' */ id: string; /** - * The product’s vendor name. + * The name of the product's vendor or manufacturer, as set by the merchant in Shopify admin. */ vendor: string; /** - * A categorization that a product can be tagged with, commonly used for filtering and searching. + * A merchant-defined categorization for the product, such as "Accessories" or "Clothing". Commonly used for filtering and organizing products in a storefront. */ productType: string; } +/** @publicDocs */ export interface ImageDetails { /** - * The image URL. + * The fully-qualified URL of the image. Use this to render the product or variant image in your extension. */ url: string; /** - * The alternative text for the image. + * The alternative text for the image, used for accessibility. The value is `undefined` if the merchant hasn't provided alt text. */ altText?: string; } +/** @publicDocs */ export interface SelectedOption { /** - * The name of the merchandise option. + * The name of the product option, such as "Color" or "Size". + * + * @example 'Size' */ name: string; /** - * The value of the merchandise option. + * The selected value for the product option, such as "Red" or "Large". + * + * @example 'Large' */ value: string; } /** * A payment option presented to the buyer. + * @publicDocs */ export interface PaymentOption { /** * The type of the payment option. * - * Shops can be configured to support many different payment options. Some options are only available to buyers in specific regions. + * Shops can be configured to support many different payment options. Some options are available only to buyers in specific regions. * * | Type | Description | * |---|---| @@ -1181,10 +1292,10 @@ export interface PaymentOption { * | `manualPayment` | A manual payment option such as an in-person retail transaction. | * | `offsite` | A payment processed outside of Shopify's checkout, excluding integrated wallets. | * | `other` | Another type of payment not defined here. | - * | `paymentOnDelivery` | A payment that will be collected on delivery. | + * | `paymentOnDelivery` | A payment collected on delivery. | * | `redeemable` | A redeemable payment option such as a gift card or store credit. | - * | `wallet` | An integrated wallet such as PayPal, Google Pay, Apple Pay, etc. | - * | `customOnsite` | A custom payment option that is processed through a checkout extension with a payments app. | + * | `wallet` | An integrated wallet such as PayPal, Google Pay, or Apple Pay. | + * | `customOnsite` | A custom payment option that's processed through a checkout extension with a payments app. | */ type: | 'creditCard' @@ -1199,67 +1310,82 @@ export interface PaymentOption { | 'customOnsite'; /** - * The unique handle for the payment option. - * - * This is not a globally unique identifier. It may be an identifier specific to the given checkout session or the current shop. + * A session-scoped identifier for this payment option. This handle isn't globally unique; it's specific to the current checkout session or the shop. */ handle: string; } +/** + * A payment option that the buyer has actively selected. This is the same shape as `PaymentOption` and appears in `selectedPaymentOptions`. + * @publicDocs + */ export type SelectedPaymentOption = PaymentOption; +/** @publicDocs */ export interface CartDiscountCode { /** - * The code for the discount + * The discount code string entered by the buyer during checkout or applied programmatically, such as `"SAVE10"` or `"FREESHIP"`. Use this to display which discount codes were applied. */ code: string; } +/** + * A discount allocation applied to the cart. Use the `type` property to determine how the discount was triggered: + * + * - `CartCodeDiscountAllocation` (`type: 'code'`): Triggered by a discount code the buyer entered. + * - `CartAutomaticDiscountAllocation` (`type: 'automatic'`): Applied automatically based on merchant-configured rules. + * - `CartCustomDiscountAllocation` (`type: 'custom'`): Applied by a [Shopify Function](https://shopify.dev/docs/api/functions/latest/discount). + * @publicDocs + */ export type CartDiscountAllocation = | CartCodeDiscountAllocation | CartAutomaticDiscountAllocation | CartCustomDiscountAllocation; +/** @publicDocs */ export interface CartDiscountAllocationBase { /** - * The money amount that has been discounted from the order + * The monetary value that was deducted from the line item or order total by this discount allocation. */ discountedAmount: Money; } +/** @publicDocs */ export interface CartCodeDiscountAllocation extends CartDiscountAllocationBase { /** - * The code for the discount + * The discount code string that the buyer entered during checkout, such as `"SAVE10"` or `"FREESHIP"`. */ code: string; /** - * The type of the code discount + * Identifies this as a code-based discount, triggered by a discount code the buyer entered at checkout. */ type: 'code'; } +/** @publicDocs */ export interface CartAutomaticDiscountAllocation extends CartDiscountAllocationBase { /** - * The title of the automatic discount + * The merchant-defined title of the automatic discount as displayed to the buyer, such as "Summer Sale 10% Off". */ title: string; /** - * The type of the automatic discount + * Identifies this as an automatic discount, applied based on merchant-configured rules without a code. */ type: 'automatic'; } +/** @publicDocs */ export interface CartCustomDiscountAllocation extends CartDiscountAllocationBase { /** - * The title of the custom discount + * The title of the custom discount, typically applied by a [Shopify Function](https://shopify.dev/docs/api/functions/latest/discount). */ title: string; /** - * The type of the custom discount + * Identifies this as a custom discount applied by a [Shopify Function](https://shopify.dev/docs/api/functions/latest/discount). */ type: 'custom'; } @@ -1276,19 +1402,20 @@ interface InterceptorResultAllow { interface InterceptorResultBlock { /** * Indicates that some part of the checkout UI intercepted and prevented - * the buyer’s progress. The buyer typically needs to take some action + * the buyer's progress. The buyer typically needs to take some action * to resolve this issue and to move on to the next step. */ behavior: 'block'; } +/** @publicDocs */ export type InterceptorRequest = | InterceptorRequestAllow | InterceptorRequestBlock; interface InterceptorRequestAllow { /** - * Indicates that the interceptor will allow the buyer's journey to continue. + * Indicates that the interceptor allows the buyer's journey to continue. */ behavior: 'allow'; @@ -1296,6 +1423,11 @@ interface InterceptorRequestAllow { * This callback is called when all interceptors finish. We recommend * setting errors or reasons for blocking at this stage, so that all the errors in * the UI show up at once. + * + * Runs after all intercept results are collected. Use it for local state + * updates such as setting an error flag. By the time it runs, the navigation + * decision is final, so blocking logic belongs in the intercept handler + * itself, not here. * @param result InterceptorResult with behavior as either 'allow' or 'block' */ perform?(result: InterceptorResult): void | Promise; @@ -1303,13 +1435,13 @@ interface InterceptorRequestAllow { // The reason is used for tracing and debugging purposes. interface InterceptorRequestBlock { /** - * Indicates that the interceptor will block the buyer's journey from continuing. + * Indicates that the interceptor blocks the buyer's journey from continuing. */ behavior: 'block'; /** * The reason for blocking the interceptor request. This value isn't presented to - * the buyer, so it doesn't need to be localized. The value is used only for Shopify’s + * the buyer, so it doesn't need to be localized. The value is used only for Shopify's * own internal debugging and metrics. */ reason: string; @@ -1323,15 +1455,20 @@ interface InterceptorRequestBlock { * This callback is called when all interceptors finish. We recommend * setting errors or reasons for blocking at this stage, so that all the errors in * the UI show up at once. + * + * Runs after all intercept results are collected. Use it for local state + * updates such as setting an error flag. By the time it runs, the navigation + * decision is final, so blocking logic belongs in the intercept handler + * itself, not here. * @param result InterceptorResult with behavior as either 'allow' or 'block' */ perform?(result: InterceptorResult): void | Promise; } +/** @publicDocs */ export interface InterceptorProps { /** - * Whether the interceptor has the capability to block a buyer's progress through - * checkout. This ability might be granted by a merchant in differing checkout contexts. + * Whether the interceptor can block the buyer's progress through checkout. When `true`, the merchant has granted your extension the `block_progress` capability. When `false`, you can still validate but can't prevent the buyer from continuing. */ canBlockProgress: boolean; } @@ -1339,9 +1476,10 @@ export interface InterceptorProps { /** * A function for intercepting and preventing navigation on checkout. You can block * navigation by returning an object with - * `{behavior: 'block', reason: InvalidResultReason.InvalidExtensionState, errors?: ValidationErrors[]}`. + * `{behavior: 'block', reason: 'your reason here', errors?: ValidationError[]}`. * If you do, then you're expected to also update some part of your UI to reflect the reason why navigation - * was blocked, either by targeting checkout UI fields, passing errors to the page level or rendering the errors in your extension. + * was blocked, either by targeting checkout UI fields, passing errors to the page level, or rendering the errors in your extension. + * @publicDocs */ export type Interceptor = ( interceptorProps: InterceptorProps, @@ -1350,57 +1488,58 @@ export type Interceptor = ( /** * Information about a customer who has previously purchased from this shop. * - * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). + * @publicDocs */ export interface Customer { /** - * Customer ID. + * An identifier for the customer in the format `gid://shopify/Customer/`. This value is unique per shop. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @example 'gid://shopify/Customer/123' */ id: string; /** - * The email of the customer. + * The email address associated with the customer's account. The value is `undefined` if the app doesn't have the required access level. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ email?: string; /** - * The phone number of the customer. + * The phone number associated with the customer's account. The value is `undefined` if no phone number is on file or the app doesn't have the required access level. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ phone?: string; /** - * The full name of the customer. + * The customer's full name, typically a combination of first and last name. The value is `undefined` if the app doesn't have the required access level. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ fullName?: string; /** - * The first name of the customer. + * The customer's first name. The value is `undefined` if the app doesn't have the required access level. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ firstName?: string; /** - * The last name of the customer. + * The customer's last name. The value is `undefined` if the app doesn't have the required access level. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 2 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ lastName?: string; /** - * The image associated with the customer. + * The customer's profile image, such as a Gravatar avatar. Use this to personalize the extension UI for the logged-in buyer. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ image: ImageDetails; /** - * Defines if the customer email accepts marketing activities. + * Whether the customer has opted in to receiving marketing communications from the merchant, such as email campaigns and promotional offers. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * > Caution: This field is deprecated and will be removed in a future version. Use `acceptsEmailMarketing` or `acceptsSmsMarketing` instead. * @@ -1408,125 +1547,147 @@ export interface Customer { */ acceptsMarketing: boolean; /** - * Defines if the customer accepts email marketing activities. + * Whether the customer has opted in to email marketing. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ acceptsEmailMarketing: boolean; /** - * Defines if the customer accepts SMS marketing activities. + * Whether the customer has opted in to SMS marketing. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ acceptsSmsMarketing: boolean; /** - * The Store Credit Accounts owned by the customer and usable during the checkout process. + * The store credit accounts owned by this customer that can be used as payment during checkout. Each account has a balance representing available store credit. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * * @private */ storeCreditAccounts: StoreCreditAccount[]; /** - * The number of previous orders made by this customer. + * The number of orders the customer has previously placed with this shop. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ ordersCount: number; } /** * Settings describing the behavior of the buyer's checkout. + * @publicDocs */ export interface CheckoutSettings { /** - * The type of order that will be created once the buyer completes checkout. + * The type of order created when the buyer completes checkout. + * + * - `'DRAFT_ORDER'`: The checkout creates a draft order that the merchant must manually confirm before fulfillment. Common for B2B checkouts with deferred payment terms. + * - `'ORDER'`: The checkout creates a confirmed order immediately upon completion. */ orderSubmission: 'DRAFT_ORDER' | 'ORDER'; /** - * Represents the merchant configured payment terms. + * The payment terms configured by the merchant for B2B orders, such as net-30 or net-60. The value is `undefined` if no payment terms are configured. */ paymentTermsTemplate?: PaymentTermsTemplate; /** - * Settings describing the behavior of the shipping address. + * Settings that control how the shipping address behaves during checkout, such as whether the buyer can edit the address. */ shippingAddress: ShippingAddressSettings; } /** * Settings describing the behavior of the shipping address. + * @publicDocs */ export interface ShippingAddressSettings { /** - * Describes whether the buyer can ship to any address during checkout. + * Whether the buyer is allowed to edit the shipping address during checkout. When `false`, the shipping address is locked and can't be changed, which is common for B2B orders with a predefined ship-to address. */ isEditable: boolean; } /** - * Represents the payment terms template object. + * A payment terms template configured by the merchant, defining when payment is due for B2B orders. Common examples include "Net 30" (due in 30 days) or "Due on receipt". + * @publicDocs */ export interface PaymentTermsTemplate { /** - * A globally-unique ID. + * A globally-unique identifier for the payment terms template in the format `gid://shopify/PaymentTermsTemplate/`. + * * @example 'gid://shopify/PaymentTermsTemplate/1' */ id: string; /** - * The name of the payment terms translated to the buyer's current language. Refer to [localization.language](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-localization). + * The name of the payment terms translated to the buyer's current language, such as "Net 30" or "Due on receipt". */ name: string; /** - * The due date for net payment terms as a ISO 8601 formatted string `YYYY-MM-DDTHH:mm:ss.sssZ`. + * The due date for payment in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ss.sssZ`). The value is `undefined` if the payment terms don't have a fixed due date. */ dueDate?: string; /** - * The number of days between the issued date and due date if using net payment terms. + * The number of days the buyer has to pay after the order is placed, such as `30` for "Net 30" terms. The value is `undefined` if the payment terms aren't net-based. */ dueInDays?: number; } /** - * Information about a Store Credit Account. + * A store credit account owned by the customer. Store credit is a form of payment that merchants can issue to customers for returns, refunds, or promotional purposes. + * @publicDocs */ export interface StoreCreditAccount { /** - * A globally-unique identifier. + * A globally-unique identifier for the store credit account in the format `gid://shopify/StoreCreditAccount/`. + * * @example 'gid://shopify/StoreCreditAccount/1' */ id: string; /** - * The current balance of the Store Credit Account. + * The remaining balance available in this store credit account. This reflects the amount that can still be applied toward purchases. */ balance: Money; } /** * The merchant-defined setting values for the extension. + * @publicDocs */ export type ExtensionSettings = Record< string, string | number | boolean | undefined >; +/** + * Tracks custom events and sends visitor information to + * [Web Pixels](https://shopify.dev/docs/apps/marketing). Use `publish()` to emit events + * and `visitor()` to submit buyer contact details. + */ export interface Analytics { /** - * Publish method to emit analytics events to [Web Pixels](https://shopify.dev/docs/apps/marketing). + * Publishes a custom event to [Web Pixels](https://shopify.dev/docs/apps/marketing). + * Returns `true` when the event is successfully dispatched. + * + * The Promise resolves to `true` when the event was dispatched. The boolean + * indicates dispatch confirmation only. It doesn't indicate whether any + * specific web pixel processed the event. */ publish(name: string, data: Record): Promise; /** - * A method for capturing details about a visitor on the online store. + * Submits buyer contact details for attribution and analytics purposes. */ visitor(data: {email?: string; phone?: string}): Promise; } /** * Represents a visitor result. + * @publicDocs */ export type VisitorResult = VisitorSuccess | VisitorError; /** * Represents a successful visitor result. + * @publicDocs */ export interface VisitorSuccess { /** @@ -1537,82 +1698,98 @@ export interface VisitorSuccess { /** * Represents an unsuccessful visitor result. + * @publicDocs */ export interface VisitorError { /** * Indicates that the visitor information is invalid and wasn't submitted. - * Examples are using the wrong data type or missing a required property. + * Common causes include using the wrong data type or omitting a required property. */ type: 'error'; /** * A message that explains the error. This message is useful for debugging. - * It's **not** localized, and therefore should not be presented directly - * to the buyer. + * It isn't localized and shouldn't be displayed to the buyer. */ message: string; } /** - * Represents the delivery information and options available for one or - * more cart lines. + * A group of cart lines that share the same set of delivery options. For example, physical items might form one delivery group while digital items form another. + * @publicDocs */ export interface DeliveryGroup { /** - * The unique identifier of the delivery group. On the Thank You page this value is undefined. + * A unique identifier for the delivery group. The value is `undefined` if the underlying delivery line doesn't have an ID assigned. */ id?: string; /** - * The cart line references associated to the delivery group. + * The cart lines that belong to this delivery group. Each reference contains the cart line's `id`, which you can match against `lines` to get the full cart line details. */ targetedCartLines: CartLineReference[]; /** - * The delivery options available for the delivery group. + * The delivery options available for this group, including shipping, pickup point, and pickup location options. The buyer selects one of these to determine how their items are delivered. */ deliveryOptions: DeliveryOption[]; /** - * The selected delivery option for the delivery group. + * The delivery option the buyer has selected for this group. The value is `undefined` if the buyer hasn't selected a delivery option yet. Contains a `handle` you can match against `deliveryOptions` entries. */ selectedDeliveryOption?: DeliveryOptionReference; /** - * The type of the delivery group. + * Whether this group contains items for a one-time purchase or a subscription. + * Subscription delivery groups might have different shipping options. See `DeliveryGroupType` for possible values. */ groupType: DeliveryGroupType; /** - * Whether delivery is required for the delivery group. + * Whether physical delivery is required for the items in this group. + * Digital-only groups don't require delivery. */ isDeliveryRequired: boolean; } /** * The possible types of a delivery group. + * + * - `'oneTimePurchase'`: Items bought as a single, non-recurring purchase. + * - `'subscription'`: Items bought through a [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries. + * @publicDocs */ export type DeliveryGroupType = 'oneTimePurchase' | 'subscription'; /** - * Represents a reference to a cart line. + * A reference to a cart line within a delivery group, identified by the cart line's ID. + * @publicDocs */ export interface CartLineReference { /** - * The unique identifier of the referenced cart line. + * The unique identifier of the referenced cart line. Match this against `CartLine.id` from the `lines` property to get the full line item details. */ id: string; } /** - * Represents a reference to a delivery option. + * A reference to the delivery option selected by the buyer for a delivery group. + * @publicDocs */ export interface DeliveryOptionReference { /** - * The unique identifier of the referenced delivery option. + * The unique identifier of the referenced delivery option. Match this against `DeliveryOption.handle` from the `deliveryOptions` array to get the full option details. */ handle: string; } +/** + * A delivery option available to the buyer. Use the `type` property to determine which kind of option it is: + * + * - `ShippingOption` (`type: 'shipping' | 'local'`): Items shipped by a carrier or delivered locally by the merchant. + * - `PickupPointOption` (`type: 'pickupPoint'`): Items shipped to a third-party collection point for the buyer to pick up. + * - `PickupLocationOption` (`type: 'pickup'`): Items picked up directly from a merchant's store or warehouse. + * @publicDocs + */ export type DeliveryOption = | ShippingOption | PickupPointOption @@ -1620,132 +1797,145 @@ export type DeliveryOption = /** * Represents a base interface for a single delivery option. + * @publicDocs */ export interface DeliveryOptionBase { /** - * The unique identifier of the delivery option. + * The unique identifier of the delivery option. Use this to match against `DeliveryOptionReference.handle` or `DeliverySelectionGroup` entries. */ handle: string; /** - * The title of the delivery option. + * The merchant-facing or carrier-provided display name for the delivery + * option, such as "Standard Shipping" or "Express". */ title?: string; /** - * The description of the delivery option. + * Additional details about the delivery option provided by the carrier + * or merchant, such as estimated delivery windows or service level notes. */ description?: string; /** - * The code of the delivery option. + * The carrier service code or rate identifier for this delivery option. */ code: string; /** - * The metafields associated with this delivery option. + * Custom [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields) attached to this delivery option by the carrier or a [Shopify Function](https://shopify.dev/docs/apps/build/functions). Use these to display additional information about the option. */ metafields: Metafield[]; } /** - * Represents a delivery option that is a shipping option. + * Represents a delivery option that's a shipping option. + * @publicDocs */ export interface ShippingOption extends DeliveryOptionBase { /** - * The type of this delivery option. + * Identifies the delivery method. `'shipping'` means items are shipped by a carrier. `'local'` means the merchant handles delivery themselves, for example same-day local delivery. */ type: 'shipping' | 'local'; /** - * Information about the carrier. + * Information about the carrier providing this shipping option, including the carrier's display name. */ carrier: ShippingOptionCarrier; /** - * The cost of the delivery. + * The cost of this delivery option before any shipping discounts are applied. Compare with `costAfterDiscounts` to show savings. */ cost: Money; /** - * The cost of the delivery including discounts. + * The cost of this delivery option after shipping discounts have been applied. This is the price the buyer actually pays for shipping. */ costAfterDiscounts: Money; /** - * Information about the estimated delivery time. + * The estimated delivery time for this shipping option. Use the `timeInTransit` range to display an estimated arrival window to the buyer. */ deliveryEstimate: DeliveryEstimate; } +/** @publicDocs */ export interface DeliveryEstimate { /** - * The estimated time in transit for the delivery in seconds. + * The estimated time in transit for the delivery, expressed as a range + * in seconds. Undefined when the carrier doesn't provide an estimate. + * When present, either the lower or upper bound of the range might still + * be omitted. */ timeInTransit?: NumberRange; } +/** @publicDocs */ export interface ShippingOptionCarrier { /** - * The name of the carrier. + * The display name of the shipping carrier, such as "Canada Post" or "UPS". The value is `undefined` if the carrier name isn't available. */ name?: string; } +/** @publicDocs */ export interface PickupPointOption extends DeliveryOptionBase { /** - * The type of this delivery option. + * Identifies this as a pickup point option, where items are shipped to a third-party collection point for the buyer to pick up. */ type: 'pickupPoint'; /** - * Information about the carrier that ships to the pickup point. + * Information about the carrier that ships items to this pickup point, including the carrier's name and code. */ carrier: PickupPointCarrier; /** - * The cost to ship to this pickup point. + * The cost of this delivery option before any shipping discounts are applied. Compare with `costAfterDiscounts` to show savings. */ cost: Money; /** - * The cost to ship to this pickup point including discounts. + * The cost of this delivery option after shipping discounts have been applied. This is the price the buyer actually pays for shipping. */ costAfterDiscounts: Money; /** - * The location details of the pickup point. + * The physical location where the buyer picks up their order, including the address and display name of the collection point. */ location: PickupPointLocation; } +/** @publicDocs */ export interface PickupLocationOption extends DeliveryOptionBase { /** - * The type of this delivery option. + * Identifies this as a pickup location option, where the buyer picks up items directly from a merchant's store or warehouse. */ type: 'pickup'; /** - * The location details of the pickup location. + * The merchant's store or warehouse where the buyer picks up their order, including the address and display name. */ location: PickupLocation; } interface PickupLocation { /** - * The name of the pickup location. + * The merchant-defined display name of the pickup location, such as a + * store name or warehouse label. */ name?: string; /** - * The address of the pickup location. + * The physical address of the pickup location. */ address: MailingAddress; } interface PickupPointLocation { /** - * The name of the pickup point. + * The display name of the pickup point, such as the name of the locker + * or collection point. */ name?: string; @@ -1755,168 +1945,214 @@ interface PickupPointLocation { handle: string; /** - * The address of the pickup point. + * The physical address of the pickup point. */ address: MailingAddress; } interface PickupPointCarrier { /** - * The code identifying the carrier. + * The carrier's unique identifier code, used to distinguish between + * different carriers that deliver to pickup points. */ code?: string; /** - * The name of the carrier. + * The display name of the carrier that delivers to this pickup point. */ name?: string; } +/** @publicDocs */ export interface NumberRange { /** - * The lower bound of the number range. + * The lower bound of the range. Undefined if only an upper bound is + * provided. */ lower?: number; /** - * The upper bound of the number range. + * The upper bound of the range. Undefined if only a lower bound is + * provided. */ upper?: number; } /** * Represents a DeliveryGroup with expanded reference fields and full details. + * @publicDocs */ export interface DeliveryGroupDetails extends DeliveryGroup { /** - * The selected delivery option for the delivery group. + * The full delivery option the buyer has selected for this group, with all cost and carrier details included. The value is `undefined` if the buyer hasn't selected an option yet. Unlike `DeliveryGroup.selectedDeliveryOption`, which is a reference, this contains the complete `DeliveryOption` object. */ selectedDeliveryOption?: DeliveryOption; /** - * The cart lines associated to the delivery group. + * The full cart line objects associated with this delivery group, with all merchandise and cost details included. Unlike `DeliveryGroup.targetedCartLines`, which contains references, this contains the complete `CartLine` objects. */ targetedCartLines: CartLine[]; } +/** @publicDocs */ export interface AllowedProcessing { /** - * Can collect customer analytics about how the shop was used and interactions made on the shop. + * Whether analytics data can be collected based on the visitor's consent, + * the merchant's privacy configuration, and the visitor's region. Analytics + * data includes how the shop was used and what interactions occurred. + * + * Whether analytics data can be collected right now. Combines the buyer's + * consent, the merchant's privacy configuration, and the buyer's region into + * a single boolean. Check this flag, not `visitorConsent.analytics`, before + * calling `shopify.analytics.publish()`. */ analytics: boolean; /** - * Can collect customer preference for marketing, attribution and targeted advertising from the merchant. + * Whether marketing data can be collected based on the visitor's consent, + * the merchant's privacy configuration, and the visitor's region. Marketing + * data includes attribution and targeted advertising preferences. + * + * Whether marketing data can be collected right now. Combines the buyer's + * consent, the merchant's privacy configuration, and the buyer's region into + * a single boolean. Check this flag, not `visitorConsent.marketing`, before + * performing marketing-related data collection. */ marketing: boolean; /** - * Can collect customer preferences such as language, currency, size, and more. + * Whether preference data can be collected based on the visitor's consent, + * the merchant's privacy configuration, and the visitor's region. Preference + * data includes language, currency, and sizing choices. + * + * Whether preference data can be collected right now. Combines the buyer's + * consent, the merchant's privacy configuration, and the buyer's region into + * a single boolean. Check this flag, not `visitorConsent.preferences`, + * before storing or reading buyer preference data. */ preferences: boolean; /** - * Can collect customer preference for sharing data with third parties, usually for behavioral advertising. + * Whether data can be shared with third parties based on the visitor's + * consent, the merchant's privacy configuration, and the visitor's region. + * This typically applies to behavioral advertising data. + * + * Whether buyer data can be shared with or sold to third parties right now. + * Combines the buyer's consent, the merchant's privacy configuration, and + * the buyer's region into a single boolean. Check this flag, not + * `visitorConsent.saleOfData`, before sharing or selling buyer data with + * third parties. */ saleOfData: boolean; } +/** @publicDocs */ export interface VisitorConsent { /** - * Visitor consents to recording data to understand how customers interact with the site. + * The visitor's consent for analytics tracking. `true` means the visitor + * actively granted consent, `false` means actively denied, and `undefined` + * means no decision has been made yet. */ analytics?: boolean; /** - * Visitor consents to ads and marketing communications based on customer interests. + * The visitor's consent for marketing and targeted advertising. `true` means + * the visitor actively granted consent, `false` means actively denied, and + * `undefined` means no decision has been made yet. */ marketing?: boolean; /** - * Visitor consent to remembering customer preferences, such as country or language, to personalize visits to the website. + * The visitor's consent for storing preferences such as language and currency. + * `true` means the visitor actively granted consent, `false` means actively + * denied, and `undefined` means no decision has been made yet. */ preferences?: boolean; /** - * Opts the visitor out of data sharing / sales. + * The visitor's consent for the sale or sharing of their personal data with + * third parties. `true` means the visitor actively granted consent, `false` + * means actively denied, and `undefined` means no decision has been made yet. */ saleOfData?: boolean; } +/** @publicDocs */ export interface TrackingConsentMetafield { /** - * The name of the metafield. It must be between 3 and 30 characters in - * length (inclusive). + * The identifier for the tracking consent metafield, such as `'analyticsType'` or `'marketingType'`. */ key: string; /** - * The information to be stored as metadata. - * - * @example 'any string', '', or a stringified JSON object + * The value stored in the tracking consent metafield, such as `'granular'` or a stringified JSON object. */ value: string; } +/** @publicDocs */ export interface TrackingConsentMetafieldChange { /** - * The name of the metafield. It must be between 3 and 30 characters in - * length (inclusive). + * The identifier for the tracking consent metafield to update. */ key: string; /** - * The information to be stored as metadata. If the value is `null`, the metafield will be deleted. + * The new value to store in the metafield. Set to `null` to delete the metafield. * - * @example 'any string', `null`, or a stringified JSON object + * Consent metafield values are strings, not booleans. Pass `null` to delete + * a tracking consent metafield. */ value: string | null; } +/** @publicDocs */ export interface VisitorConsentChange extends VisitorConsent { /** * Tracking consent metafield data to be saved. * - * If the value is `null`, the metafield will be deleted. + * If the value is `null`, the metafield is deleted. * * @example `[{key: 'granularAnalytics', value: 'true'}, {key: 'granularMarketing', value: 'false'}]` */ metafields?: TrackingConsentMetafieldChange[]; + /** + * Identifies this as a visitor consent change. This is the only supported change type for `applyTrackingConsentChange()`. + */ type: 'changeVisitorConsent'; } +/** @publicDocs */ export type ApplyTrackingConsentChangeType = ( visitorConsent: VisitorConsentChange, ) => Promise; +/** @publicDocs */ export interface CustomerPrivacyRegion { /** - * The [ISO 3166 Alpha-2 format](https://www.iso.org/iso-3166-country-codes.html) for the buyer's country. + * The buyer's country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The value is `undefined` if geolocation failed. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * - * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain, or undefined if geolocation failed. + * @example 'CA' for Canada, 'US' for United States, 'GB' for Great Britain */ countryCode?: CountryCode; /** - * The buyer's province code, such as state, province, prefecture, or region. + * The buyer's province, state, or region code in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. The value is `undefined` if geolocation failed or only the country was detected. * - * Province codes can be found by clicking on the `Subdivisions assigned codes` column for countries listed [here](https://en.wikipedia.org/wiki/ISO_3166-2). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). - * - * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California, or undefined if geolocation failed or only the country was detected. + * @example 'ON' for Ontario, 'ENG' for England, 'CA' for California */ provinceCode?: string; } +/** @publicDocs */ export interface CustomerPrivacy { /** - * An object containing flags for each consent property denoting whether they can be processed based on visitor consent, merchant configuration, and user location. + * Flags indicating whether each type of data processing is permitted, based on the visitor's consent, the merchant's privacy configuration, and the visitor's geographic location. */ allowedProcessing: AllowedProcessing; /** - * Stored tracking consent metafield data. + * The tracking consent metafields that have been stored for this visitor. These contain app-specific consent data beyond the standard categories. * * @example `[{key: 'analyticsType', value: 'granular'}, {key: 'marketingType', value: 'granular'}]`, or `[]` */ metafields: TrackingConsentMetafield[]; /** - * An object containing the customer's current privacy consent settings. - * * - * @example `true` — the customer has actively granted consent, `false` — the customer has actively denied consent, or `undefined` — the customer has not yet made a decision. + * The visitor's current privacy consent settings. Each property represents a consent category and is `true` (actively granted), `false` (actively denied), or `undefined` (no decision made yet). */ visitorConsent: VisitorConsent; /** @@ -1926,29 +2162,31 @@ export interface CustomerPrivacy { */ shouldShowBanner: boolean; /** - * Whether the visitor is in a region requiring data sale opt-outs. + * Whether the visitor is located in a region that requires an explicit opt-out option for the sale or sharing of personal data, such as California (CCPA) or other jurisdictions with similar regulations. */ saleOfDataRegion: boolean; /** - * Details about the visitor's current location for use in evaluating if more granular consent controls should render. + * The visitor's geographic location, used to determine whether more granular consent controls should be displayed based on regional privacy regulations. * * @example `{countryCode: 'CA', provinceCode: 'ON'}` for a visitor in Ontario, Canada; `{countryCode: 'US', provinceCode: undefined}` for a visitor in the United States if geolocation fails to detect the state; or `undefined` if neither country nor province is detected or geolocation fails. * - * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data). + * {% include /apps/checkout/privacy-icon.md %} Requires level 1 access to [protected customer data](https://shopify.dev/docs/apps/store/data-protection/protected-customer-data). */ region?: CustomerPrivacyRegion; } +/** @publicDocs */ export type TrackingConsentChangeResult = | TrackingConsentChangeResultSuccess | TrackingConsentChangeResultError; /** * The returned result of a successful tracking consent preference update. + * @publicDocs */ export interface TrackingConsentChangeResultSuccess { /** - * The type of the `TrackingConsentChangeResultSuccess` API. + * Indicates that the tracking consent update was applied successfully. */ type: 'success'; } @@ -1956,108 +2194,134 @@ export interface TrackingConsentChangeResultSuccess { /** * The returned result of an unsuccessful tracking consent preference update * with a message detailing the type of error that occurred. + * @publicDocs */ export interface TrackingConsentChangeResultError { /** - * The type of the `TrackingConsentChangeResultError` API. + * Indicates that the tracking consent update couldn't be applied. Check the `message` property for details. */ type: 'error'; /** * A message that explains the error. This message is useful for debugging. - * It is **not** localized, and therefore should not be presented directly - * to the buyer. + * It isn't localized and shouldn't be displayed to the buyer. */ message: string; } +/** @publicDocs */ export interface CartInstructions { /** - * Cart instructions related to cart attributes. + * Whether the extension can update custom attributes using `applyAttributeChange()`. */ attributes: AttributesCartInstructions; /** - * Cart instructions related to delivery. + * Whether the extension can modify the shipping address using `applyShippingAddressChange()`. */ delivery: DeliveryCartInstructions; /** - * Cart instructions related to discounts. + * Whether the extension can add or remove discount codes using `applyDiscountCodeChange()`. */ discounts: DiscountsCartInstructions; /** - * Cart instructions related to cart lines. + * Whether the extension can add, remove, or update cart lines using `applyCartLinesChange()`. */ lines: CartLinesCartInstructions; /** - * Cart instructions related to metafields. + * Whether the extension can add, update, or delete cart metafields using `applyMetafieldChange()`. */ metafields: MetafieldsCartInstructions; /** - * Cart instructions related to notes. + * Whether the extension can update the order note using `applyNoteChange()`. */ notes: NotesCartInstructions; } +/** @publicDocs */ export interface AttributesCartInstructions { /** - * Indicates whether or not cart attributes can be updated. + * Whether attributes can be updated using `applyAttributeChange()`. When + * `false`, the checkout configuration doesn't allow attribute changes. + * Even when `true`, calls to `applyAttributeChange()` can still fail + * during accelerated checkout (Apple Pay, Google Pay). */ canUpdateAttributes: boolean; } +/** @publicDocs */ export interface DeliveryCartInstructions { /** - * Indicates whether a buyer can select a custom address. - * - * When true, this implies extensions can update the delivery address. + * Whether the shipping address can be modified using + * `applyShippingAddressChange()`. When `false`, the buyer is using an + * accelerated checkout flow (Apple Pay, Google Pay) where the address + * can't be changed. */ canSelectCustomAddress: boolean; } +/** @publicDocs */ export interface DiscountsCartInstructions { /** - * Indicates whether or not discount codes can be updated. + * Whether discount codes can be updated using `applyDiscountCodeChange()`. + * When `false`, the checkout configuration doesn't allow discount code + * changes. Even when `true`, calls to `applyDiscountCodeChange()` can + * still fail during accelerated checkout (Apple Pay, Google Pay). */ canUpdateDiscountCodes: boolean; } +/** @publicDocs */ export interface CartLinesCartInstructions { /** - * Indicates whether or not new cart lines can be added. + * Whether new cart lines can be added using `applyCartLinesChange()`. When + * `false`, the checkout configuration doesn't allow adding lines (for + * example, draft orders). Even when `true`, calls can still fail during + * accelerated checkout (Apple Pay, Google Pay). */ canAddCartLine: boolean; /** - * Indicates whether or not cart lines can be removed. + * Whether cart lines can be removed using `applyCartLinesChange()`. When + * `false`, the checkout configuration doesn't allow removing lines. + * Even when `true`, calls can still fail during accelerated checkout. */ canRemoveCartLine: boolean; /** - * Indicates whether or not cart lines can be updated. + * Whether cart lines can be updated using `applyCartLinesChange()`. When + * `false`, the checkout configuration doesn't allow updating lines. + * Even when `true`, calls can still fail during accelerated checkout. */ canUpdateCartLine: boolean; } +/** @publicDocs */ export interface MetafieldsCartInstructions { /** - * Indicates whether or not cart metafields can be added or updated. + * Whether the extension can add or update cart metafields using + * `applyMetafieldChange()`. */ canSetCartMetafields: boolean; /** - * Indicates whether or not cart metafields can be deleted. + * Whether the extension can delete cart metafields using + * `applyMetafieldChange()`. */ canDeleteCartMetafield: boolean; } +/** @publicDocs */ export interface NotesCartInstructions { /** - * Indicates whether or not notes can be updated. + * Whether the order note can be updated using `applyNoteChange()`. When + * `false`, the checkout configuration doesn't allow note changes. Even + * when `true`, calls to `applyNoteChange()` can still fail during + * accelerated checkout (Apple Pay, Google Pay). */ canUpdateNote: boolean; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Abbreviation.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Abbreviation.d.ts index 94eb15b559..a5b4350d49 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Abbreviation.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Abbreviation.d.ts @@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-abbreviation"; +/** @publicDocs */ export interface AbbreviationElementProps extends Pick { } export interface AbbreviationElement extends AbbreviationElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Abbreviation/Abbreviation.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Abbreviation/Abbreviation.doc.ts deleted file mode 100644 index 4e796f7055..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Abbreviation/Abbreviation.doc.ts +++ /dev/null @@ -1,13 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Abbreviation'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: { - properties: true, - }, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Announcement.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Announcement.d.ts index 68493595b7..fc4f8c1e1a 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Announcement.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Announcement.d.ts @@ -24,50 +24,68 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; +/** + * The visibility state of a toggleable element. + * + * - `open`: The element is visible and showing its content. + * - `closed`: The element is hidden and its content is not visible. + */ export type ToggleState = 'open' | 'closed'; +/** + * The event data provided to toggle-related callbacks. Contains the previous and next visibility states of the element. + */ export interface ToggleArgumentsEvent { + /** + * The visibility state of the element before the toggle occurred. + */ oldState?: ToggleState; + /** + * The visibility state of the element after the toggle occurred. + */ newState?: ToggleState; } declare const tagName = "s-announcement"; export interface AnnouncementEvents extends Pick { } +/** @publicDocs */ export interface AnnouncementElementEvents { /** - * Callback fired when the element state changes **after** any animations have finished. + * A callback that fires when the element state changes, after any toggle animations have finished. * * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState). */ aftertoggle?: CallbackEventListener; /** - * Callback fired when the announcement is dismissed by the user - * (either via the built-in dismiss button or programmatically). + * A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically. */ dismiss?: CallbackEventListener; /** - * Callback straight after the element state changes. + * A callback that fires immediately when the element state changes, before any animations. * * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. - * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the + * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState). */ toggle?: CallbackEventListener; } @@ -79,9 +97,16 @@ export interface AnnouncementElement extends AnnouncementMethods, Omit void; } +/** @publicDocs */ export interface AnnouncementElementMethods { + /** + * Programmatically dismisses the announcement. This triggers the `dismiss` event callback. + */ dismiss: AnnouncementMethods['dismiss']; } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Announcement/Announcement.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Announcement/Announcement.doc.ts deleted file mode 100644 index 95fbdf921d..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Announcement/Announcement.doc.ts +++ /dev/null @@ -1,17 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Announcement'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: { - events: true, - methods: true, - }, - bestPractices: `- Prioritize the default state: The most effective use of the announcement bar is when content is short enough to display entirely in its default state, with no need for expansion. This provides the best user experience. -- Handle content truncation: The component has a strict maximum height. Content that exceeds the expanded state’s height will be cut off with no scrolling capability. Ensure your application’s logic handles excessively long content gracefully to prevent truncation. -- Provide a modal alternative: If your application needs to display more than a few lines of content, avoid cramming it into the announcement bar. Instead, use the bar as a teaser that links to a modal. This is the recommended pattern for displaying surveys, detailed offers, or other longer-form content.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Badge.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Badge.d.ts index bf1771db80..63f570f24b 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Badge.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Badge.d.ts @@ -25,19 +25,60 @@ export interface BaseElementPropsWithChildren extends Base children?: preact.ComponentChildren; } /** - * Used as the single source of truth for checkout icon types. - * - * @see https://github.com/Shopify/ui-api-design/blob/main/packages/ui-api-design/src/components/Icon/Icon.ts#L10 + * The available icon types for checkout components. This is the single source of truth for checkout icon names. */ declare const CHECKOUT_AVAILABLE_ICONS: readonly ["alert-circle", "alert-triangle-filled", "alert-triangle", "arrow-down", "arrow-left", "arrow-right", "arrow-up-right", "arrow-up", "bag", "bullet", "calendar", "camera", "caret-down", "cart", "cash-dollar", "categories", "check-circle", "check-circle-filled", "check", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "circle", "clipboard", "clock", "credit-card", "delete", "delivered", "delivery", "disabled", "discount", "edit", "email", "empty", "external", "filter", "geolocation", "gift-card", "globe", "grid", "image", "info-filled", "info", "list-bulleted", "location", "lock", "map", "menu-horizontal", "menu-vertical", "menu", "minus", "mobile", "note", "order", "organization", "plus", "profile", "question-circle-filled", "question-circle", "reorder", "reset", "return", "savings", "search", "settings", "star-filled", "star-half", "star", "store", "truck", "upload", "x-circle-filled", "x-circle", "x"]; +/** + * The subset of icon types available in checkout and customer account surfaces. This is a narrowed set from the full Shopify icon library, containing only the icons supported in these contexts. + * @publicDocs + */ export type ReducedIconTypes = (typeof CHECKOUT_AVAILABLE_ICONS)[number]; declare const tagName = "s-badge"; +/** @publicDocs */ export interface BadgeElementProps extends Pick { + /** + * The size of the badge. + * + * - `base`: The default size, suitable for most use cases. + * - `small`: A smaller badge for compact layouts. + * - `small-100`: The smallest badge for tight spaces or dense lists. + * + * @default 'base' + */ size?: Extract; + /** + * The semantic meaning and color treatment of the badge. + * + * - `auto`: Automatically determined based on context. + * - `neutral`: General information without specific intent. + * - `critical`: Urgent problems or destructive actions. + * + * @default 'auto' + */ tone?: Extract; + /** + * Controls the visual weight and emphasis of the badge. + * + * - `base`: Standard weight with moderate emphasis, suitable for most use cases. + * - `subdued`: Reduced visual weight for less prominent or secondary badges. + * + * @default 'base' + */ color?: Extract; + /** + * An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon. + * + * @default '' + */ icon?: '' | ReducedIconTypes; + /** + * The position of the icon relative to the badge text. + * + * - `start`: Places the icon before the text. + * - `end`: Places the icon after the text. + */ + iconPosition?: BadgeProps$1['iconPosition']; } export interface BadgeElement extends BadgeElementProps, Omit { } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Badge/Badge.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Badge/Badge.doc.ts deleted file mode 100644 index 6b6c117b17..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Badge/Badge.doc.ts +++ /dev/null @@ -1,13 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Badge'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: { - properties: true, - }, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Banner.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Banner.d.ts index 4afd7c2596..deb9acad48 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Banner.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Banner.d.ts @@ -24,36 +24,87 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-banner"; +/** @publicDocs */ export interface BannerElementProps extends Pick { + /** + * Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them. + * + * @default false + */ + collapsible?: BannerProps$1['collapsible']; + /** + * Whether the banner displays a close button that allows users to dismiss it. + * + * When the close button is pressed, the `dismiss` event will fire, + * then `hidden` will be set to `true`, + * any animation will complete, + * and the `afterhide` event will fire. + * + * @default false + */ + dismissible?: BannerProps$1['dismissible']; + /** + * The heading text displayed at the top of the banner to summarize the message or alert. + * + * @default '' + */ + heading?: BannerProps$1['heading']; + /** + * Controls whether the banner is visible or hidden. + * + * When using a controlled component pattern and the banner is `dismissible`, + * update this property to `true` when the `dismiss` event fires. + * + * You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`. + * + * @default false + */ + hidden?: BannerProps$1['hidden']; + /** + * The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected. + * + * - `info`: Informational content or helpful tips. + * - `auto`: Automatically determined based on context. + * - `success`: Positive outcomes or successful states. + * - `warning`: Important warnings about potential issues. + * - `critical`: Urgent problems or destructive actions. + * + * The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `info`, `success`, and `warning` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message. + * + * @default 'auto' + */ tone?: Extract; } export interface BannerEvents extends Pick { } +/** @publicDocs */ export interface BannerElementEvents { /** - * Event handler when the banner has fully hidden. - * - * The `hidden` property will be `true` when this event fires. + * A callback that fires when the banner has fully hidden, including after any hide animations have completed. * - * @implementation If implementations animate the hiding of the banner, - * this event must fire after the banner has fully hidden. - * We can add an `onHide` event in future if we want to provide a hook for the start of the animation. + * The `hidden` property is `true` when this event fires. */ afterhide?: CallbackEventListener; /** - * Event handler when the banner is dismissed by the user. + * A callback that fires when the banner is dismissed by the user clicking the close button. * - * This does not fire when setting `hidden` manually. + * This doesn't fire when setting `hidden` manually. * - * The `hidden` property will be `false` when this event fires. + * The `hidden` property is `false` when this event fires. */ dismiss?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Banner/Banner.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Banner/Banner.doc.ts deleted file mode 100644 index 88242fd041..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Banner/Banner.doc.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Banner'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: { - properties: true, - events: true, - }, - bestPractices: - '- Use banners thoughtfully and sparingly, and only for the most important information. Too many banners distract customers from completing checkout.\n\n- Banners are typically displayed at the top of a page or a section, if they relate to specific content. Place banners below the relevant page or section header.\n\n- Include a Button component with next steps when possible.\n\n- Make banners dismissible, unless they contain critical information or an important step that customers need to take.\n\n- Use the `info` banner to update customers about a change or to give them advice.\n\n- Use the `warning` banner to display information that needs attention or that customers need to take action on. Warning banners can be stressful for customers, so be cautious about using them.\n\n- Use the `critical` banner to communicate problems that customers need to resolve immediately to complete checkout.', -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Box.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Box.d.ts index 3593d478cb..8930b81f6d 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Box.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Box.d.ts @@ -10,8 +10,25 @@ /// import type {BoxProps$1,MaybeAllValuesShorthandProperty,BorderSizeKeyword, BorderStyleKeyword,ColorKeyword} from './components-shared.d.ts'; +/** + * The subset of border size values available for this component. + * + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `large-200`: The thickest available border. + * - `none`: No border. + */ export type ReducedBorderSizeKeyword = Extract; +/** + * The subset of border color values available for this component. + * + * - `base`: The standard border color for most contexts. + */ export type ReducedColorKeyword = Extract; +/** + * A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults. + */ export type BorderShorthand = ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`; /** * Used when an element does not have children. @@ -29,10 +46,43 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-box"; +/** @publicDocs */ export interface BoxElementProps extends Pick { + /** + * The background color of the box. + * + * - `base`: The standard background color for general content areas. + * - `subdued`: A muted background for secondary or supporting content. + * - `transparent`: No background color (the default). + * + * @default 'transparent' + */ background?: Extract; + /** + * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here. + * + * @default 'none' + */ border?: BorderShorthand; + /** + * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`. + * + * @default '' - meaning no override + */ borderWidth?: MaybeAllValuesShorthandProperty | ''; + /** + * The roundedness of the box's corners. + * + * - `none`: Sharp corners with no rounding. + * - `small-100` / `small`: Subtle rounding for compact elements. + * - `base`: Standard rounding for most use cases. + * - `large` / `large-100`: More pronounced rounding for prominent containers. + * - `max`: Maximum rounding, creating a pill or circular shape. + * + * Supports 1-to-4-value shorthand syntax for specifying different radii per corner. + * + * @default 'none' + */ borderRadius?: MaybeAllValuesShorthandProperty>; } export interface BoxElement extends BoxElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Box/Box.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Box/Box.doc.ts deleted file mode 100644 index 7cfbcffab4..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Box/Box.doc.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Box'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: { - properties: true, - }, - bestPractices: ` -- Use \`s-box\` when you need a container that preserves the natural size of its contents. -- \`s-box\` is particularly useful in layout components like \`s-stack\` where you want to prevent children from stretching to fit. -- \`s-box\` has a \`display: block\` layout by default. -- Use \`s-box\` for simple container needs where you don't need the additional features of more specialized components like \`s-stack\`. -- Consider using \`s-box\` when you need to apply specific styling or layout properties to a group of elements without affecting their natural dimensions.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Button.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Button.d.ts index a9031b4e9c..b42293388c 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Button.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Button.d.ts @@ -24,28 +24,45 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-button"; +/** @publicDocs */ export interface ButtonElementProps extends Pick { target?: Extract; tone?: Extract; + /** + * The behavioral type of the button component, which determines what action it performs when activated. + * + * - `submit`: Submits the nearest containing form. + * - `button`: Performs no default action, relying on the `click` event handler for behavior. + * + * This property is ignored if `href` or `commandFor`/`command` is set. + * + * @default 'button' + */ type?: Extract; variant?: Extract; } export interface ButtonEvents extends Pick { } +/** @publicDocs */ export interface ButtonElementEvents { /** - * Callback when the button is activated. - * This will be called before the action indicated by `type`. + * A callback fired when the button is clicked. This will be called before the action indicated by `type`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event + * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event). */ click?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Button/Button.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Button/Button.doc.ts deleted file mode 100644 index cd3748c97f..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Button/Button.doc.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Button'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: { - properties: true, - events: true, - }, - bestPractices: - '**Content Best Practices**\n\n- Clearly label each button to accurately represent the action associated with it.\n\n- Use strong actionable verbs at the beginning of button text to make it clear to the user what action will occur when the button is clicked.\n\n**Hierarchy Best Practices**\n\n- Establish a visual hierarchy between buttons to minimize confusion and help users understand which actions are most important.\n\n- Use only one high-emphasis button (primary button) per context to make it clear that other buttons have less importance.\n\n- Use lower-emphasis buttons for secondary calls to action.\n\n- Use primary buttons for actions that progress users through checkout such as “Pay now” or for concluding an action in a modal such as “Apply”.\n\n- Use secondary buttons to provide alternative actions to the primary button, without disrupting the primary flow such as “Track your order”.\n\n**When to Use Buttons**\n\n- Use buttons to communicate actions the user can take.\n\n- Use buttons to allow users to interact with the page.\n\n**When Not to Use Buttons**\n\n- Don’t use buttons as navigational elements. Use links instead when the desired action is to take the user to a new page.', -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Chat.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Chat.d.ts new file mode 100644 index 0000000000..694c0e05c8 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/checkout/components/Chat.d.ts @@ -0,0 +1,118 @@ +/** VERSION: 0.0.0 **/ +/* eslint-disable import-x/extensions */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable @typescript-eslint/member-ordering */ +/* eslint-disable line-comment-position */ +/* eslint-disable @typescript-eslint/unified-signatures */ +/* eslint-disable no-var */ +/* eslint-disable import-x/namespace */ +// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment +/// +import type {ChatProps$1} from './components-shared.d.ts'; + +/** + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. + */ +export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. This is used by the rendering engine for efficient reconciliation when lists change. + */ + key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ + ref?: preact.Ref; + /** + * Assigns the element to a named slot in a parent component that uses slot-based composition patterns. + */ + slot?: Lowercase; +} +/** + * The base properties for elements that have children, extending `BaseElementProps` with children support. + * @publicDocs + */ +export interface BaseElementPropsWithChildren extends BaseElementProps { + /** + * The child elements to render within this component. + */ + children?: preact.ComponentChildren; +} +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + * @publicDocs + */ +export type CallbackEvent = TEvent & { + currentTarget: HTMLElementTagNameMap[TTagName]; +}; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + * @publicDocs + */ +export type CallbackEventListener = (EventListener & ((event: CallbackEvent & TData) => void)) | null; + +declare const tagName = "s-chat"; +/** @publicDocs */ +export interface ChatElementProps extends Pick { + /** + * A label that describes the purpose of the chat, announced by assistive technologies like screen readers. + */ + accessibilityLabel?: ChatProps$1['accessibilityLabel']; + /** + * Adjust the block size. + * + * Checkout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered. + * + * Learn more about [block size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). + */ + blockSize?: Extract; + /** + * Adjust the inline size. + * + * Checkout imposes [sizing restrictions](/docs/apps/build/checkout/chat#component-states) for the component, therefore the size set may not be the actual size rendered. + * + * Learn more about [inline size on MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size). + */ + inlineSize?: Extract; +} +/** + * The event callbacks for monitoring the chat lifecycle. + */ +export interface ChatEvents extends Pick { +} +/** @publicDocs */ +export interface ChatElementEvents { + /** + * A callback that fires when the embedded page is ready and a message port has been created to communicate with the host page. + */ + ready?: CallbackEventListener; +} +/** @publicDocs */ +export interface ChatElementMethods { + /** + * Returns an object exposing a `postMessage` method used to send messages to the embedded page rendered inside the chat iframe. Pair this with the `ready` event (or `onReady` callback) to know when the message channel is available. + */ + readonly contentWindow: { + postMessage(message: any): void; + }; +} +/** @publicDocs */ +export interface ChatElement extends ChatElementProps, ChatElementMethods, Omit { + onready: ChatEvents['onReady']; +} +/** @publicDocs */ +export interface ChatProps extends ChatElementProps, ChatEvents { +} +declare global { + interface HTMLElementTagNameMap { + [tagName]: ChatElement; + } +} +declare module 'preact' { + namespace createElement.JSX { + interface IntrinsicElements { + [tagName]: ChatProps & BaseElementPropsWithChildren; + } + } +} + +export type { ChatElement, ChatElementEvents, ChatElementMethods, ChatElementProps, ChatProps }; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Checkbox.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Checkbox.d.ts index 91c77f38c5..6bf4c3e067 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Checkbox.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Checkbox.d.ts @@ -11,37 +11,70 @@ import type {CheckboxProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. This is used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns the element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-checkbox"; -export interface CheckboxElementProps extends Pick { +/** @publicDocs */ +export interface CheckboxElementProps extends Pick { command?: Extract; + /** + * The visual content to use as the control label. Use a string to provide a simple text label displayed to the user. + * + * If a `label` slot is also provided, the slot content takes precedence. [Learn more about slots](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox#slots-propertydetail-label). + */ + label?: string; } export interface CheckboxEvents extends Pick { } +/** @publicDocs */ export interface CheckboxElementEvents { /** - * A callback that is run whenever the control is changed. + * A callback fired when the checkbox value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; } export interface CheckboxElement extends CheckboxElementProps, Omit { onchange: CheckboxEvents['onChange']; } +/** @publicDocs */ +export interface CheckboxElementSlots { + /** + * The visual content to use as the control label. + * + * Use an `HTMLElement` as a rich control label composed of elements. Only an `s-text` element is supported with plain text and `s-link` as its only allowed children. Any other elements are stripped while preserving their text content. + */ + label?: HTMLElement; +} +/** @publicDocs */ export interface CheckboxProps extends CheckboxElementProps, CheckboxEvents { } declare global { @@ -57,4 +90,4 @@ declare module 'preact' { } } -export type { CheckboxElement, CheckboxElementEvents, CheckboxElementProps, CheckboxEvents, CheckboxProps }; +export type { CheckboxElement, CheckboxElementEvents, CheckboxElementProps, CheckboxElementSlots, CheckboxEvents, CheckboxProps }; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Checkbox/Checkbox.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Checkbox/Checkbox.doc.ts deleted file mode 100644 index 35b48a36b7..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Checkbox/Checkbox.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Checkbox'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Chip.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Chip.d.ts index 405f8f7515..55b4321f95 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Chip.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Chip.d.ts @@ -26,13 +26,13 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-chip"; +/** @publicDocs */ export interface ChipElementProps extends Pick { } +/** @publicDocs */ export interface ChipElementSlots { /** - * The graphic to display inside of the chip. - * - * Only `s-icon` element and its `type` attribute are supported. + * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported. */ graphic?: HTMLElement; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Chip/Chip.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Chip/Chip.doc.ts deleted file mode 100644 index 348d16fb9b..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Chip/Chip.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Chip'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, slots: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Choice.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Choice.d.ts index c56b0cbc01..ea6e8ba7b5 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Choice.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Choice.d.ts @@ -26,8 +26,10 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-choice"; +/** @publicDocs */ export interface ChoiceElementProps extends Pick { } +/** @publicDocs */ export interface ChoiceElementSlots { /** * Additional text to provide context or guidance for the input. diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ChoiceList.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/ChoiceList.d.ts index 896808e834..133db74b77 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/ChoiceList.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/ChoiceList.d.ts @@ -24,23 +24,31 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-choice-list"; +/** @publicDocs */ export interface ChoiceListElementProps extends Pick { } export interface ChoiceListEvents extends Pick { } +/** @publicDocs */ export interface ChoiceListElementEvents { /** - * A callback that is run whenever the control is changed. + * A callback fired when the choice list value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ChoiceList/ChoiceList.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/ChoiceList/ChoiceList.doc.ts deleted file mode 100644 index 8398cd873a..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/ChoiceList/ChoiceList.doc.ts +++ /dev/null @@ -1,97 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/ChoiceList'; -import choiceSharedContent from '../../../../docs/shared/components/Choice'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, - subcomponent: { - ...choiceSharedContent, - definitions: {properties: true, slots: true}, - }, - extraExamples: { - description: `The \`ChoiceList\` component offers different variants to suit various use cases. Choose the right variant based on the number of choices, the complexity of the content, and the available screen space. Below are some best practices for each variant.`, - examples: [ - { - description: `This classic and flexible variant is ideal for up to 10 choices. It’s the most common and recognizable format for making a selection from a vertical list. - -Best Practices -

    -
  • Keep it simple: Keep the initial content for each item as concise as possible so users can quickly scan and compare their choices.
  • -
  • Add extra content strategically: Only use the "selected content" slot if the information is essential and directly tied to the selected item. For example, a map that shows the location of a chosen address is an effective use case. If the content doesn’t need to be in close proximity to the selected item, place it elsewhere on the page to reduce visual clutter.
  • -
`, - codeblock: { - title: 'List Variant', - tabs: [ - { - code: './examples/list-choice-variant.example.html', - language: 'html', - }, - ], - }, - image: 'choicelist-list-variant.png', - }, - { - description: `This variant is designed for options that require both secondary content and a clear visual separation. It’s well-suited for up to 5 choices where each item is complex and needs its own defined space. Due to its "chunky" footprint, using more than 5 can take up too much vertical space. - -Best Practices -
    -
  • Focus on clarity: Use this variant to help users compare options with more complexity than a simple list, such as an item with a title, a description, and a price.
  • -
  • Be intentional with extra content: Just like the List variant, only include extra content when it’s crucial for the user to make a final decision and when its close proximity to the selected block is a benefit.
  • -
`, - codeblock: { - title: 'Block Variant', - tabs: [ - { - code: './examples/block-choice-variant.example.html', - language: 'html', - }, - ], - }, - image: 'choicelist-block-variant.png', - }, - { - description: `This compact variant is ideal when screen real estate is limited. It works best for up to 3 to 5 choices depending on the typical length of the content. - -Best Practices -
    -
  • Keep content short and simple: Due to its horizontal layout, content for each item must be succinct, simple, and short, especially on mobile.
  • -
  • Avoid extra content: This variant does not support extra content upon selection, so it’s best for a scenario where the user's decision doesn’t require additional information.
  • -
`, - codeblock: { - title: 'Inline Variant', - tabs: [ - { - code: './examples/inline-choice-variant.example.html', - language: 'html', - }, - ], - }, - image: 'choicelist-inline-variant.png', - }, - { - description: `This variant is best for up to 6 choices, arranged in a grid-like layout. It’s great for scenarios where choices have significant visual differences and need to be arranged for easy comparison. - -Best Practices -
    -
  • Keep content short and simple: The content in each item needs to be succinct and simple because the horizontal and vertical constraints of the grid can limit the available space.
  • -
  • Avoid extra content: This variant does not support extra content upon selection, so it’s best for a scenario where the user's decision doesn’t require additional information.
  • -
`, - codeblock: { - title: 'Grid Variant', - tabs: [ - { - code: './examples/grid-choice-variant.example.html', - language: 'html', - }, - ], - }, - image: 'choicelist-grid-variant.png', - }, - ], - }, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Clickable.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Clickable.d.ts index a0cbd434c5..6c405e161a 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Clickable.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Clickable.d.ts @@ -10,8 +10,25 @@ /// import type {ClickableProps$1,BorderSizeKeyword, BorderStyleKeyword,ColorKeyword,MaybeAllValuesShorthandProperty} from './components-shared.d.ts'; +/** + * The subset of border size values available for this component. + * + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `large-200`: The thickest available border. + * - `none`: No border. + */ export type ReducedBorderSizeKeyword = Extract; +/** + * The subset of border color values available for this component. + * + * - `base`: The standard border color for most contexts. + */ export type ReducedColorKeyword = Extract; +/** + * A shorthand type for specifying border properties. Accepts a border size, or a combination of size and color, or size, color, and style. + */ export type BorderShorthand = ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`; /** * Used when an element does not have children. @@ -27,42 +44,59 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-clickable"; +/** @publicDocs */ export interface ClickableElementProps extends Pick { background?: Extract; border?: BorderShorthand; borderWidth?: MaybeAllValuesShorthandProperty | ''; borderRadius?: MaybeAllValuesShorthandProperty>; target?: Extract; + /** + * The behavioral type of the clickable component, which determines what action it performs when activated. + * + * - `submit`: Submits the nearest containing form. + * - `button`: Performs no default action, relying on the `click` event handler for behavior. + * + * This property is ignored if `href` or `commandFor`/`command` is set. + * + * @default 'button' + */ type?: Extract; } export interface ClickableEvents extends Pick { } +/** @publicDocs */ export interface ClickableElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the component loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the button is activated. - * This will be called before the action indicated by `type`. + * A callback fired when the component is clicked. This will be called before the action indicated by `type`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event + * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event). */ click?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the component receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Clickable/Clickable.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Clickable/Clickable.doc.ts deleted file mode 100644 index 78ece2a01a..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Clickable/Clickable.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Clickable'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ClickableChip.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/ClickableChip.d.ts index d429ffd01b..e11bb9ec92 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/ClickableChip.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/ClickableChip.d.ts @@ -24,39 +24,46 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-clickable-chip"; +/** @publicDocs */ export interface ClickableChipElementProps extends Pick { } export interface ClickableChipEvents extends Pick { } +/** @publicDocs */ export interface ClickableChipElementEvents { /** - * Event handler when the chip has fully hidden. - * - * The `hidden` property will be `true` when this event fires. + * A callback fired after the chip is hidden. The `hidden` property will be `true` when this event fires. */ afterhide?: CallbackEventListener; /** - * Event handler when the chip is clicked. + * A callback fired when the chip is clicked. + * + * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event). */ click?: CallbackEventListener; /** - * Event handler when the chip is removed. + * A callback fired when the chip is removed. */ remove?: CallbackEventListener; } +/** @publicDocs */ export interface ClickableChipElementSlots { /** - * The graphic to display inside of the chip. - * - * Only `s-icon` element and its `type` attribute are supported. + * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. Only the `s-icon` element and its `type` attribute are supported. */ graphic?: HTMLElement; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ClickableChip/ClickableChip.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/ClickableChip/ClickableChip.doc.ts deleted file mode 100644 index b090055643..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/ClickableChip/ClickableChip.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/ClickableChip'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true, slots: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ClipboardItem.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/ClipboardItem.d.ts index e8e3fabc54..9c840293bf 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/ClipboardItem.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/ClipboardItem.d.ts @@ -18,25 +18,33 @@ export interface BaseElementProps { ref?: preact.Ref; slot?: Lowercase; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-clipboard-item"; +/** @publicDocs */ export interface ClipboardItemElementProps extends Pick { } export interface ClipboardItemEvents extends Pick { } +/** @publicDocs */ export interface ClipboardItemElementEvents { /** - * Callback run when the copy to clipboard succeeds. + * A callback fired when the text is successfully copied to the clipboard. Use this to show a confirmation message or update the UI. */ copy?: CallbackEventListener; /** - * Callback run when the copy to clipboard fails. + * A callback fired when the copy to clipboard fails. Use this to display an error message or provide a fallback action. */ copyerror?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ClipboardItem/ClipboardItem.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/ClipboardItem/ClipboardItem.doc.ts deleted file mode 100644 index 4195ea0523..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/ClipboardItem/ClipboardItem.doc.ts +++ /dev/null @@ -1,12 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/ClipboardItem'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - isVisualComponent: false, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ConsentCheckbox.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/ConsentCheckbox.d.ts index 219ca87de0..a329a6affa 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/ConsentCheckbox.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/ConsentCheckbox.d.ts @@ -18,9 +18,15 @@ export interface BaseElementProps { ref?: preact.Ref; slot?: Lowercase; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; @@ -50,16 +56,24 @@ declare module 'preact' { } declare const tagName = "s-consent-checkbox"; +/** @publicDocs */ export interface ConsentCheckboxElementProps extends Pick { command?: Extract; + /** + * The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested. + * + * - `sms-marketing`: Represents the policy for SMS marketing consent. + */ + policy?: ConsentCheckboxProps$1['policy']; } export interface ConsentCheckboxEvents extends Pick { } +/** @publicDocs */ export interface ConsentCheckboxElementEvents { /** - * A callback that is run whenever the control is changed. + * A callback fired when the consent checkbox value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ConsentCheckbox/ConsentCheckbox.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/ConsentCheckbox/ConsentCheckbox.doc.ts deleted file mode 100644 index 9dc4f9b302..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/ConsentCheckbox/ConsentCheckbox.doc.ts +++ /dev/null @@ -1,13 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/ConsentCheckbox'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - requires: - 'enabling of the `sms_marketing` capability of the [Customer Privacy](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) capability group to work.', - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ConsentPhoneField.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/ConsentPhoneField.d.ts index 87e2f03902..22008e75f7 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/ConsentPhoneField.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/ConsentPhoneField.d.ts @@ -24,9 +24,15 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; @@ -63,38 +69,46 @@ declare module 'preact' { } declare const tagName = "s-consent-phone-field"; +/** @publicDocs */ export interface ConsentPhoneFieldElementProps extends Pick { /** * @deprecated Use `label` instead. * @private */ placeholder?: string; + /** + * The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested. + * + * - `sms-marketing`: Represents the policy for SMS marketing consent. + */ + policy?: ConsentPhoneFieldProps$1['policy']; } export interface ConsentPhoneFieldEvents extends Pick { } +/** @publicDocs */ export interface ConsentPhoneFieldElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the consent phone field loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the consent phone field value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the consent phone field receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the consent phone field. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; } @@ -104,10 +118,10 @@ export interface ConsentPhoneFieldElement extends ConsentPhoneFieldElementProps, onfocus: ConsentPhoneFieldEvents['onFocus']; oninput: ConsentPhoneFieldEvents['onInput']; } +/** @publicDocs */ export interface ConsentPhoneFieldElementSlots { /** - * Additional content to be displayed in the field. - * Commonly used to display an icon that activates a tooltip providing more information. + * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported. */ accessory?: HTMLElement; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ConsentPhoneField/ConsentPhoneField.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/ConsentPhoneField/ConsentPhoneField.doc.ts deleted file mode 100644 index 35d31ac2fc..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/ConsentPhoneField/ConsentPhoneField.doc.ts +++ /dev/null @@ -1,13 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/ConsentPhoneField'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - requires: - 'enabling of the `sms_marketing` capability of the [Customer Privacy](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) capability group to work.', - definitions: {properties: true, events: true, slots: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/DateField.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/DateField.d.ts index 9a9b3676fd..ee98259fb1 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/DateField.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/DateField.d.ts @@ -18,14 +18,21 @@ export interface BaseElementProps { ref?: preact.Ref; slot?: Lowercase; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-date-field"; +/** @publicDocs */ export interface DateFieldElementProps extends Pick { /** * @deprecated Use `label` instead. @@ -35,29 +42,40 @@ export interface DateFieldElementProps extends Pick { } +/** @publicDocs */ export interface DateFieldElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the date field loses focus. + * + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the date field value changes. + * + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the date field receives focus. + * + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the date field. + * + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; /** - * Callback when the user enters an invalid date. + * A callback fired when the date field value is invalid. + * + * Learn more about the [invalid event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/invalid_event). */ invalid?: CallbackEventListener; /** - * Callback when the view changes. + * A callback fired when the calendar view changes, such as when navigating between months. */ viewChange?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/DateField/DateField.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/DateField/DateField.doc.ts deleted file mode 100644 index a5d66d0205..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/DateField/DateField.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/DateField'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/DatePicker.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/DatePicker.d.ts index dd40ce4d77..64089fddf8 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/DatePicker.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/DatePicker.d.ts @@ -18,37 +18,53 @@ export interface BaseElementProps { ref?: preact.Ref; slot?: Lowercase; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-date-picker"; +/** @publicDocs */ export interface DatePickerElementProps extends Pick { } export interface DatePickerEvents extends Pick { } +/** @publicDocs */ export interface DatePickerElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the date picker loses focus. + * + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the date picker value changes. + * + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the date picker receives focus. + * + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the date picker. + * + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; /** - * Callback when the view changes. + * A callback fired when the calendar view changes, such as when navigating between months. */ viewChange?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/DatePicker/DatePicker.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/DatePicker/DatePicker.doc.ts deleted file mode 100644 index 8701b6aed6..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/DatePicker/DatePicker.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/DatePicker'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Details.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Details.d.ts index 8d0540530f..3bf457029e 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Details.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Details.d.ts @@ -24,9 +24,15 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; @@ -37,34 +43,33 @@ export interface ToggleArgumentsEvent { } declare const tagName = "s-details"; +/** @publicDocs */ export interface DetailsElementProps extends Pick { } export interface DetailsEvents extends Pick { } +/** @publicDocs */ export interface DetailsElementEvents { /** - * Callback straight after the element state changes. + * A callback fired immediately when the element state changes, before any animations. * * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. - * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the + * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and the [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState). */ toggle?: CallbackEventListener; /** - * Callback fired when the element state changes **after** any animations have finished. + * A callback fired when the element state changes, after any toggle animations have finished. * * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties. */ aftertoggle?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Details/Details.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Details/Details.doc.ts deleted file mode 100644 index 56cca58a4a..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Details/Details.doc.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Details'; -import summarySharedContent from '../../../../docs/shared/components/Summary'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, - subcomponent: { - ...summarySharedContent, - definitions: {properties: true}, - }, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Divider.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Divider.d.ts index 8bbabadf6b..062b5aaf75 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Divider.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Divider.d.ts @@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-divider"; +/** @publicDocs */ export interface DividerElementProps extends Pick { } export interface DividerElement extends DividerElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Divider/Divider.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Divider/Divider.doc.ts deleted file mode 100644 index 6708444951..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Divider/Divider.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Divider'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/DropZone.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/DropZone.d.ts index 3da1012e8d..1742f85f5d 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/DropZone.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/DropZone.d.ts @@ -18,29 +18,41 @@ export interface BaseElementProps { ref?: preact.Ref; slot?: Lowercase; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-drop-zone"; +/** @publicDocs */ export interface DropZoneElementProps extends Pick { } export interface DropZoneEvents extends Pick { } +/** @publicDocs */ export interface DropZoneElementEvents { /** - * Callback when rejected files are dropped. Files are rejected based on the `accept` prop. + * A callback fired when files are rejected based on the `accept` prop. */ droprejected?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the drop zone. + * + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; /** - * Callback when the user has finished selecting a file or files. + * A callback fired when the drop zone value changes. + * + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/DropZone/DropZone.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/DropZone/DropZone.doc.ts deleted file mode 100644 index a896da8828..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/DropZone/DropZone.doc.ts +++ /dev/null @@ -1,29 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/DropZone'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - type: '', - definitions: {properties: true, events: true}, - bestPractices: ` -### File storage - -File storage for uploads must be implemented separately. Metafields and the corresponding [Checkout API](https://shopify.dev/docs/api/checkout-ui-extensions/latest/apis/metafields) or [Customer Accounts API](https://shopify.dev/docs/api/customer/latest/mutations/metafieldsSet) can be utilized to store references to files alongside the relevant objects. - -### Mobile - -Remember that the drag and drop feature won’t be effective on mobile devices. Adding a button can offer additional context and guide users through the next steps. - -An example showing DropZone with custom content optimized for mobile devices - -### Minimum size - -To prevent cut-off text and spacing issues, the minimum size of a Dropzone should be 100px by 100px. - -An example showing DropZone with correct minimum size - `, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/EmailField.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/EmailField.d.ts index eefee2d12f..06cba3207d 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/EmailField.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/EmailField.d.ts @@ -24,14 +24,21 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-email-field"; +/** @publicDocs */ export interface EmailFieldElementProps extends Pick { /** * @deprecated Use `label` instead. @@ -41,36 +48,37 @@ export interface EmailFieldElementProps extends Pick { } +/** @publicDocs */ export interface EmailFieldElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the email field loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the email field value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the email field receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the email field. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; } +/** @publicDocs */ export interface EmailFieldElementSlots { /** - * Additional content to be displayed in the field. - * Commonly used to display an icon that activates a tooltip providing more information. + * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported. */ accessory?: HTMLElement; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/EmailField/EmailField.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/EmailField/EmailField.doc.ts deleted file mode 100644 index f3bf7bc357..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/EmailField/EmailField.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/EmailField'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true, slots: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Form.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Form.d.ts index 9ea4bfdb01..fa23e1696a 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Form.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Form.d.ts @@ -24,14 +24,21 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-form"; +/** @publicDocs */ export interface FormElementProps extends Pick { } export interface FormEvents extends Pick { @@ -40,9 +47,10 @@ export interface FormEvents extends Pick { */ onSubmit?: () => void; } +/** @publicDocs */ export interface FormElementEvents { /** - * A callback that is run when the form is submitted. + * A callback fired when the form is submitted. */ submit?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Form/Form.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Form/Form.doc.ts deleted file mode 100644 index 1e606dff36..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Form/Form.doc.ts +++ /dev/null @@ -1,14 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Form'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, - bestPractices: ` -- Wrap around all form input elements. -- Forms can have only one submit button and it must be at the end of the form.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Grid.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Grid.d.ts index e37ceb519b..6610640338 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Grid.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Grid.d.ts @@ -10,12 +10,81 @@ /// import type {GridProps$1,MaybeResponsive, MaybeAllValuesShorthandProperty,BorderSizeKeyword, BorderStyleKeyword,AlignContentKeyword, AlignItemsKeyword, JustifyContentKeyword, JustifyItemsKeyword,ColorKeyword} from './components-shared.d.ts'; +/** + * The subset of `align-content` values available for the grid component. + * + * - `center`: Packs rows toward the center of the grid. + * - `start`: Packs rows toward the start of the block axis. + * - `end`: Packs rows toward the end of the block axis. + * - `normal`: Default browser behavior. + * - `space-between`: Distributes rows evenly with no space at the edges. + * - `space-around`: Distributes rows evenly with equal space around each. + * - `space-evenly`: Distributes rows with equal space between and at the edges. + * - `stretch`: Stretches rows to fill the available space. + * + * @publicDocs + */ export type ReducedAlignContentKeyword = Extract; +/** + * The subset of `align-items` values available for the grid component. + * + * - `center`: Centers items along the block axis. + * - `start`: Aligns items to the start of the block axis. + * - `end`: Aligns items to the end of the block axis. + * - `normal`: Default browser behavior. + * - `baseline`: Aligns items along their text baseline. + * - `stretch`: Stretches items to fill the cell along the block axis. + * + * @publicDocs + */ export type ReducedAlignItemsKeyword = Extract; +/** + * The subset of `justify-content` values available for the grid component. + * + * - `center`: Packs columns toward the center of the grid. + * - `start`: Packs columns toward the start of the inline axis. + * - `end`: Packs columns toward the end of the inline axis. + * - `normal`: Default browser behavior. + * - `space-between`: Distributes columns evenly with no space at the edges. + * - `space-around`: Distributes columns evenly with equal space around each. + * - `space-evenly`: Distributes columns with equal space between and at the edges. + * - `stretch`: Stretches columns to fill the available space. + * + * @publicDocs + */ export type ReducedJustifyContentKeyword = Extract; +/** + * The subset of `justify-items` values available for the grid component. + * + * - `center`: Centers items along the inline axis. + * - `start`: Aligns items to the start of the inline axis. + * - `end`: Aligns items to the end of the inline axis. + * - `normal`: Default browser behavior. + * - `baseline`: Aligns items along their text baseline. + * - `stretch`: Stretches items to fill the cell along the inline axis. + * + * @publicDocs + */ export type ReducedJustifyItemsKeyword = Extract; +/** + * The subset of border size values available for this component. + * + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `large-200`: The thickest available border. + * - `none`: No border. + */ export type ReducedBorderSizeKeyword = Extract; +/** + * The subset of border color values available for this component. + * + * - `base`: The standard border color for most contexts. + */ export type ReducedColorKeyword = Extract; +/** + * A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults. + */ export type BorderShorthand = ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`; /** * Used when an element does not have children. @@ -33,17 +102,85 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-grid"; +/** @publicDocs */ export interface GridElementProps extends Pick { + /** + * Controls how the grid's rows are distributed along the block (column) axis when there is extra space. Set to an empty string to use the default. + * + * @default '' - meaning no override + */ alignContent?: MaybeResponsive; + /** + * Aligns grid items along the block (column) axis. Set to an empty string to use the default. + * + * @default '' - meaning no override + */ alignItems?: MaybeResponsive; + /** + * The background color of the grid. + * + * - `base`: The standard background color for general content areas. + * - `subdued`: A muted background for secondary or supporting content. + * - `transparent`: No background color (the default). + * + * @default 'transparent' + */ background?: Extract; + /** + * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here. + * + * @default 'none' + */ border?: BorderShorthand; + /** + * The color of the border using the design system's color scale. Overrides the color value set by `border`. + * + * @default '' - meaning no override + */ borderColor?: ReducedColorKeyword | ''; + /** + * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`. + * + * @default '' - meaning no override + */ borderWidth?: MaybeAllValuesShorthandProperty | ''; + /** + * The roundedness of the grid's corners. + * + * - `none`: Sharp corners with no rounding. + * - `small-100` / `small`: Subtle rounding for compact elements. + * - `base`: Standard rounding for most use cases. + * - `large` / `large-100`: More pronounced rounding for prominent containers. + * - `max`: Maximum rounding, creating a pill or circular shape. + * + * Supports 1-to-4-value shorthand syntax for specifying different radii per corner. + * + * @default 'none' + */ borderRadius?: MaybeAllValuesShorthandProperty>; + /** + * Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Set to an empty string to use the default. + * + * @default '' - meaning no override + */ justifyContent?: MaybeResponsive; + /** + * Aligns grid items along the inline (row) axis. Set to an empty string to use the default. + * + * @default '' - meaning no override + */ justifyItems?: MaybeResponsive; + /** + * A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once. + * + * @default 'normal normal' + */ placeContent?: MaybeResponsive<`${ReducedAlignContentKeyword} ${ReducedJustifyContentKeyword}` | ReducedAlignContentKeyword>; + /** + * A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once. + * + * @default 'normal normal' + */ placeItems?: MaybeResponsive<`${ReducedAlignItemsKeyword} ${ReducedJustifyItemsKeyword}` | ReducedAlignItemsKeyword>; } export interface GridElement extends GridElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Grid/Grid.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Grid/Grid.doc.ts deleted file mode 100644 index 56f059569c..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Grid/Grid.doc.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Grid'; -import gridItemSharedContent from '../../../../docs/shared/components/GridItem'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - subcomponent: { - ...gridItemSharedContent, - definitions: {properties: true}, - }, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/GridItem.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/GridItem.d.ts index 78b2d3575e..c1df284ca8 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/GridItem.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/GridItem.d.ts @@ -10,8 +10,25 @@ /// import type {GridItemProps$1,BorderSizeKeyword, BorderStyleKeyword,ColorKeyword,MaybeAllValuesShorthandProperty} from './components-shared.d.ts'; +/** + * The subset of border size values available for this component. + * + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `large-200`: The thickest available border. + * - `none`: No border. + */ export type ReducedBorderSizeKeyword = Extract; +/** + * The subset of border color values available for this component. + * + * - `base`: The standard border color for most contexts. + */ export type ReducedColorKeyword = Extract; +/** + * A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults. + */ export type BorderShorthand = ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`; /** * Used when an element does not have children. @@ -29,11 +46,49 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-grid-item"; +/** @publicDocs */ export interface GridItemElementProps extends Pick { + /** + * The background color of the grid item. + * + * - `base`: The standard background color for general content areas. + * - `subdued`: A muted background for secondary or supporting content. + * - `transparent`: No background color (the default). + * + * @default 'transparent' + */ background?: Extract; + /** + * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here. + * + * @default 'none' + */ border?: BorderShorthand; + /** + * The color of the border using the design system's color scale. Overrides the color value set by `border`. + * + * @default '' - meaning no override + */ borderColor?: ReducedColorKeyword | ''; + /** + * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`. + * + * @default '' - meaning no override + */ borderWidth?: MaybeAllValuesShorthandProperty | ''; + /** + * The roundedness of the grid item's corners. + * + * - `none`: Sharp corners with no rounding. + * - `small-100` / `small`: Subtle rounding for compact elements. + * - `base`: Standard rounding for most use cases. + * - `large` / `large-100`: More pronounced rounding for prominent containers. + * - `max`: Maximum rounding, creating a pill or circular shape. + * + * Supports 1-to-4-value shorthand syntax for specifying different radii per corner. + * + * @default 'none' + */ borderRadius?: MaybeAllValuesShorthandProperty>; } export interface GridItemElement extends GridItemElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Heading.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Heading.d.ts index 6f495498e8..7b0c9d41d0 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Heading.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Heading.d.ts @@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-heading"; +/** @publicDocs */ export interface HeadingElementProps extends Pick { } export interface HeadingElement extends HeadingElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Heading/Heading.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Heading/Heading.doc.ts deleted file mode 100644 index 632f1f66fb..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Heading/Heading.doc.ts +++ /dev/null @@ -1,21 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Heading'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - usefulFor: `- Creating titles and subtitles for your content that are consistent across your app. -- Helping users with visual impairments navigate through content effectively using assistive technologies like screen readers.`, - considerations: `- The level of the heading is automatically determined by how deeply it's nested inside other components, starting from h2. -- Default to using the \`heading\` property in \`s-section\`. The \`s-heading\` component should only be used if you need to implement a custom layout for your heading in the UI.`, - bestPractices: ` -- Use short headings to make your content scannable. -- Use plain and clear terms. -- Don't use jargon or technical language. -- Don't use different terms to describe the same thing. -- Don't duplicate content.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Icon.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Icon.d.ts index b2b3ea1793..55e0de83d9 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Icon.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Icon.d.ts @@ -11,29 +11,74 @@ import type {IconProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } /** - * Used as the single source of truth for checkout icon types. - * - * @see https://github.com/Shopify/ui-api-design/blob/main/packages/ui-api-design/src/components/Icon/Icon.ts#L10 + * The complete list of [icon names](https://github.com/Shopify/ui-api-design/blob/main/packages/ui-api-design/src/components/Icon/Icon.ts#L10) available in checkout and customer account surfaces. These icons are drawn from Shopify's design system and cover common UI patterns like navigation, status indicators, actions, and commerce concepts. */ declare const CHECKOUT_AVAILABLE_ICONS: readonly ["alert-circle", "alert-triangle-filled", "alert-triangle", "arrow-down", "arrow-left", "arrow-right", "arrow-up-right", "arrow-up", "bag", "bullet", "calendar", "camera", "caret-down", "cart", "cash-dollar", "categories", "check-circle", "check-circle-filled", "check", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "circle", "clipboard", "clock", "credit-card", "delete", "delivered", "delivery", "disabled", "discount", "edit", "email", "empty", "external", "filter", "geolocation", "gift-card", "globe", "grid", "image", "info-filled", "info", "list-bulleted", "location", "lock", "map", "menu-horizontal", "menu-vertical", "menu", "minus", "mobile", "note", "order", "organization", "plus", "profile", "question-circle-filled", "question-circle", "reorder", "reset", "return", "savings", "search", "settings", "star-filled", "star-half", "star", "store", "truck", "upload", "x-circle-filled", "x-circle", "x"]; +/** + * The subset of icon types available in checkout and customer account surfaces. This is a narrowed set from the full Shopify icon library, containing only the icons supported in these contexts. + */ export type ReducedIconTypes = (typeof CHECKOUT_AVAILABLE_ICONS)[number]; declare const tagName = "s-icon"; +/** @publicDocs */ export interface IconElementProps extends Pick { + /** + * The semantic meaning and color treatment of the icon. + * + * - `'info'`: Informational content or helpful tips. + * - `'auto'`: Automatically determined based on context. + * - `'neutral'`: General information without specific intent. + * - `'success'`: Positive outcomes or successful states. + * - `'warning'`: Important warnings about potential issues. + * - `'critical'`: Urgent problems or destructive actions. + * - `'custom'`: Inherits a custom color from its parent element's CSS. + * + * @default 'auto' + */ tone?: Extract; + /** + * The size of the icon. + * + * - `'base'`: Default size that works well for most use cases. + * - `'small'`: Small icon for inline use within text or compact UI elements. + * - `'small-200'`: Extra small icon for the most compact contexts. + * - `'small-100'`: Small icon suitable for tight or dense layouts. + * - `'large'`: Large icon for emphasis or prominent display. + * - `'large-100'`: Extra large icon for maximum visual impact. + * + * @default 'base' + */ size?: Extract; + /** + * The type of icon that will be displayed. You can specify an icon name from the available icon set, or use an empty string to show no icon. + */ type?: '' | ReducedIconTypes; } +/** + * The HTML element interface for the `s-icon` custom element. + */ export interface IconElement extends IconElementProps, Omit { } +/** + * The properties for the icon component when it's used in JSX. + */ export interface IconProps extends IconElementProps { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Icon/Icon.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Icon/Icon.doc.ts deleted file mode 100644 index eb38ee7980..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Icon/Icon.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Icon'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Image.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Image.d.ts index 20cf46e4ab..1be58cd6a4 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Image.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Image.d.ts @@ -10,26 +10,68 @@ /// import type {ImageProps$1,BorderSizeKeyword, BorderStyleKeyword,ColorKeyword,MaybeAllValuesShorthandProperty} from './components-shared.d.ts'; +/** + * The subset of border size values available for the image component. These control the thickness of any border applied around the image. + * + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `large-200`: The thickest available border. + * - `none`: No border. + */ export type ReducedBorderSizeKeyword = Extract; +/** + * The subset of border color values available for the image component. + * + * - `base`: The standard border color for most contexts. + */ export type ReducedColorKeyword = Extract; +/** + * A shorthand string for specifying border properties on the image component. Supports size alone, size with color, or size with color and style — following the pattern `'size'`, `'size color'`, or `'size color style'`. + */ export type BorderShorthand = ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } declare const tagName = "s-image"; +/** @publicDocs */ export interface ImageElementProps extends Pick { + /** + * A shorthand for setting the border around the image. Accepts a size keyword alone (for example, `'base'`), a size and color (for example, `'base base'`), or a size, color, and style (for example, `'base base solid'`). Use `'none'` to remove the border. + */ border?: BorderShorthand; + /** + * The width of the border around the image. You can use a single value to apply the same width to all sides, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual sides. When set, this overrides the width value specified in the `border` shorthand. + */ borderWidth?: MaybeAllValuesShorthandProperty | ''; + /** + * The radius of the border corners around the image. You can use a single value to apply the same radius to all corners, or use the [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) to control individual corners. + */ borderRadius?: MaybeAllValuesShorthandProperty>; } +/** + * The HTML element interface for the `s-image` custom element. + */ export interface ImageElement extends ImageElementProps, Omit { } +/** + * The properties for the image component when it's used in JSX. + */ export interface ImageProps extends ImageElementProps { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Image/Image.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Image/Image.doc.ts deleted file mode 100644 index cd80ef9aea..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Image/Image.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Image'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - bestPractices: ` -- Use high-resolution images to ensure a professional and high-quality experience. -- Use optimized images so your app loads as fast as possible. -- Use images intentionally, these should add clarity and lead users to the next step.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Link.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Link.d.ts index baeed7c11b..df1710d3a1 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Link.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Link.d.ts @@ -24,26 +24,33 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-link"; +/** @publicDocs */ export interface LinkElementProps extends Pick { target?: Extract; tone?: Extract; } export interface LinkEvents extends Pick { } +/** @publicDocs */ export interface LinkElementEvents { /** - * Callback when the link is activated. - * This will be called before navigating to the location specified by `href`. + * A callback fired when the link is clicked, before navigating to the location specified by `href`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event + * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event). */ click?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Link/Link.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Link/Link.doc.ts deleted file mode 100644 index f41739a7d7..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Link/Link.doc.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Link'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, - bestPractices: ` -- Use links primarily for navigation and use buttons primarily for actions. - -- The HTML that renders for the \`s-button\` and \`s-link\` components includes style and accessibility information. Use these components intentionally and consistently to provide a more inclusive experience for assistive technology users and a more cohesive visual experience for sighted users. - `, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ListItem.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/ListItem.d.ts index 285c583c09..48ae918169 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/ListItem.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/ListItem.d.ts @@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-list-item"; +/** @publicDocs */ export interface ListItemElementProps extends Pick { } export interface ListItemElement extends ListItemElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Map.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Map.d.ts index 3ec89775d0..eea1fecea5 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Map.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Map.d.ts @@ -11,71 +11,133 @@ import type {MapProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } /** - * Used when an element has children. + * The base properties for elements that have children, extending `BaseElementProps` with children support. */ export interface BaseElementPropsWithChildren extends BaseElementProps { + /** + * The child elements to render within this component. + */ children?: preact.ComponentChildren; } +/** + * A callback event typed to a specific HTML element, with a strongly typed `currentTarget`. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * An event listener typed to a specific HTML element, with a strongly typed `currentTarget`. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-map"; +/** @publicDocs */ export interface MapElementProps extends Pick { } +/** + * The event handlers for the map component. + */ export interface MapEvents extends Pick { } +/** + * A geographic coordinate pair representing a location on the map, defined by latitude and longitude values. + */ export interface MapLocation { + /** + * The latitude of the location in degrees. Valid values range from -90 (South Pole) to 90 (North Pole). + */ latitude?: number; + /** + * The longitude of the location in degrees. Valid values range from -180 (west) to 180 (east). + */ longitude?: number; } +/** + * The event data provided when a map interaction occurs at a specific geographic location, such as a click or double-click. + */ export interface MapLocationEvent { + /** + * The geographic location on the map where the interaction occurred, as a latitude/longitude coordinate pair. + */ location?: MapLocation; } +/** + * The event data provided when the visible map boundaries change, such as after a pan or zoom completes. Contains the new geographic bounds of the visible area. + */ export interface MapBoundsEvent { + /** + * The geographic boundaries of the currently visible map area, defined by its north-east and south-west corners. + */ bounds?: { + /** + * The north-east corner of the visible map area, representing the top-right of the visible region. + */ northEast?: MapLocation; + /** + * The south-west corner of the visible map area, representing the bottom-left of the visible region. + */ southWest?: MapLocation; }; } +/** + * The event data provided when the map view changes, such as after the user pans or zooms. Contains the new center location and zoom level. + */ export interface MapViewChangeEvent extends MapLocationEvent { + /** + * The current zoom level of the map after the view change, as a number from 0 (world view) to 18 (street level). + */ zoom?: number; } +/** @publicDocs */ export interface MapElementEvents { /** - * Callback when the viewport bounds have changed or the map is resized. + * A callback fired when the visible map boundaries change, such as after a pan or zoom completes. */ boundschange?: CallbackEventListener; /** - * Callback when the user clicks on the map. + * A callback fired when the user clicks on the map. Provides the geographic location of the click. */ click?: CallbackEventListener; /** - * Callback when the user double-clicks on the map. + * A callback fired when the user double-clicks on the map. Provides the geographic location of the double-click. */ dblclick?: CallbackEventListener; /** - * Callback when the map view changes. + * A callback fired when the map view changes, such as when the user pans or zooms. Provides the new center location and zoom level. */ viewchange?: CallbackEventListener; } +/** + * The HTML element interface for the `s-map` custom element. + */ export interface MapElement extends MapElementProps, Omit { onboundschange: MapEvents['onBoundsChange']; onclick: MapEvents['onClick']; ondblclick: MapEvents['onDblClick']; onviewchange: MapEvents['onViewChange']; } +/** + * The properties for the map component when it's used in JSX. + */ export interface MapProps extends MapElementProps, MapEvents { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Map/Map.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Map/Map.doc.ts deleted file mode 100644 index 217fce554a..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Map/Map.doc.ts +++ /dev/null @@ -1,46 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Map'; -import mapMarkerSharedContent from '../../../../docs/shared/components/MapMarker'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, - subcomponent: { - ...mapMarkerSharedContent, - definitions: {properties: true, events: true, slots: true}, - }, - extraExamples: { - description: - 'Examples of how to show a custom map marker graphic or a Popover when a map marker is clicked.', - examples: [ - { - description: `Use the \`Popover\` component to display content when a map marker is clicked.`, - codeblock: { - title: 'Popover with map marker', - tabs: [ - { - code: './examples/map-marker-popover.example.html', - language: 'html', - }, - ], - }, - }, - { - description: `Use the \`graphic\` slot to display a graphic as a map marker. Find more about slots [here](/docs/api/checkout-ui-extensions/latest/using-polaris-components#slots).`, - codeblock: { - title: 'Map with graphic as map marker', - tabs: [ - { - code: './examples/map-marker-graphic.example.html', - language: 'html', - }, - ], - }, - }, - ], - }, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/MapMarker.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/MapMarker.d.ts index 118a4b4089..7c433c7a37 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/MapMarker.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/MapMarker.d.ts @@ -11,7 +11,7 @@ import type {MapMarkerProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { key?: preact.Key; @@ -19,43 +19,71 @@ export interface BaseElementProps { slot?: Lowercase; } /** - * Used when an element has children. + * The base properties for elements that have children, extending `BaseElementProps` with children support. */ export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * A callback event typed to a specific HTML element, with a strongly typed `currentTarget`. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * An event listener typed to a specific HTML element, with a strongly typed `currentTarget`. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-map-marker"; +/** @publicDocs */ export interface MapMarkerElementProps extends Pick { + /** + * Sets the action the `commandFor` target should take when this component is activated. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command). + * + * - `--auto`: a default action for the target component. + * - `--show`: shows the target component. + * - `--hide`: hides the target component. + * - `--toggle`: toggles the target component. + * + * @default '--auto' + */ command?: Extract; + /** + * The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor). + */ + commandFor?: MapMarkerProps$1['commandFor']; } +/** + * The event handlers for the map marker component. + */ export interface MapMarkerEvents extends Pick { } +/** @publicDocs */ export interface MapMarkerElementEvents { /** - * Callback when a marker is clicked. - * - * It does not trigger a click event on the map itself. + * A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click. */ click?: CallbackEventListener; } +/** @publicDocs */ export interface MapMarkerElementSlots { /** - * The graphic to use as the marker. - * - * If unset, it will default to the provider’s default marker. + * A custom graphic element to use as the marker. If not provided, the map provider’s default marker pin is displayed. */ graphic?: HTMLElement; } +/** + * The HTML element interface for the `s-map-marker` custom element. + */ export interface MapMarkerElement extends MapMarkerElementProps, Omit { onclick: MapMarkerEvents['onClick']; } +/** + * The properties for the map marker component when it's used in JSX. + */ export interface MapMarkerProps extends MapMarkerElementProps, MapMarkerEvents { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Modal.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Modal.d.ts index 1d906c8fff..565d53ea51 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Modal.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Modal.d.ts @@ -11,68 +11,112 @@ import type {ModalProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } /** - * Used when an element has children. + * The base properties for elements that have children, extending `BaseElementProps` with children support. */ export interface BaseElementPropsWithChildren extends BaseElementProps { + /** + * The child elements to render within this component. + */ children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-modal"; +/** @publicDocs */ export interface ModalElementProps extends Pick { + /** + * The size of the modal. + * + * - `'base'`: The default size, suitable for most use cases. + * - `'small'`: A compact modal for simple confirmations or short messages. + * - `'small-100'`: The smallest modal size. + * - `'large'`: A large modal for complex content or forms. + * - `'large-100'`: The largest fixed-size modal, providing maximum room for content. + * - `'max'`: Expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes. + * + * @default 'base' + */ size?: Extract; } +/** @publicDocs */ export interface ModalElementSlots { /** - * The primary action to perform, provided as a button type element. + * The main action button displayed in the modal footer, representing the primary action users should take. Only accepts a single button component. */ 'primary-action'?: HTMLElement; /** - * The secondary actions to perform, provided as button type elements. + * Additional action buttons displayed in the modal footer, providing alternative or supporting actions. */ 'secondary-actions'?: HTMLElement; } +/** + * The event callbacks for monitoring modal visibility changes. + */ export interface ModalEvents extends Pick { } + +/** @publicDocs */ export interface ModalElementMethods extends Pick { } +/** @publicDocs */ export interface ModalElementEvents { /** - * Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished. + * A callback fired when the modal is hidden, after any hide animations have completed. */ afterhide?: CallbackEventListener; /** - * Callback fired when the overlay is shown **after** any animations to show the overlay have finished. + * A callback fired when the modal is shown, after any show animations have completed. */ aftershow?: CallbackEventListener; /** - * Callback fired after the overlay is hidden. + * A callback fired immediately after the modal is hidden. */ hide?: CallbackEventListener; /** - * Callback fired after the overlay is shown. + * A callback fired immediately after the modal is shown. */ show?: CallbackEventListener; } +/** + * The HTML element interface for the `s-modal` custom element. + */ export interface ModalElement extends ModalElementProps, ModalElementMethods, Omit { onafterhide: ModalEvents['onAfterHide']; onaftershow: ModalEvents['onAfterShow']; onhide: ModalEvents['onHide']; onshow: ModalEvents['onShow']; } +/** + * The properties for the modal component when it's used in JSX. + */ export interface ModalProps extends ModalElementProps, ModalEvents { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Modal/Modal.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Modal/Modal.doc.ts deleted file mode 100644 index c1e7fb3243..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Modal/Modal.doc.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Modal'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: { - properties: true, - events: true, - slots: true, - methods: true, - }, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/MoneyField.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/MoneyField.d.ts index c8efa94d75..ac9c4cc17b 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/MoneyField.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/MoneyField.d.ts @@ -18,41 +18,49 @@ export interface BaseElementProps { ref?: preact.Ref; slot?: Lowercase; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-money-field"; +/** @publicDocs */ export interface MoneyFieldElementProps extends Pick { } export interface MoneyFieldEvents extends Pick { } +/** @publicDocs */ export interface MoneyFieldElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the money field loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the money field value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the money field receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the money field. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/MoneyField/MoneyField.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/MoneyField/MoneyField.doc.ts deleted file mode 100644 index 082e698a68..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/MoneyField/MoneyField.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/MoneyField'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/NumberField.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/NumberField.d.ts index d171b626ee..4fb5c3ad80 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/NumberField.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/NumberField.d.ts @@ -31,9 +31,15 @@ export interface BaseElementPropsWithChildren extends Base */ declare const CHECKOUT_AVAILABLE_ICONS: readonly ["alert-circle", "alert-triangle-filled", "alert-triangle", "arrow-down", "arrow-left", "arrow-right", "arrow-up-right", "arrow-up", "bag", "bullet", "calendar", "camera", "caret-down", "cart", "cash-dollar", "categories", "check-circle", "check-circle-filled", "check", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "circle", "clipboard", "clock", "credit-card", "delete", "delivered", "delivery", "disabled", "discount", "edit", "email", "empty", "external", "filter", "geolocation", "gift-card", "globe", "grid", "image", "info-filled", "info", "list-bulleted", "location", "lock", "map", "menu-horizontal", "menu-vertical", "menu", "minus", "mobile", "note", "order", "organization", "plus", "profile", "question-circle-filled", "question-circle", "reorder", "reset", "return", "savings", "search", "settings", "star-filled", "star-half", "star", "store", "truck", "upload", "x-circle-filled", "x-circle", "x"]; export type ReducedIconTypes = (typeof CHECKOUT_AVAILABLE_ICONS)[number]; +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; @@ -62,6 +68,7 @@ declare module 'preact' { } declare const tagName = "s-number-field"; +/** @publicDocs */ export interface NumberFieldElementProps extends Pick { icon?: IconProps['type']; /** @@ -72,36 +79,37 @@ export interface NumberFieldElementProps extends Pick { } +/** @publicDocs */ export interface NumberFieldElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the number field loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the number field value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the number field receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the number field. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; } +/** @publicDocs */ export interface NumberFieldElementSlots { /** - * Additional content to be displayed in the field. - * Commonly used to display an icon that activates a tooltip providing more information. + * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported. */ accessory?: HTMLElement; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/NumberField/NumberField.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/NumberField/NumberField.doc.ts deleted file mode 100644 index b728354864..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/NumberField/NumberField.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/NumberField'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true, slots: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Option.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Option.d.ts index 0d63b5caca..ca09b3f1d6 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Option.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Option.d.ts @@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-option"; +/** @publicDocs */ export interface OptionElementProps extends Pick { } export interface OptionElement extends OptionElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/OrderedList.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/OrderedList.d.ts index 6e6b461441..903a1dbc6b 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/OrderedList.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/OrderedList.d.ts @@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-ordered-list"; +/** @publicDocs */ export interface OrderedListElementProps extends OrderedListProps$1 { } export interface OrderedListElement extends OrderedListElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/OrderedList/OrderedList.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/OrderedList/OrderedList.doc.ts deleted file mode 100644 index 9e04518b7d..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/OrderedList/OrderedList.doc.ts +++ /dev/null @@ -1,22 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/OrderedList'; -import listItemSharedContent from '../../../../docs/shared/components/ListItem'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - subcomponent: { - ...listItemSharedContent, - definitions: {properties: true}, - }, - bestPractices: ` -- Use \`s-ordered-list\` when you need to present items in a specific sequence or order. -- Each item in the list should be wrapped in a \`s-list-item\` component. -- Keep list items concise and consistent in length when possible. -- Use \`s-ordered-list\` for step-by-step instructions, numbered procedures, or ranked items. -- Consider using \`s-ordered-list\` when the order of items is important for understanding.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Paragraph.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Paragraph.d.ts index 8e63ed7da8..e49a076d64 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Paragraph.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Paragraph.d.ts @@ -11,27 +11,50 @@ import type {ParagraphProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. This is used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns the element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } /** - * Used when an element has children. + * The base properties for elements that have children, extending `BaseElementProps` with children support. + * @publicDocs */ export interface BaseElementPropsWithChildren extends BaseElementProps { + /** + * The child elements to render within this component. + */ children?: preact.ComponentChildren; } declare const tagName = "s-paragraph"; +/** @publicDocs */ export interface ParagraphElementProps extends Pick { color?: Extract; tone?: Extract; + /** + * Sets the alignment of the text. + * @see https://developer.mozilla.org/en-US/docs/Web/CSS/text-align + * + * @default 'auto' + */ + textAlign?: 'start' | 'end' | 'center' | 'auto'; } +/** @publicDocs */ export interface ParagraphElement extends ParagraphElementProps, Omit { } +/** @publicDocs */ export interface ParagraphProps extends ParagraphElementProps { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Paragraph/Paragraph.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Paragraph/Paragraph.doc.ts deleted file mode 100644 index 94f8f95af8..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Paragraph/Paragraph.doc.ts +++ /dev/null @@ -1,13 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Paragraph'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - bestPractices: - '- Create contrast between more and less important text with properties such as `color` and `tone`.', -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/PasswordField.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/PasswordField.d.ts index f578146311..7818d98637 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/PasswordField.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/PasswordField.d.ts @@ -24,48 +24,56 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-password-field"; +/** @publicDocs */ export interface PasswordFieldElementProps extends Pick { } export interface PasswordFieldEvents extends Pick { } +/** @publicDocs */ export interface PasswordFieldElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the password field loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the password field value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the password field receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the password field. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; } +/** @publicDocs */ export interface PasswordFieldElementSlots { /** - * Additional content to be displayed in the field. - * Commonly used to display an icon that activates a tooltip providing more information. + * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported. */ accessory?: HTMLElement; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/PasswordField/PasswordField.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/PasswordField/PasswordField.doc.ts deleted file mode 100644 index ae04710e15..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/PasswordField/PasswordField.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/PasswordField'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true, slots: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/PaymentIcon.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/PaymentIcon.d.ts index 31f2ee607d..23131265a0 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/PaymentIcon.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/PaymentIcon.d.ts @@ -11,19 +11,35 @@ import type {PaymentIconProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } declare const tagName = "s-payment-icon"; +/** @publicDocs */ export interface PaymentIconElementProps extends PaymentIconProps$1 { } +/** + * The HTML element interface for the `s-payment-icon` custom element. + */ export interface PaymentIconElement extends PaymentIconElementProps, Omit { } +/** + * The properties for the payment icon component when it's used in JSX. + */ export interface PaymentIconProps extends PaymentIconElementProps { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/PaymentIcon/PaymentIcon.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/PaymentIcon/PaymentIcon.doc.ts deleted file mode 100644 index c29ccec3af..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/PaymentIcon/PaymentIcon.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/PaymentIcon'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/PhoneField.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/PhoneField.d.ts index 6172c9cfc4..450da2dbf6 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/PhoneField.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/PhoneField.d.ts @@ -24,14 +24,21 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-phone-field"; +/** @publicDocs */ export interface PhoneFieldElementProps extends Pick { /** * @deprecated Use `label` instead. @@ -41,36 +48,37 @@ export interface PhoneFieldElementProps extends Pick { } +/** @publicDocs */ export interface PhoneFieldElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the phone field loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the phone field value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the phone field receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the phone field. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; } +/** @publicDocs */ export interface PhoneFieldElementSlots { /** - * Additional content to be displayed in the field. - * Commonly used to display an icon that activates a tooltip providing more information. + * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported. */ accessory?: HTMLElement; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/PhoneField/PhoneField.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/PhoneField/PhoneField.doc.ts deleted file mode 100644 index a3321688eb..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/PhoneField/PhoneField.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/PhoneField'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true, slots: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Popover.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Popover.d.ts index e809cfca5c..ef69cc9f23 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Popover.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Popover.d.ts @@ -11,93 +11,110 @@ import type {PopoverProps$1,SizeUnitsOrAuto, SizeUnitsOrNone, SizeUnits} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } /** - * Used when an element has children. + * The base properties for elements that have children, extending `BaseElementProps` with children support. */ export interface BaseElementPropsWithChildren extends BaseElementProps { + /** + * The child elements to render within this component. + */ children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-popover"; +/** @publicDocs */ export interface PopoverElementProps extends Pick { /** - * Adjust the block size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/block-size + * The block size of the popover (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). * * @default 'auto' */ blockSize?: SizeUnitsOrAuto; /** - * Adjust the inline size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size + * The inline size of the popover (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size). * * @default 'auto' */ inlineSize?: SizeUnitsOrAuto; /** - * Adjust the maximum block size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size + * The maximum block size of the popover. Constrains the popover's height to prevent it from exceeding this value. Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size). * * @default 'none' */ maxBlockSize?: SizeUnitsOrNone; /** - * Adjust the maximum inline size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size + * The maximum inline size of the popover. Constrains the popover's width to prevent it from exceeding this value. Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size). * * @default 'none' */ maxInlineSize?: SizeUnitsOrNone; /** - * Adjust the minimum block size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size + * The minimum block size of the popover. Ensures the popover maintains at least this height. Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size). * * @default '0' */ minBlockSize?: SizeUnits; /** - * Adjust the minimum inline size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size + * The minimum inline size of the popover. Ensures the popover maintains at least this width. Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size). * * @default '0' */ minInlineSize?: SizeUnits; } +/** + * The event callbacks for monitoring popover visibility changes. + */ export interface PopoverEvents extends Pick { } +/** @publicDocs */ export interface PopoverElementEvents { /** - * Callback fired after the overlay is hidden. + * A callback fired immediately after the popover is hidden. */ hide?: CallbackEventListener; /** - * Callback fired after the overlay is shown. + * A callback fired immediately after the popover is shown. */ show?: CallbackEventListener; } +/** + * The HTML element interface for the `s-popover` custom element. + */ export interface PopoverElement extends Omit, Omit { onhide: PopoverProps['onHide']; onshow: PopoverProps['onShow']; } +/** + * The properties for the popover component when it's used in JSX. + */ export interface PopoverProps extends PopoverElementProps, PopoverEvents { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Popover/Popover.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Popover/Popover.doc.ts deleted file mode 100644 index 54b9531a22..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Popover/Popover.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Popover'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/PressButton.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/PressButton.d.ts index abc21a770e..a3b5f29444 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/PressButton.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/PressButton.d.ts @@ -24,35 +24,43 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-press-button"; +/** @publicDocs */ export interface PressButtonElementProps extends Pick { } export interface PressButtonEvents extends Pick { } +/** @publicDocs */ export interface PressButtonElementEvents { /** - * Callback when the button is activated. + * A callback fired when the button is clicked. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event + * Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event). */ click?: CallbackEventListener; /** - * Callback when the button has lost focus. + * A callback fired when the button loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the button has received focus. + * A callback fired when the button receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/PressButton/PressButton.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/PressButton/PressButton.doc.ts deleted file mode 100644 index 97d228fa9a..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/PressButton/PressButton.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/PressButton'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ProductThumbnail.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/ProductThumbnail.d.ts index 5337acc372..99bdd04577 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/ProductThumbnail.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/ProductThumbnail.d.ts @@ -11,20 +11,45 @@ import type {ProductThumbnailProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } declare const tagName = "s-product-thumbnail"; +/** @publicDocs */ export interface ProductThumbnailElementProps extends Pick { + /** + * The size of the product thumbnail image. + * + * - `'base'`: Default size that works well in most contexts. + * - `'small'`: Small thumbnail, good for secondary contexts or tight layouts. + * - `'small-100'`: Extra small thumbnail for compact displays or dense lists. + * + * @default 'base' + */ size?: Extract; } +/** + * The HTML element interface for the `s-product-thumbnail` custom element. + */ export interface ProductThumbnailElement extends ProductThumbnailElementProps, Omit { } +/** + * The properties for the product thumbnail component when it's used in JSX. + */ export interface ProductThumbnailProps extends ProductThumbnailElementProps { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ProductThumbnail/ProductThumbnail.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/ProductThumbnail/ProductThumbnail.doc.ts deleted file mode 100644 index 0bcd05bc22..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/ProductThumbnail/ProductThumbnail.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/ProductThumbnail'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Progress.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Progress.d.ts index 8ce8ee4c2e..d126c3ffce 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Progress.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Progress.d.ts @@ -20,8 +20,35 @@ export interface BaseElementProps { } declare const tagName = "s-progress"; +/** @publicDocs */ export interface ProgressElementProps extends Pick { + /** + * A label announced by assistive technologies that describes what is progressing. Use this to provide context about the ongoing task, such as "Loading order details" or "Uploading file". + */ + accessibilityLabel?: ProgressProps$1['accessibilityLabel']; + /** + * The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number. + * + * Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max). + * + * @default 1 + */ + max?: ProgressProps$1['max']; + /** + * The semantic meaning and color treatment of the progress indicator. + * + * - `auto`: Automatically determined based on context. + * - `critical`: Indicates an urgent or error state requiring immediate attention. + * + * @default 'auto' + */ tone?: Extract; + /** + * How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time. + * + * Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value). + */ + value?: ProgressProps$1['value']; } export interface ProgressElement extends ProgressElementProps, Omit { } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Progress/Progress.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Progress/Progress.doc.ts deleted file mode 100644 index ee53fb2d75..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Progress/Progress.doc.ts +++ /dev/null @@ -1,38 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Progress'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - bestPractices: ` -Use components like [Paragraph](../titles-and-text/paragraph) or [Text](../titles-and-text/text), along with the Progress component, to display text indicating the status of the progress bar. - -### Loading states - -For loading states, add text to reassure the user that the progress bar is not frozen. - -![A progress bar with "Loading" text](/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/progress-loading.png) - -### Error states - -For error states, add text or a [Banner](./banner) to describe the error and next steps. Use the \`critical\` tone property to convey urgency. - -![A progress bar with error text that says "There was a problem with the file upload. Please try again."](/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/progress-error.png) - -### Visualize a goal - -Use the Progress component to visualize a goal that's valuable to the customer. - -Here's an example of using a progress bar to show a customer's progress toward the next rewards tier: - -![A progress bar in customer accounts, showing that the customer is on their way to reaching the Botanical maven rewards tier.](/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/progress-goal.png) - -Here's an example of using a progress bar to show how much more a customer needs to spend to get free shipping: - -![A progress bar at checkout, showing that the customer is $43 away from free shipping.](/assets/landing-pages/templated-apis/checkout-ui-extensions/ui-components/progress-free-shipping.png) - `, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/QRCode.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/QRCode.d.ts index 66252a9846..2d3a99d164 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/QRCode.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/QRCode.d.ts @@ -11,35 +11,60 @@ import type {QRCodeProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } +/** + * A callback event typed to a specific HTML element, with a strongly typed `currentTarget`. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * An event listener typed to a specific HTML element, with a strongly typed `currentTarget`. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-qr-code"; +/** @publicDocs */ export interface QRCodeElementProps extends QRCodeProps$1 { } +/** + * The event handlers for the QR code component. + */ export interface QRCodeEvents extends Pick { } +/** @publicDocs */ export interface QRCodeElementEvents { /** - * Invoked when the conversion of `content` to a QR code fails. - * If an error occurs, the QR code and its child elements will not be displayed. + * A callback that's fired when the conversion of `content` to a QR code fails. */ error?: CallbackEventListener; } +/** + * The HTML element interface for the `s-qr-code` custom element. + */ export interface QRCodelement extends QRCodeElementProps, Omit { onerror: QRCodeEvents['onError']; } +/** + * The properties for the QR code component when it's used in JSX. + */ export interface QRCodeProps extends QRCodeElementProps, QRCodeEvents { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/QRCode/QRCode.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/QRCode/QRCode.doc.ts deleted file mode 100644 index 19507ae772..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/QRCode/QRCode.doc.ts +++ /dev/null @@ -1,18 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/QRCode'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, - bestPractices: ` -- Always test that the QR code is scannable from a smartphone. -- Include a square logo if that’s what your customers are familiar with. -- Increase usability by adding a text description of what the QR code does. -- Always provide an alternate method for customers to access the content of the QR code. -- If the content is a URL, provide a [\`s-link\`](/docs/api/checkout-ui-extensions/components/link) nearby. -- If the content is data, provide a [\`s-button\`](/docs/api/checkout-ui-extensions/components/button) to copy the data to the clipboard, or show the data in a readonly [\`s-text-field\`](/docs/api/checkout-ui-extensions/components/textfield).`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/QueryContainer.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/QueryContainer.d.ts index 0103e4cad8..02acb2b9a0 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/QueryContainer.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/QueryContainer.d.ts @@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-query-container"; +/** @publicDocs */ export interface QueryContainerElementProps extends Pick { } export interface QueryContainerElement extends QueryContainerElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/QueryContainer/QueryContainer.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/QueryContainer/QueryContainer.doc.ts deleted file mode 100644 index 53a9a565d5..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/QueryContainer/QueryContainer.doc.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/QueryContainer'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - related: [ - { - name: 'Responsive values', - subtitle: 'Utility', - url: '/docs/api/checkout-ui-extensions/latest/using-polaris-components#responsive-values', - type: 'utility', - }, - ], -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ScrollBox.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/ScrollBox.d.ts index ebd2b3dc52..2d2cec6bb1 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/ScrollBox.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/ScrollBox.d.ts @@ -10,8 +10,25 @@ /// import type {ScrollBoxProps$1,BorderSizeKeyword, BorderStyleKeyword,ColorKeyword,MaybeAllValuesShorthandProperty} from './components-shared.d.ts'; +/** + * The subset of border size values available for this component. + * + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `large-200`: The thickest available border. + * - `none`: No border. + */ export type ReducedBorderSizeKeyword = Extract; +/** + * The subset of border color values available for this component. + * + * - `base`: The standard border color for most contexts. + */ export type ReducedColorKeyword = Extract; +/** + * A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults. + */ export type BorderShorthand = ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`; /** * Used when an element does not have children. @@ -29,11 +46,49 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-scroll-box"; +/** @publicDocs */ export interface ScrollBoxElementProps extends Pick { + /** + * The background color of the scroll box. + * + * - `base`: The standard background color for general content areas. + * - `subdued`: A muted background for secondary or supporting content. + * - `transparent`: No background color (the default). + * + * @default 'transparent' + */ background?: Extract; + /** + * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here. + * + * @default 'none' + */ border?: BorderShorthand; + /** + * The color of the border using the design system's color scale. Overrides the color value set by `border`. + * + * @default '' - meaning no override + */ borderColor?: ReducedColorKeyword | ''; + /** + * The roundedness of the scroll box's corners. + * + * - `none`: Sharp corners with no rounding. + * - `small-100` / `small`: Subtle rounding for compact elements. + * - `base`: Standard rounding for most use cases. + * - `large` / `large-100`: More pronounced rounding for prominent containers. + * - `max`: Maximum rounding, creating a pill or circular shape. + * + * Supports 1-to-4-value shorthand syntax for specifying different radii per corner. + * + * @default 'none' + */ borderRadius?: MaybeAllValuesShorthandProperty>; + /** + * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`. + * + * @default '' - meaning no override + */ borderWidth?: MaybeAllValuesShorthandProperty | ''; } export interface ScrollBoxElement extends ScrollBoxElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/ScrollBox/ScrollBox.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/ScrollBox/ScrollBox.doc.ts deleted file mode 100644 index db27f2da5e..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/ScrollBox/ScrollBox.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/ScrollBox'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Section.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Section.d.ts index 4b3833776b..761adfa251 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Section.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Section.d.ts @@ -20,16 +20,20 @@ export interface BaseElementProps { } /** * Used when an element has children. + * @publicDocs */ export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } declare const tagName = "s-section"; -export interface SectionElementProps extends Pick { +/** @publicDocs */ +export interface SectionElementProps extends Pick { } +/** @publicDocs */ export interface SectionElement extends SectionElementProps, Omit { } +/** @publicDocs */ export interface SectionProps extends SectionElementProps { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Section/Section.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Section/Section.doc.ts deleted file mode 100644 index bb6ec71847..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Section/Section.doc.ts +++ /dev/null @@ -1,14 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Section'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - usefulFor: `- Organizing your page in a logical structure based on nesting levels. -- Creating consistency across pages.`, - considerations: `- When adding headings inside sections they automatically use a specific style, which helps keep the content organized and clear.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Select.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Select.d.ts index de2f1dd56f..d56bd4198b 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Select.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Select.d.ts @@ -24,35 +24,43 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-select"; +/** @publicDocs */ export interface SelectElementProps extends Pick { } export interface SelectEvents extends Pick { } +/** @publicDocs */ export interface SelectElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the select loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the select value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the select receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Select/Select.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Select/Select.doc.ts deleted file mode 100644 index f18caaf221..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Select/Select.doc.ts +++ /dev/null @@ -1,16 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Select'; -import optionSharedContent from '../../../../docs/shared/components/Option'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, - subcomponent: { - ...optionSharedContent, - definitions: {properties: true}, - }, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Sheet.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Sheet.d.ts index 125a565300..c932dba5c6 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Sheet.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Sheet.d.ts @@ -11,69 +11,93 @@ import type {SheetProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } /** - * Used when an element has children. + * The base properties for elements that have children, extending `BaseElementProps` with children support. */ export interface BaseElementPropsWithChildren extends BaseElementProps { + /** + * The child elements to render within this component. + */ children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-sheet"; +/** @publicDocs */ export interface SheetElementProps extends Pick { /** - * 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. + * A label that describes the purpose of the sheet, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the sheet. */ accessibilityLabel?: string; } +/** + * The event callbacks for monitoring sheet visibility changes. + */ export interface SheetEvents extends Pick { } +/** @publicDocs */ export interface SheetElementEvents { /** - * Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished. + * A callback fired when the sheet is hidden, after any hide animations have completed. */ afterhide?: CallbackEventListener; /** - * Callback fired when the overlay is shown **after** any animations to show the overlay have finished. + * A callback fired when the sheet is shown, after any show animations have completed. */ aftershow?: CallbackEventListener; /** - * Callback fired after the overlay is hidden. + * A callback fired immediately after the sheet is hidden. */ hide?: CallbackEventListener; /** - * Callback fired after the overlay is shown. + * A callback fired immediately after the sheet is shown. */ show?: CallbackEventListener; } +/** @publicDocs */ export interface SheetElementSlots { /** - * The primary action to perform, provided as a button type element. + * The main action button displayed in the sheet footer, representing the primary action users should take. Only accepts a single button component. */ 'primary-action'?: HTMLElement; /** - * The secondary actions to perform, provided as a button type element. + * Additional action buttons displayed in the sheet footer, providing alternative or supporting actions. */ 'secondary-actions'?: HTMLElement; } +/** @publicDocs */ export interface SheetElementMethods extends Pick { } +/** + * The HTML element interface for the `s-sheet` custom element. + */ export interface SheetElement extends SheetElementProps, SheetElementMethods, Omit { afterhide: SheetEvents['onAfterHide']; aftershow: SheetEvents['onAfterShow']; @@ -82,6 +106,9 @@ export interface SheetElement extends SheetElementProps, SheetElementMethods, Om onafterhide: SheetEvents['onAfterHide']; onaftershow: SheetEvents['onAfterShow']; } +/** + * The properties for the sheet component when it's used in JSX. + */ export interface SheetProps extends SheetElementProps, SheetEvents { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Sheet/Sheet.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Sheet/Sheet.doc.ts deleted file mode 100644 index 0389cb6db0..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Sheet/Sheet.doc.ts +++ /dev/null @@ -1,147 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; -import sharedContent from '../../../../docs/shared/components/Sheet'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - requires: - 'configuration of the [Customer Privacy](/docs/api/checkout-ui-extensions/latest/configuration#collect-buyer-consent) capability to be rendered.', - definitions: { - properties: true, - events: true, - slots: true, - methods: true, - }, - extraContent: [ - { - type: 'Generic', - anchorLink: 'shopify-controlled-surfaces', - title: 'Shopify-controlled surfaces', - sectionContent: `To prevent disruptions during checkout, we maintain strict design control over key areas of the Sheet component. These Shopify-controlled elements include: - -

Locations of elements

- -The Sheet elements (header, content, action buttons, and dismiss button) are strategically positioned and sized to present vital information upfront. - -Locations of header and content - -Locations of dismiss button and actions - -
- -

Padding and spacing

- -Padding and spacing - -
- -

Maximum height

- -To balance customer attention and task completion, a maximum height is set for the Sheet component. - -Small screen maximum height - -Large screen maximum height - -When content pushes the sheet to exceed this limit, the following UI behaviors are triggered: - -
- -

Heading and content are scrollable

- -Heading and content are scrollable - -
- -

Expand pill appears to allow customers to view the entire content

- -Expand pill to allow maximum height - -
- -

Actions slot and dismiss button remain fixed

- -Actions slot and dismiss button remain fixed -`, - }, - { - type: 'Generic', - anchorLink: 'privacy-consent-requirements', - title: 'Privacy consent requirements', - sectionContent: `

Content

- -For the best customer experience, ensure content is brief and to the point. - -Shows content that is brief and to the point - -Various strategies can be employed to avoid content scrolling. - -
- -

Use short content

- -Use short content - -
- -

Use small text size

- -Use small text size - -
- -

Remove the header

- -Remove the header - -
- -

Actions slot

- -The actions slots allows customers to make decisions and is split into primary and secondary sections. - -Actions slot - -
- -

Primary section

- - Contains primary actions for customer decisions on the sheet's prompt. Up to two buttons are allowed. Keep the button's content brief so that it doesn't wrap to more than one line. - -Primary section - -
- -

Secondary section

- -Contains action that is unrelated to the sheet's prompt. Only one button is allowed. A modal can be activated when engaging with the secondary action. Keep the button's content brief so that it doesn't wrap to more than one line. - -Secondary section - -
- -

Consent, denial of consent, and sheet dismissal

- -

Consent

- -When a customer expresses consent by pressing the acceptance button, cookies will load and the sheet should not re-appear on refresh. - -
- -

Denial of consent

- -When a customer expresses denial of consent by pressing the rejection button, cookies will not load and the sheet will not re-appear on refresh. - -
- -

Sheet dismissal

- -When a customer neither grants nor denies consent by pressing the dismiss button, cookies will not load and the sheet will re-appear on refresh. - -Sheet dismissal`, - }, - ], -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/SkeletonParagraph.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/SkeletonParagraph.d.ts index bd63719ca8..1afd1d25ad 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/SkeletonParagraph.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/SkeletonParagraph.d.ts @@ -20,6 +20,7 @@ export interface BaseElementProps { } declare const tagName = "s-skeleton-paragraph"; +/** @publicDocs */ export interface SkeletonParagraphElementProps extends SkeletonParagraphProps$1 { } export interface SkeletonParagraphElement extends SkeletonParagraphElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/SkeletonParagraph/SkeletonParagraph.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/SkeletonParagraph/SkeletonParagraph.doc.ts deleted file mode 100644 index d884dffbe2..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/SkeletonParagraph/SkeletonParagraph.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/SkeletonParagraph'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Spinner.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Spinner.d.ts index 06f2b032bb..c0a3e8b2f4 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Spinner.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Spinner.d.ts @@ -20,7 +20,23 @@ export interface BaseElementProps { } declare const tagName = "s-spinner"; +/** @publicDocs */ export interface SpinnerElementProps extends SpinnerProps$1 { + /** + * A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state. + */ + accessibilityLabel?: SpinnerProps$1['accessibilityLabel']; + /** + * The size of the spinner icon. + * + * - `base`: The default size, suitable for most use cases. + * - `small`: A compact size for secondary loading states. + * - `small-100`: The smallest size for tight spaces or inline indicators. + * - `large`: A larger size for more prominent loading states. + * - `large-100`: The largest size for full-page or section-level loading indicators. + * + * @default 'base' + */ size?: Extract; } export interface SpinnerElement extends SpinnerElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Spinner/Spinner.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Spinner/Spinner.doc.ts deleted file mode 100644 index e7a2d0941c..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Spinner/Spinner.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Spinner'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Stack.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Stack.d.ts index a152955841..13e117ab3d 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Stack.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Stack.d.ts @@ -10,8 +10,25 @@ /// import type {StackProps$1,MaybeAllValuesShorthandProperty, MaybeResponsive,BorderSizeKeyword, BorderStyleKeyword,ColorKeyword} from './components-shared.d.ts'; +/** + * The subset of border size values available for this component. + * + * - `base`: Standard border width. + * - `large`: Thick border for strong emphasis. + * - `large-100`: Extra thick border for maximum prominence. + * - `large-200`: The thickest available border. + * - `none`: No border. + */ export type ReducedBorderSizeKeyword = Extract; +/** + * The subset of border color values available for this component. + * + * - `base`: The standard border color for most contexts. + */ export type ReducedColorKeyword = Extract; +/** + * A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base base'`), or size with color and style (`'base base dashed'`). Omitted values use their defaults. + */ export type BorderShorthand = ReducedBorderSizeKeyword | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword}` | `${ReducedBorderSizeKeyword} ${ReducedColorKeyword} ${BorderStyleKeyword}`; /** * Used when an element does not have children. @@ -29,14 +46,107 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-stack"; +/** @publicDocs */ export interface StackElementProps extends Pick { + /** + * The semantic meaning of the stack's content, used by assistive technologies. + * + * - `aside`: Supporting content related to the main content. + * - `footer`: Information such as copyright, navigation links, and privacy statements. + * - `header`: A page or section header. + * - `main`: The primary content of the page. + * - `section`: A generic section that should have a heading or `accessibilityLabel`. + * - `status`: A live region with advisory information that is not urgent. + * - `none`: Strips semantic meaning while keeping visual styling. + * - `navigation`: A major group of navigation links. + * - `ordered-list`: A list of ordered items. + * - `list-item`: An item inside a list. + * - `list-item-separator`: A divider between list items. + * - `unordered-list`: A list of unordered items. + * - `separator`: A divider that separates sections of content. + * - `alert`: Important, usually time-sensitive information. + * - `generic`: A nameless container with no semantic meaning (renders a `
`). + * + * @default 'generic' + */ accessibilityRole?: Extract; + /** + * The background color of the stack. + * + * - `base`: The standard background color for general content areas. + * - `subdued`: A muted background for secondary or supporting content. + * - `transparent`: No background color (the default). + * + * @default 'transparent' + */ background?: Extract; + /** + * A shorthand for setting the border width, color, and style in a single property. Individual border properties (`borderWidth`, `borderStyle`) can override values set here. + * + * @default 'none' + */ border?: BorderShorthand; + /** + * The thickness of the border on all sides. Supports 1-to-4-value shorthand syntax for specifying different widths per side. Overrides the width value set by `border`. + * + * @default '' - meaning no override + */ borderWidth?: MaybeAllValuesShorthandProperty | ''; + /** + * The roundedness of the stack's corners. + * + * - `none`: Sharp corners with no rounding. + * - `small-100` / `small`: Subtle rounding for compact elements. + * - `base`: Standard rounding for most use cases. + * - `large` / `large-100`: More pronounced rounding for prominent containers. + * - `max`: Maximum rounding, creating a pill or circular shape. + * + * Supports 1-to-4-value shorthand syntax for specifying different radii per corner. + * + * @default 'none' + */ borderRadius?: MaybeAllValuesShorthandProperty>; + /** + * Controls how lines of content are distributed along the cross axis when there is extra space. + * + * - `normal`: Default browser behavior. + * - `space-between`: Distributes lines evenly with no space at the edges. + * - `space-around`: Distributes lines evenly with equal space around each. + * - `space-evenly`: Distributes lines with equal space between and at the edges. + * - `stretch`: Stretches lines to fill the available space. + * - `center`: Packs lines toward the center. + * - `start`: Packs lines toward the start of the cross axis. + * - `end`: Packs lines toward the end of the cross axis. + * + * @default 'normal' + */ alignContent?: MaybeResponsive>; + /** + * Controls how child elements are aligned along the cross axis. + * + * - `normal`: Default browser behavior. + * - `stretch`: Stretches children to fill the cross axis. + * - `center`: Centers children along the cross axis. + * - `start`: Aligns children to the start of the cross axis. + * - `end`: Aligns children to the end of the cross axis. + * + * @default 'normal' + */ alignItems?: MaybeResponsive>; + /** + * Controls how child elements are distributed along the main axis. + * + * - `normal`: Default browser behavior. + * - `space-between`: Distributes children evenly with no space at the edges. + * - `space-around`: Distributes children evenly with equal space around each. + * - `space-evenly`: Distributes children with equal space between and at the edges. + * - `stretch`: Stretches children to fill the available space. + * - `center`: Packs children toward the center. + * - `start`: Packs children toward the start of the main axis. + * - `end`: Packs children toward the end of the main axis. + * + * @default 'normal' + */ justifyContent?: MaybeResponsive>; } export interface StackElement extends StackElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Stack/Stack.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Stack/Stack.doc.ts deleted file mode 100644 index 0a2d8c5403..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Stack/Stack.doc.ts +++ /dev/null @@ -1,20 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Stack'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - usefulFor: ` -- Placing items in rows or columns when sections don't work for your layout. -- Controlling the spacing between elements.`, - considerations: ` -- Stack doesn't add any padding by default. If you want padding around your stacked elements, use \`base\` to apply the default padding. -- When spacing becomes limited, Stack will always wrap children to a new line.`, - bestPractices: ` -- Use smaller gaps between small elements and larger gaps between big ones. -- Maintain consistent spacing in stacks across all pages of your app.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Summary.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Summary.d.ts index f55d318afc..533dd90b6b 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Summary.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Summary.d.ts @@ -11,6 +11,7 @@ import type {SummaryProps$1} from './components-shared.d.ts'; declare const tagName = "s-summary"; +/** @publicDocs */ export interface SummaryElementProps extends Pick { } export interface SummaryElement extends SummaryElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Switch.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Switch.d.ts index 4cddb63db4..668e6a0d5b 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Switch.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Switch.d.ts @@ -18,24 +18,32 @@ export interface BaseElementProps { ref?: preact.Ref; slot?: Lowercase; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-switch"; +/** @publicDocs */ export interface SwitchElementProps extends Pick { command?: Extract; } export interface SwitchEvents extends Pick { } +/** @publicDocs */ export interface SwitchElementEvents { /** - * A callback that is run whenever the control is changed. + * A callback fired when the switch value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Switch/Switch.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Switch/Switch.doc.ts deleted file mode 100644 index d0c57ad989..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Switch/Switch.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Switch'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Text.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Text.d.ts index dd2b81fbfe..5e1b9e4f8a 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Text.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Text.d.ts @@ -26,10 +26,27 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-text"; +/** @publicDocs */ export interface TextElementProps extends Pick { color?: Extract; tone?: Extract; - type?: Extract; + /** + * The semantic type and styling treatment for the text content. + * + * Other presentation properties on `s-text` override the default styling. + * + * - `address`: A semantic type that indicates the text is contact information. Typically used for addresses. + * - `redundant`: A semantic type that indicates the text is no longer accurate or no longer relevant. One such use-case is discounted prices. + * - `mark`: A semantic type that indicates the text is marked or highlighted and relevant to the user's current action. + * - `emphasis`: A semantic type that indicates emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text. + * - `offset`: A semantic type that indicates an offset from the normal prose of the text. + * - `small`: A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand. + * - `strong`: A semantic type that indicates strong importance, seriousness, or urgency. + * - `generic`: No additional semantics or styling is applied. + * + * @default 'generic' + */ + type?: Extract; } export interface TextElement extends TextElementProps, Omit { } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Text/Text.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Text/Text.doc.ts deleted file mode 100644 index 703503a4eb..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Text/Text.doc.ts +++ /dev/null @@ -1,19 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Text'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - usefulFor: ` -- Adding inline text elements such as labels or line errors. -- Applying different visual tones and text styles to specific words or phrases within a \`s-paragraph\`, such as a \`strong\` type or \`critical\` tone.`, - bestPractices: ` -- Use plain and clear terms. -- Don’t use jargon or technical language. -- Don’t use different terms to describe the same thing. -- Don’t duplicate content.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/TextArea.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/TextArea.d.ts index d2f1f46ec6..a1ff26f152 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/TextArea.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/TextArea.d.ts @@ -18,14 +18,21 @@ export interface BaseElementProps { ref?: preact.Ref; slot?: Lowercase; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-text-area"; +/** @publicDocs */ export interface TextAreaElementProps extends Pick { /** * @deprecated Use `label` instead. @@ -35,29 +42,30 @@ export interface TextAreaElementProps extends Pick { } +/** @publicDocs */ export interface TextAreaElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the text area loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the text area value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the text area receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the text area. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/TextArea/TextArea.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/TextArea/TextArea.doc.ts deleted file mode 100644 index f0acbdb15f..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/TextArea/TextArea.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/TextArea'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/TextField.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/TextField.d.ts index 3535a2ae89..412fa2c959 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/TextField.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/TextField.d.ts @@ -31,9 +31,15 @@ export interface BaseElementPropsWithChildren extends Base */ declare const CHECKOUT_AVAILABLE_ICONS: readonly ["alert-circle", "alert-triangle-filled", "alert-triangle", "arrow-down", "arrow-left", "arrow-right", "arrow-up-right", "arrow-up", "bag", "bullet", "calendar", "camera", "caret-down", "cart", "cash-dollar", "categories", "check-circle", "check-circle-filled", "check", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "circle", "clipboard", "clock", "credit-card", "delete", "delivered", "delivery", "disabled", "discount", "edit", "email", "empty", "external", "filter", "geolocation", "gift-card", "globe", "grid", "image", "info-filled", "info", "list-bulleted", "location", "lock", "map", "menu-horizontal", "menu-vertical", "menu", "minus", "mobile", "note", "order", "organization", "plus", "profile", "question-circle-filled", "question-circle", "reorder", "reset", "return", "savings", "search", "settings", "star-filled", "star-half", "star", "store", "truck", "upload", "x-circle-filled", "x-circle", "x"]; export type ReducedIconTypes = (typeof CHECKOUT_AVAILABLE_ICONS)[number]; +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; @@ -62,6 +68,7 @@ declare module 'preact' { } declare const tagName = "s-text-field"; +/** @publicDocs */ export interface TextFieldElementProps extends Pick { icon?: IconProps['type']; /** @@ -72,36 +79,37 @@ export interface TextFieldElementProps extends Pick { } +/** @publicDocs */ export interface TextFieldElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the text field loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the text field value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the text field receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the text field. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; } +/** @publicDocs */ export interface TextFieldElementSlots { /** - * Additional content to be displayed in the field. - * Commonly used to display an icon that activates a tooltip providing more information. + * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported. */ accessory?: HTMLElement; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/TextField/TextField.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/TextField/TextField.doc.ts deleted file mode 100644 index 2e40da38e5..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/TextField/TextField.doc.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/TextField'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true, slots: true}, - bestPractices: ` -- Clearly label text fields so that it’s obvious what customers should enter. -- Label text fields as optional when input isn’t required. For example, use the label First name (optional). -- Don’t have optional fields pass true to the required property.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Time.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Time.d.ts index 424d25e47f..2310af98ea 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Time.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Time.d.ts @@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-time"; +/** @publicDocs */ export interface TimeElementProps extends Pick { } export interface TimeElement extends TimeElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Time/Time.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Time/Time.doc.ts deleted file mode 100644 index dd7e0a02da..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Time/Time.doc.ts +++ /dev/null @@ -1,13 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Time'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - bestPractices: - '- Use Time component for displaying time values to ensure consistent formatting.\n\n- Provide time values in a clear, readable format.\n\n- Consider using 24-hour format for international audiences.\n\n- Include timezone information when relevant.\n\n- Use Time component for any time-related content to maintain semantic meaning.', -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Tooltip.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/Tooltip.d.ts index b43166647f..2aaf0aecf8 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/Tooltip.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/Tooltip.d.ts @@ -11,25 +11,44 @@ import type {TooltipProps$1} from './components-shared.d.ts'; /** - * Used when an element does not have children. + * The base properties for elements that don't have children, providing essential attributes like keys and refs for component management. */ export interface BaseElementProps { + /** + * A unique identifier for this element within its parent. Used by the rendering engine for efficient reconciliation when lists change. + */ key?: preact.Key; + /** + * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic. + */ ref?: preact.Ref; + /** + * Assigns this element to a named slot in a parent component that uses slot-based composition patterns. + */ slot?: Lowercase; } /** - * Used when an element has children. + * The base properties for elements that have children, extending `BaseElementProps` with children support. */ export interface BaseElementPropsWithChildren extends BaseElementProps { + /** + * The child elements to render within this component. + */ children?: preact.ComponentChildren; } declare const tagName = "s-tooltip"; +/** @publicDocs */ export interface TooltipElementProps extends Pick { } +/** + * The HTML element interface for the `s-tooltip` custom element. + */ export interface TooltipElement extends TooltipElementProps { } +/** + * The properties for the tooltip component when it's used in JSX. + */ export interface TooltipProps extends TooltipElementProps { } declare global { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/Tooltip/Tooltip.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/Tooltip/Tooltip.doc.ts deleted file mode 100644 index 32a3fa8534..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/Tooltip/Tooltip.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/Tooltip'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/UnorderedList.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/UnorderedList.d.ts index 35cdea63a8..373a9a5372 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/UnorderedList.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/UnorderedList.d.ts @@ -26,6 +26,7 @@ export interface BaseElementPropsWithChildren extends Base } declare const tagName = "s-unordered-list"; +/** @publicDocs */ export interface UnorderedListElementProps extends UnorderedListProps$1 { } export interface UnorderedListElement extends UnorderedListElementProps, Omit { diff --git a/packages/ui-extensions/src/surfaces/checkout/components/UnorderedList/UnorderedList.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/UnorderedList/UnorderedList.doc.ts deleted file mode 100644 index cb20ce0ce4..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/UnorderedList/UnorderedList.doc.ts +++ /dev/null @@ -1,22 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/UnorderedList'; -import listItemSharedContent from '../../../../docs/shared/components/ListItem'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true}, - subcomponent: { - ...listItemSharedContent, - definitions: {properties: true}, - }, - bestPractices: ` -- Use \`s-unordered-list\` when you need to present a list of related items or options. -- Each item in the list should be wrapped in a \`s-list-item\` component. -- Keep list items concise and consistent in length when possible. -- Use \`s-unordered-list\` for navigation menus, feature lists, or any collection of related items. -- Consider using \`s-unordered-list\` when you want to present information in a clear, scannable format.`, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/UrlField.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/UrlField.d.ts index 1825be84d2..a52b8ac5e4 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/UrlField.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/UrlField.d.ts @@ -24,48 +24,56 @@ export interface BaseElementProps { export interface BaseElementPropsWithChildren extends BaseElementProps { children?: preact.ComponentChildren; } +/** + * An event type that narrows the `currentTarget` to the specific HTML element associated with the custom element tag. This provides type-safe event handling in callback listeners. + */ export type CallbackEvent = TEvent & { currentTarget: HTMLElementTagNameMap[TTagName]; }; +/** + * A typed event listener for custom element events. The listener receives a `CallbackEvent` with the correct `currentTarget` type for the associated custom element tag. + */ export type CallbackEventListener = (EventListener & { (event: CallbackEvent & TData): void; }) | null; declare const tagName = "s-url-field"; +/** @publicDocs */ export interface URLFieldElementProps extends Pick { } export interface UrlFieldEvents extends Pick { } +/** @publicDocs */ export interface URLFieldElementEvents { /** - * Callback when the element loses focus. + * A callback fired when the URL field loses focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ blur?: CallbackEventListener; /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the URL field value changes. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ change?: CallbackEventListener; /** - * Callback when the element receives focus. + * A callback fired when the URL field receives focus. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ focus?: CallbackEventListener; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user inputs data into the URL field. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/Element/input_event). */ input?: CallbackEventListener; } +/** @publicDocs */ export interface URLFieldElementSlots { /** - * Additional content to be displayed in the field. - * Commonly used to display an icon that activates a tooltip providing more information. + * Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported. */ accessory?: HTMLElement; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/UrlField/UrlField.doc.ts b/packages/ui-extensions/src/surfaces/checkout/components/UrlField/UrlField.doc.ts deleted file mode 100644 index 642200e136..0000000000 --- a/packages/ui-extensions/src/surfaces/checkout/components/UrlField/UrlField.doc.ts +++ /dev/null @@ -1,11 +0,0 @@ -import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; - -import sharedContent from '../../../../docs/shared/components/URLField'; -import {createComponentDoc} from '../../../../docs/shared/component-definitions'; - -const data: ReferenceEntityTemplateSchema = createComponentDoc({ - ...sharedContent, - definitions: {properties: true, events: true, slots: true}, -}); - -export default data; diff --git a/packages/ui-extensions/src/surfaces/checkout/components/components-shared.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/components-shared.d.ts index fbd964d990..3a1eb575cb 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/components-shared.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/components-shared.d.ts @@ -14,23 +14,21 @@ export type ComponentChildren = any; export type StringChildren = string; export interface GlobalProps { /** - * A unique identifier for the element. + * A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting. */ id?: string; } interface AbbreviationProps$1 extends GlobalProps { /** - * The content of the abbreviation or acronym. + * The abbreviated text content displayed within the abbreviation component. Pair with the `title` attribute to provide the full expansion for accessibility. */ children?: ComponentChildren; /** - * Defines the full expansion of the abbreviation or acronym. + * Defines the full expansion of the abbreviation or acronym. Helps user agents and users understand the meaning of the abbreviated text. * - * Helps user agents and users understand the meaning of the abbreviated text. + * Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr). * * @default '' - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr */ title?: string; } @@ -46,19 +44,19 @@ export interface ActionSlots { } export interface BaseOverlayProps { /** - * Callback fired after the overlay is shown. + * A callback fired immediately after the overlay is shown. */ onShow?: (event: Event) => void; /** - * Callback fired when the overlay is shown **after** any animations to show the overlay have finished. + * A callback fired when the overlay is shown, after any show animations have completed. */ onAfterShow?: (event: Event) => void; /** - * Callback fired after the overlay is hidden. + * A callback fired immediately after the overlay is hidden. */ onHide?: (event: Event) => void; /** - * Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished. + * A callback fired when the overlay is hidden, after any hide animations have completed. */ onAfterHide?: (event: Event) => void; } @@ -72,19 +70,19 @@ export interface BaseOverlayProps { */ export interface BaseOverlayMethods { /** - * Method to show an overlay. + * A method to programmatically show the overlay. * * @implementation This is a method to be called on the element and not a callback and should hence be camelCase */ showOverlay: () => void; /** - * Method to hide an overlay. + * A method to programmatically hide the overlay and run any associated hide animations. * * @implementation This is a method to be called on the element and not a callback and should hence be camelCase */ hideOverlay: () => void; /** - * Method to toggle the visiblity of an overlay. + * A method to programmatically toggle the visibility of the overlay. * * @implementation This is a method to be called on the element and not a callback and should hence be camelCase */ @@ -92,48 +90,56 @@ export interface BaseOverlayMethods { } export interface FocusEventProps { /** - * Callback when the element loses focus. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event + * A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event). */ onBlur?: (event: FocusEvent) => void; /** - * Callback when the element receives focus. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event + * A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event). */ onFocus?: (event: FocusEvent) => void; } export interface ToggleEventProps { /** - * Callback fired when the element state changes **after** any animations have finished. + * A callback fired when the element state changes, after any toggle animations have finished. * * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties. */ onAfterToggle?: (event: ToggleEvent$1) => void; /** - * Callback straight after the element state changes. + * A callback fired immediately when the element state changes, before any animations. * * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. - * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the + * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and the [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState). */ onToggle?: (event: ToggleEvent$1) => void; } +/** + * The visibility state of a toggleable element. + * + * - `open`: The element is visible and showing its content. + * - `closed`: The element is hidden and its content is not visible. + */ export type ToggleState = "open" | "closed"; +/** + * The event data provided to toggle-related callbacks. Contains the previous and next visibility states of the element. + */ interface ToggleEvent$1 extends Event { + /** + * The visibility state of the element after the toggle occurred. + */ readonly newState: ToggleState; + /** + * The visibility state of the element before the toggle occurred. + */ readonly oldState: ToggleState; } export interface ExtendableEvent extends Event { @@ -153,8 +159,7 @@ interface AnnouncementProps$1 extends GlobalProps, ToggleEventProps { */ children?: ComponentChildren; /** - * Callback fired when the announcement is dismissed by the user - * (either via the built-in dismiss button or programmatically). + * A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically. */ onDismiss?: (event: Event) => void; /** @@ -162,12 +167,32 @@ interface AnnouncementProps$1 extends GlobalProps, ToggleEventProps { */ dismiss: () => void; } +/** + * The design system's size scale, used to control the dimensions of components like avatars, icons, and thumbnails. Values range from `"small-500"` (smallest) through `"base"` (standard) to `"large-500"` (largest). Not all components support every size — check the component's `size` property type for its available options. + */ export type SizeKeyword = "small-500" | "small-400" | "small-300" | "small-200" | "small-100" | "small" | "base" | "large" | "large-100" | "large-200" | "large-300" | "large-400" | "large-500"; +/** + * Defines the color intensity or emphasis level for text and UI elements. + * + * - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements. + * - `base`: Primary color for body text, standard UI elements, and general content with good readability. + * - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence. + */ export type ColorKeyword = "subdued" | "base" | "strong"; export type BackgroundColorKeyword = "transparent" | ColorKeyword; export interface BackgroundProps { /** - * Adjust the background of the element. + * The background color of the element. + * + * - `base`: The standard background color for general content areas. + * - `subdued`: A muted background for secondary or supporting content. + * - `transparent`: No background color (the default). + * - `strong`: An emphasized background for prominent sections. + * + * - `'transparent'`: No visible background. + * - `'subdued'`: A subtle, low-emphasis background. + * - `'base'`: The standard background color. + * - `'strong'`: A high-emphasis background for prominence. * * @default 'transparent' */ @@ -738,8 +763,28 @@ export type IconType = (typeof privateIconArray)[number]; * Like `Extract`, but ensures that the extracted type is a strict subtype of the input type. */ export type ExtractStrict = Extract; +/** + * Represents CSS shorthand properties that accept one to four values, following the [CSS shorthand syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box). Supports specifying values for all four sides: top, right, bottom, and left. + * + * - `T`: Single value that applies to all four sides. + * - `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right). + * - `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom). + * - `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left). + */ export type MaybeAllValuesShorthandProperty = T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`; +/** + * Represents CSS shorthand properties that accept one or two values. Supports specifying the same value for both dimensions or different values. + * + * - `T`: Single value that applies to both dimensions. + * - `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal). + */ export type MaybeTwoValuesShorthandProperty = T | `${T} ${T}`; +/** + * Makes a property responsive by allowing it to be set conditionally based on container query conditions. The value can be either a base value or a container query string. + * + * - `T`: Base value that applies in all conditions. + * - `@container${string}`: Container query string for conditional responsive styling based on container size. + */ export type MaybeResponsive = T | `@container${string}`; /** * Prevents widening string literal types in a union to `string`. @@ -763,29 +808,34 @@ interface BadgeProps$1 extends GlobalProps { */ children?: ComponentChildren; /** - * Sets the tone of the Badge, based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the badge. * * @default 'auto' */ tone?: ToneKeyword; /** - * Modify the color to be more or less intense. + * Controls the visual weight and emphasis of the badge. * * @default 'base' */ color?: ColorKeyword; /** - * The type of icon to be displayed in the badge. + * An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon. + * + * Always positioned relative to the text content. Independent positioning isn't supported. * * @default '' */ icon?: IconType | AnyString; /** - * The position of the icon in relation to the text. + * The position of the icon relative to the badge text. + * + * - `start`: Places the icon before the text. + * - `end`: Places the icon after the text. */ iconPosition?: "start" | "end"; /** - * Adjusts the size. + * The size of the badge. * * @default 'base' */ @@ -793,42 +843,34 @@ interface BadgeProps$1 extends GlobalProps { } interface BannerProps$1 extends GlobalProps, ActionSlots { /** - * The title of the banner. + * The heading text displayed at the top of the banner to summarize the message or alert. * * @default '' */ heading?: string; /** - * The content of the Banner. + * The main content displayed within the banner component, typically descriptive text or other elements providing details about the message or alert. */ children?: ComponentChildren; /** - * 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. + * The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected. * - * - `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. - * - * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions - * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role - * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role + * The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `neutral`, `info`, `success`, `warning`, and `caution` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message. * * @default 'auto' */ tone?: ToneKeyword; /** - * Makes the content collapsible. - * A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them. + * Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them. * * @default false */ collapsible?: boolean; /** - * Determines whether the close button of the banner is present. + * Whether the banner displays a close button that allows users to dismiss it. * * When the close button is pressed, the `dismiss` event will fire, - * then `hidden` will be true, + * then `hidden` will be set to `true`, * any animation will complete, * and the `afterhide` event will fire. * @@ -836,31 +878,26 @@ interface BannerProps$1 extends GlobalProps, ActionSlots { */ dismissible?: boolean; /** - * Event handler when the banner is dismissed by the user. + * A callback that fires when the banner is dismissed by the user clicking the close button. * - * This does not fire when setting `hidden` manually. + * This doesn't fire when setting `hidden` manually. * - * The `hidden` property will be `false` when this event fires. + * The `hidden` property is `false` when this event fires. */ onDismiss?: (event: Event) => void; /** - * Event handler when the banner has fully hidden. - * - * The `hidden` property will be `true` when this event fires. + * A callback that fires when the banner has fully hidden, including after any hide animations have completed. * - * @implementation If implementations animate the hiding of the banner, - * this event must fire after the banner has fully hidden. - * We can add an `onHide` event in future if we want to provide a hook for the start of the animation. + * The `hidden` property is `true` when this event fires. */ onAfterHide?: (event: Event) => void; /** - * Determines whether the banner is hidden. + * Controls whether the banner is visible or 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. + * When using a controlled component pattern and the banner is `dismissible`, + * update this property to `true` when the `dismiss` event fires. * - * If the banner is not `dismissible`, it can still be hidden by setting this property. + * You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`. * * @default false */ @@ -870,27 +907,43 @@ export interface DisplayProps { /** * Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). * - * - `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. + * - `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. + * + * Learn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/display * @default 'auto' */ display?: MaybeResponsive<"auto" | "none">; } export interface AccessibilityRoleProps { /** - * 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. - * - * @implementation Although, in HTML hosts, this property changes the element used, - * changing this property must not impact the visual styling of inside or outside of the box. + * The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page. * * @default 'generic' */ accessibilityRole?: AccessibilityRole; } +/** + * The semantic role of a component, used by assistive technologies to convey the element's purpose to users. Each role maps to a specific HTML element or ARIA role. + * + * - `main`: The primary content of the page. + * - `header`: A page or section header. + * - `footer`: Information such as copyright, navigation links, and privacy statements. + * - `section`: A generic section that should have a heading or `accessibilityLabel`. + * - `aside`: Supporting content related to the main content. + * - `navigation`: A major group of navigation links. + * - `ordered-list`: A list of ordered items. + * - `list-item`: An item inside a list. + * - `list-item-separator`: A divider between list items. + * - `unordered-list`: A list of unordered items. + * - `separator`: A divider that separates sections of content. + * - `status`: A live region with advisory information that is not urgent. + * - `alert`: Important, usually time-sensitive information. + * - `generic`: A nameless container with no semantic meaning (renders a `
`). + * - `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`. + * - `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`. + */ export type AccessibilityRole = /** * Used to indicate the primary content. @@ -903,7 +956,7 @@ export type AccessibilityRole = * Used to indicate the component is a header. * * In an HTML host `header` will render a `
` element. - * Learn more about the [`
` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/main_role) in the MDN web docs. + * Learn more about the [`
` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/banner_role) in the MDN web docs. */ | "header" /** @@ -1008,11 +1061,11 @@ export type AccessibilityRole = | "none"; export interface AccessibilityVisibilityProps { /** - * Changes the visibility of the element. + * Controls how the element is exposed to sighted users and to assistive technologies such as screen readers. * - * - `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. + * - `visible`: The element is visible to all users (both sighted users and screen readers). + * - `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information. + * - `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context. * * @default 'visible' */ @@ -1020,162 +1073,198 @@ export interface AccessibilityVisibilityProps { } export interface LabelAccessibilityVisibilityProps { /** - * Changes the visibility of the component's label. + * Controls whether the label is visible to all users or only to screen readers. * - * - `visible`: the label is visible to all users. - * - `exclusive`: the label is visually hidden but remains in the accessibility tree. + * - `visible`: The label is shown to everyone. + * - `exclusive`: The label is visually hidden but still announced by screen readers. * * @default 'visible' */ labelAccessibilityVisibility?: ExtractStrict; } +/** + * Defines the padding size for elements, using the standard size scale or `none` for no padding. + * + * - `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing. + * - `none`: No padding. + */ export type PaddingKeyword = SizeKeyword | "none"; export interface PaddingProps { /** - * Adjust the padding of all edges. + * The padding applied to all edges of the component. * - * [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: + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values: + * - 1 value applies to all sides + * - 2 values apply to block (top/bottom) and inline (left/right) + * - 3 values apply to block-start (top), inline (left/right), and block-end (bottom) + * - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) * - * - 4 values: `block-start inline-end block-end inline-start` - * - 3 values: `block-start inline block-end` - * - 2 values: `block inline` + * **Examples:** `base`, `large none`, `base large-100 base small` * - * 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. + * Use `auto` to inherit padding from the nearest container with removed padding. * * @default 'none' */ padding?: MaybeResponsive>; /** - * Adjust the block-padding. + * The block-direction padding (top and bottom in horizontal writing modes). + * + * Accepts a single value for both sides or two space-separated values for block-start and block-end. * - * - `large none` means block-start padding is `large`, block-end padding is `none`. + * **Example:** `large none` applies `large` to the top and `none` to the bottom. * - * This overrides the block value of `padding`. + * Overrides the block value from `padding`. * * @default '' - meaning no override */ paddingBlock?: MaybeResponsive | "">; /** - * Adjust the block-start padding. + * The block-start padding (top in horizontal writing modes). * - * This overrides the block-start value of `paddingBlock`. + * Overrides the block-start value from `paddingBlock`. * * @default '' - meaning no override */ paddingBlockStart?: MaybeResponsive; /** - * Adjust the block-end padding. + * The block-end padding (bottom in horizontal writing modes). * - * This overrides the block-end value of `paddingBlock`. + * Overrides the block-end value from `paddingBlock`. * * @default '' - meaning no override */ paddingBlockEnd?: MaybeResponsive; /** - * Adjust the inline padding. + * The inline-direction padding (left and right in horizontal writing modes). * - * - `large none` means inline-start padding is `large`, inline-end padding is `none`. + * Accepts a single value for both sides or two space-separated values for inline-start and inline-end. * - * This overrides the inline value of `padding`. + * **Example:** `large none` applies `large` to the left and `none` to the right. + * + * Overrides the inline value from `padding`. * * @default '' - meaning no override */ paddingInline?: MaybeResponsive | "">; /** - * Adjust the inline-start padding. + * The inline-start padding (left in LTR writing modes, right in RTL). * - * This overrides the inline-start value of `paddingInline`. + * Overrides the inline-start value from `paddingInline`. * * @default '' - meaning no override */ paddingInlineStart?: MaybeResponsive; /** - * Adjust the inline-end padding. + * The inline-end padding (right in LTR writing modes, left in RTL). * - * This overrides the inline-end value of `paddingInline`. + * Overrides the inline-end value from `paddingInline`. * * @default '' - meaning no override */ paddingInlineEnd?: MaybeResponsive; } +/** + * Represents size values in pixels, percentages, or zero. + * + * - `` `${number}px` ``: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`). + * - `` `${number}%` ``: Relative size as a percentage of the parent container (such as `50%`, `100%`). + * - `0`: Zero size, equivalent to no dimension. + */ export type SizeUnits = `${number}px` | `${number}%` | `0`; +/** + * Represents size values that can also be set to `auto` for automatic sizing. + * + * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control. + * - `auto`: Automatically sizes based on content and layout constraints. Learn more about the [auto value](https://developer.mozilla.org/en-US/docs/Web/CSS/width#auto). + */ export type SizeUnitsOrAuto = SizeUnits | "auto"; +/** + * Represents size values that can also be set to `none` to remove the size constraint. + * + * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control. + * - `none`: No size constraint, allowing unlimited growth. Learn more about the [none value](https://developer.mozilla.org/en-US/docs/Web/CSS/max-width#none). + */ export type SizeUnitsOrNone = SizeUnits | "none"; export interface SizingProps { /** - * Adjust the block size. + * The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/block-size + * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control. + * - `auto`: Automatically sizes based on content and layout constraints. * * @default 'auto' */ blockSize?: MaybeResponsive; /** - * Adjust the minimum block size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size + * The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size). * * @default '0' */ minBlockSize?: MaybeResponsive; /** - * Adjust the maximum block size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size + * The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size). * * @default 'none' */ maxBlockSize?: MaybeResponsive; /** - * Adjust the inline size. + * The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size + * - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control. + * - `auto`: Automatically sizes based on content and layout constraints. * * @default 'auto' */ inlineSize?: MaybeResponsive; /** - * Adjust the minimum inline size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size + * The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size). * * @default '0' */ minInlineSize?: MaybeResponsive; /** - * Adjust the maximum inline size. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size + * The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size). * * @default 'none' */ maxInlineSize?: MaybeResponsive; } +/** + * The visual style of a border. Learn more about [border-style](https://developer.mozilla.org/en-US/docs/Web/CSS/border-style). + * + * - `"none"`: No border is rendered. + * - `"solid"`: A single continuous line. + * - `"dashed"`: A series of short dashes. + * - `"dotted"`: A series of round dots. + * - `"auto"`: The border style is determined automatically based on the surface's design system. + */ export type BorderStyleKeyword = "none" | "solid" | "dashed" | "dotted" | "auto"; +/** + * Defines the width of borders, using the standard size scale or `none` for no border. + * + * - `SizeKeyword`: Standard border widths from the size scale for consistent thickness. + * - `none`: No border width (removes the border). + */ export type BorderSizeKeyword = SizeKeyword | "none"; +/** + * The corner radius of a border, using the design system's `SizeKeyword` scale with additional options: + * + * - `"max"`: The maximum possible radius, creating a pill or circular shape. + * - `"none"`: No rounding — corners are sharp (0 radius). + */ export type BorderRadiusKeyword = SizeKeyword | "max" | "none"; /** - * Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style. + * A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base strong'`), or size with color and style (`'base strong dashed'`). Omitted values use their defaults. */ export type BorderShorthand = BorderSizeKeyword | `${BorderSizeKeyword} ${ColorKeyword}` | `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`; export interface BorderProps { /** - * Set the border via the shorthand property. - * - * This can be a size, optionally followed by a color, optionally followed by a style. + * Applies a border using shorthand syntax to specify width, color, and style in a single property. * - * If the color is not specified, it will be `base`. + * Accepts a size value, optionally followed by a color, optionally followed by a style. + * Omitted values use defaults: color defaults to `base`, style defaults to `auto`. * - * If the style is not specified, it will be `auto`. - * - * Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`. + * Individual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here. * * @example * // The following are equivalent: @@ -1186,64 +1275,54 @@ export interface BorderProps { */ border?: BorderShorthand; /** - * Set the width of the border. - * - * If set, it takes precedence over the `border` property's width. - * - * Like CSS, up to 4 values can be specified. - * - * If one value is specified, it applies to all sides. - * - * If two values are specified, they apply to the block sides and inline sides respectively. - * - * If three values are specified, they apply to the block-start, both inline sides, and block-end respectively. + * Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property. * - * If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively. + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side: + * - One value: applies to all sides + * - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively + * - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively + * - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively * * @default '' - meaning no override */ borderWidth?: MaybeAllValuesShorthandProperty | ""; /** - * Set the style of the border. + * Controls the visual style of the border on all sides, such as solid, dashed, or dotted. * - * If set, it takes precedence over the `border` property's style. + * When set, this overrides the style value specified in the `border` property. * - * Like CSS, up to 4 values can be specified. - * - * If one value is specified, it applies to all sides. - * - * If two values are specified, they apply to the block sides and inline sides respectively. - * - * If three values are specified, they apply to the block-start, both inline sides, and block-end respectively. - * - * If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively. + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side: + * - One value: applies to all sides + * - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively + * - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively + * - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively * * @default '' - meaning no override */ borderStyle?: MaybeAllValuesShorthandProperty | ""; /** - * Set the color of the border. + * Controls the color of the border using the design system's color scale. * - * If set, it takes precedence over the `border` property's color. + * When set, this overrides the color value specified in the `border` property. + * Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed. * * @default '' - meaning no override */ borderColor?: ColorKeyword | ""; /** - * Set the radius of the border. - * - * [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: + * Controls the roundedness of the element's corners using the design system's radius scale. * - * - 4 values: `start-start start-end end-end end-start` - * - 3 values: `start-start (start-end & end-start) start-end` - * - 2 values: `(start-start & end-end) (start-end & end-start)` + * Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values: + * - One value: applies to all corners + * - Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively + * - Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively + * - Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively * - * For example: - * - `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`. - * - `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`. - * - `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`. - * - `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`. + * Examples: + * - `small-100`: All corners have `small-100` radius + * - `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none` + * - `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100` + * - `small-100 none large-100 base`: Each corner has its specified radius value * * @defaultValue 'none' */ @@ -1251,12 +1330,10 @@ export interface BorderProps { } export interface OverflowProps { /** - * Sets the overflow behavior of the element. + * 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. + * - `visible`: Content that extends beyond the container is visible. + * - `hidden`: Content that extends beyond the container is clipped and not scrollable. * * @default 'visible' */ @@ -1264,14 +1341,11 @@ export interface OverflowProps { } export interface BaseBoxProps extends AccessibilityVisibilityProps, BackgroundProps, DisplayProps, SizingProps, PaddingProps, BorderProps, OverflowProps { /** - * The content of the Box. + * The child elements to render inside the container. */ children?: ComponentChildren; /** - * 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. + * A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own. */ accessibilityLabel?: string; } @@ -1281,34 +1355,28 @@ interface BoxProps$1 extends BaseBoxPropsWithRole, GlobalProps { } export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps { /** - * 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). + * The behavioral type of the button component, which determines what action it performs when activated. + * - `'submit'`: Submits the nearest containing form. + * - `'button'`: Performs no default action, relying on the `click` event handler for behavior. + * - `'reset'`: Resets all fields in the nearest containing form to their default values. * - * This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set. + * This property is ignored if `href` or `commandFor`/`command` is set. * * @default 'button' */ type?: "submit" | "button" | "reset"; /** - * Callback when the Button is activated. - * This will be called before the action indicated by `type`. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event + * A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event). */ onClick?: (event: Event) => void; /** - * Disables the Button meaning it cannot be clicked or receive focus. + * Whether the button is disabled, preventing it from being clicked or receiving focus. * * @default false */ disabled?: boolean; /** - * Replaces content with a loading indicator while a background action is being performed. - * - * This also disables the Button. + * Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed. This also disables the button. * * @default false */ @@ -1316,18 +1384,14 @@ export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps { } export interface LinkBehaviorProps extends InteractionProps, FocusEventProps { /** - * 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. + * The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation. */ href?: string; /** - * Specifies where to display the linked URL. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target + * Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target). * - * 'auto': The target is automatically determined based on the origin of the URL. + * - `'auto'`: Opens the URL in the current frame or a new tab, depending on the context. + * - `'_blank'`: Opens the URL in a new tab or window. * * @implementation Surfaces can set specific rules on how they handle each URL. * @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases. @@ -1337,46 +1401,37 @@ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps { */ target?: "auto" | "_blank" | "_self" | "_parent" | "_top" | AnyString; /** - * 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. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download + * A filename that causes the browser to treat the linked URL as a download. Download is only supported for same-origin URLs, or `blob:` and `data:` schemes. Learn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download). */ download?: string; /** - * Callback when the link is activated. - * This will be called before navigating to the location specified by `href`. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event + * A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event). */ onClick?: (event: Event) => void; } export interface InteractionProps { /** - * ID of a component that should respond to activations (e.g. clicks) on this component. + * The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor). * - * See `command` for how to control the behavior of the target. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor + * When both `commandFor` and `href` are set, `commandFor` takes precedence. The command runs and the link doesn't navigate. */ commandFor?: string; /** - * Sets the action the `commandFor` should take when this clickable is activated. + * Sets the action the `commandFor` target should take when this component is activated. Available options: * - * See the documentation of particular components for the actions they support. + * - `'--auto'`: Performs the default action appropriate for the target component. + * - `'--show'`: Displays the target component if it's currently hidden. + * - `'--hide'`: Conceals the target component from view. + * - `'--toggle'`: Alternates the target component between visible and hidden states. + * - `'--copy'`: Copies the target clipboard item. * - * - `--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. + * The supported actions vary by target component type. Learn more about the [`command` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command). * * @default '--auto' - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command */ command?: "--auto" | "--show" | "--hide" | "--toggle" | "--copy"; /** - * ID of a component that should respond to interest (e.g. hover and focus) on this component. + * The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code). */ interestFor?: string; } @@ -1384,58 +1439,62 @@ export interface BaseClickableProps extends ButtonBehaviorProps, LinkBehaviorPro } interface ButtonProps$1 extends GlobalProps, BaseClickableProps { /** - * 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. + * A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context. */ accessibilityLabel?: string; /** - * The content of the Button. + * The content displayed within the button component. */ children?: ComponentChildren; /** - * The type of icon to be displayed in the Button. + * An icon displayed inside the button, typically positioned before the button text. * * @default '' */ icon?: IconType | AnyString; /** - * The displayed inline width of the Button. + * The inline width of the button component. * - * - `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. + * - `'auto'`: The size depends on the surface and context. + * - `'fill'`: The button takes up 100% of the available inline size. + * - `'fit-content'`: The button takes up the minimum inline size required to fit its content. * * @default 'auto' */ inlineSize?: "auto" | "fill" | "fit-content"; /** - * Changes the visual appearance of the Button. + * The visual style variant of the button component, which controls its prominence and emphasis. + * + * - `'auto'`: Automatically determined by the button's context. + * - `'primary'`: High-emphasis style for the main action. + * - `'secondary'`: Medium-emphasis style for supporting actions. + * - `'tertiary'`: Low-emphasis style for less prominent actions. * - * @default 'auto' - the variant is automatically determined by the Button's context + * @default 'auto' */ variant?: "auto" | "primary" | "secondary" | "tertiary"; /** - * Sets the tone of the Button based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the button. + * + * - `'auto'`: Automatically determined based on context. + * - `'neutral'`: General information without specific intent. + * - `'critical'`: Urgent problems or destructive actions. * * @default 'auto' */ tone?: ToneKeyword; /** - * 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) + * The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label). */ lang?: string; } export interface BaseInputProps { /** - * An identifier for the field that is unique within the nearest containing form. + * The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form. */ name?: string; /** - * Disables the field, disallowing any interaction. + * Whether the field is disabled, preventing any user interaction. * * @default false */ @@ -1443,15 +1502,15 @@ export interface BaseInputProps { } export interface InputProps extends BaseInputProps { /** - * Callback when the user has **finished editing** a field, e.g. once they have blurred the field. + * A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter. * * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event */ onChange?: (event: Event) => void; /** - * Callback when the user makes any changes in the field. + * A callback fired when the user makes any changes in the field, such as typing a character. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). */ onInput?: (event: Event) => void; /** @@ -1459,7 +1518,7 @@ export interface InputProps extends BaseInputProps { */ value?: string; /** - * The default value for the field. + * The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value. * * @implementation `defaultValue` reflects to the `value` attribute. */ @@ -1467,31 +1526,33 @@ export interface InputProps extends BaseInputProps { } export interface MultipleInputProps extends BaseInputProps { /** - * Callback when the user has selected option(s). + * A callback fired when the user has selected one or more options. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event + * Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event). */ onChange?: (event: Event) => void; /** - * Callback when the user has selected option(s). + * A callback fired when the user selects or deselects options. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event + * Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event). */ onInput?: (event: Event) => void; /** - * An array of the `value`s of the selected options. + * An array of `value` attributes for the currently selected options. * * This is a convenience prop for setting the `selected` prop on child options. + * + * Form data captures the selected value strings only. Complex nested content inside choices is for display purposes and isn't included in form submissions. */ values?: string[]; } export interface FileInputProps extends BaseInputProps { /** - * Callback when the user has **finished selecting** a file or files. + * A callback fired when the user has finished selecting one or more files. */ onChange?: (event: Event) => void; /** - * Callback when the user makes any changes in the file selection. + * A callback fired when the user makes any changes to the file selection. */ onInput?: (event: Event) => void; /** @@ -1516,8 +1577,7 @@ export interface FileInputProps extends BaseInputProps { } export interface FieldErrorProps { /** - * Indicate an error to the user. The field will be given a specific stylistic treatment - * to communicate problems that have to be resolved immediately. + * An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers. */ error?: string; } @@ -1532,7 +1592,7 @@ export interface BasicFieldProps extends FieldErrorProps, LabelAccessibilityVisi */ required?: boolean; /** - * Content to use as the field label. + * The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide. */ label?: string; } @@ -1548,13 +1608,13 @@ export interface FieldDetailsProps { } export interface FieldProps extends BasicFieldProps, InputProps, FocusEventProps, FieldDetailsProps { /** - * A short hint that describes the expected value of the field. + * The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value. */ placeholder?: string; } export interface BaseTextFieldProps extends FieldProps { /** - * The field cannot be edited by the user. It is focusable will be announced by screen readers. + * Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers. * * @default false */ @@ -1566,7 +1626,7 @@ export interface FieldDecorationProps { * * 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. + * This can't 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. @@ -1579,7 +1639,7 @@ export interface FieldDecorationProps { * * 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. + * This can't 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. @@ -1604,8 +1664,7 @@ export interface NumberConstraintsProps { * 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. + * Note: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation. * * @default Infinity */ @@ -1614,8 +1673,7 @@ export interface NumberConstraintsProps { * 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. + * Note: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation. * * @default -Infinity */ @@ -1632,10 +1690,9 @@ export interface NumberConstraintsProps { /** * Sets the type of controls displayed in the field. * - * - `stepper`: displays buttons to increase or decrease the value of the field by the stepping interval defined in the `step` property. - * Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value of the field are enabled. - * - `none`: no controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes. - * - `auto`: the presence of the controls depends on the surface and context. + * - `'auto'`: The presence of the controls depends on the surface and context. + * - `'stepper'`: Displays buttons to increase or decrease the value by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value are enabled. + * - `'none'`: No controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes. * * @default 'auto' */ @@ -1649,7 +1706,7 @@ export interface MinMaxLengthProps { */ maxLength?: number; /** - * Specifies the min number of characters allowed. + * Specifies the minimum number of characters allowed. * * @default 0 */ @@ -1662,7 +1719,7 @@ export interface BaseSelectableProps { */ accessibilityLabel?: string; /** - * Disables the control, disallowing any interaction. + * Whether the control is disabled, preventing any user interaction. * * @default false */ @@ -1674,13 +1731,13 @@ export interface BaseSelectableProps { } export interface BaseOptionProps extends BaseSelectableProps { /** - * Whether the control is active. + * Whether the control is currently selected. * * @default false */ selected?: boolean; /** - * Whether the control is active by default. + * Whether the control is selected by default. * * @implementation `defaultSelected` reflects to the `selected` attribute. * @@ -1690,17 +1747,17 @@ export interface BaseOptionProps extends BaseSelectableProps { } export interface BaseCheckableProps extends BaseSelectableProps, InteractionProps { /** - * Visual content to use as the control label. + * The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility. */ label?: string; /** - * Whether the control is active. + * Whether the control is currently checked. * * @default false */ checked?: boolean; /** - * Whether the control is active by default. + * Whether the control is checked by default. * * @implementation `defaultChecked` reflects to the `checked` attribute. * @@ -1708,8 +1765,7 @@ export interface BaseCheckableProps extends BaseSelectableProps, InteractionProp */ defaultChecked?: boolean; /** - * An identifier for the control that is unique within the nearest - * containing `Form` component. + * The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form. */ name?: string; /** @@ -1755,27 +1811,33 @@ interface CheckboxProps$1 extends GlobalProps, BaseCheckableProps, FieldErrorPro * If you want to present an error when this field is empty, you can do * so with the `error` property. * + * Adds semantic meaning for accessibility. Doesn't trigger automatic validation or display an error. Implement validation logic yourself and use the `error` prop to show results. + * * @default false */ required?: boolean; } export interface ChipProps$1 { /** - * The content of the chip. + * The text label displayed within the chip, which identifies the chip's value or category to users. */ children?: ComponentChildren; /** - * The graphic to display inside of the chip. + * An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label. * * @implementation Only `s-icon` is supported. */ graphic?: ComponentChildren; /** - * A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers. + * A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers. */ accessibilityLabel?: string; /** - * Modify the color to be more or less intense. + * The color emphasis level that controls visual intensity. + * + * - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements. + * - `base`: Primary color for body text, standard UI elements, and general content with good readability. + * - `strong`: Higher-contrast color for text that needs more emphasis than `base`. * * @default 'base' */ @@ -1806,13 +1868,13 @@ interface ChoiceProps$1 extends GlobalProps, BaseOptionProps { */ details?: ComponentChildren; /** - * Set to `true` to associate a choice with the error passed to `ChoiceList` + * Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error. * * @default false */ error?: boolean; /** - * Secondary content for a choice. + * Additional text or elements displayed below the choice label, providing extra context or detail to help users make a selection. */ secondaryContent?: ComponentChildren; /** @@ -1836,7 +1898,7 @@ interface ChoiceListProps$1 extends GlobalProps, Pick void; /** - * The URL to link to. - * - * - If set, it will navigate to the location specified by `href` after executing the `click` event. + * The URL to link to. When set, the chip navigates to the specified location after the `click` event fires. */ href?: string; /** - * Whether the chip is removable. + * Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event. * * @default false */ removable?: boolean; /** - * Callback when the chip is removed. + * A callback fired when the chip is removed by the user clicking the remove button. */ onRemove?: (event: Event) => void; /** @@ -1917,11 +1979,13 @@ interface ClickableChipProps$1 extends ChipProps$1, GlobalProps { * * If the chip is not `removable`, it can still be hidden by setting this property. * + * When using the `removable` variant, keep `hidden` synced with your app state. If `hidden` isn't updated after the chip is removed, the chip can become permanently hidden. + * * @default false */ hidden?: boolean; /** - * Event handler when the chip has fully hidden. + * A callback fired when the chip has fully hidden after a removal animation. * * The `hidden` property will be `true` when this event fires. * @@ -1931,7 +1995,7 @@ interface ClickableChipProps$1 extends ChipProps$1, GlobalProps { */ onAfterHide?: (event: Event) => void; /** - * Disables the chip, disallowing any interaction. + * Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive. * * @default false */ @@ -1941,6 +2005,8 @@ interface ClipboardItemProps$1 extends GlobalProps { /** * Plain text to be written to the clipboard. * + * Rich text, HTML, and binary content aren't supported. + * * @default '' */ text?: string; @@ -1955,7 +2021,7 @@ interface ClipboardItemProps$1 extends GlobalProps { } export interface AutocompleteProps { /** - * A hint as to the intended content of the field. + * A hint about the intended content of the field for browser autofill. * * 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 @@ -1967,12 +2033,9 @@ export interface AutocompleteProps; +/** + * The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested. + * @publicDocs + */ export type ConsentPolicy = "sms-marketing"; interface ConsentCheckboxProps$1 extends GlobalProps, CheckboxProps$1 { /** - * The policy for which user consent is being collected for. + * The policy for which user consent is being collected. * - * `sms-marketing`: Represents the policy for SMS marketing consent. + * Only `sms-marketing` is supported. Other consent policy types aren't available through this component. */ policy?: ConsentPolicy; } export type PhoneAutocompleteField = ExtractStrict; interface PhoneFieldProps$1 extends GlobalProps, BaseTextFieldProps, Pick, AutocompleteProps { /** - * The type of number to collect. + * The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type. * - * Specific style may be applied to each type to provide extra guidance to users. Note that no extra validation is performed based on the type. + * Styling hint for the input keyboard. Doesn't validate the phone number format. Implement validation in your extension and use the `error` prop to show results. * - * @default '' meaning no specific kind of phone number + * @default '' */ type?: "mobile" | ""; } interface ConsentPhoneFieldProps$1 extends GlobalProps, PhoneFieldProps$1 { /** - * The policy for which user consent is being collected for. + * The policy for which user consent is being collected. * - * `sms-marketing`: Represents the policy for SMS marketing consent. + * Only `sms-marketing` is supported. */ policy?: ConsentPolicy; } @@ -2056,9 +2123,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps { */ type?: "single" | "multiple" | "range"; /** - * Dates that can be selected. - * - * A comma-separated list of dates, date ranges. Whitespace is allowed after commas. + * Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas. * * The default `''` allows all dates. * @@ -2074,6 +2139,8 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps { * So `--2024` is equivalent to `--2024-12-31`. * - Whitespace is allowed either side of `--`. * + * Comma-separated list of allowed dates in `YYYY-MM-DD` format. + * * @default "" * * @example @@ -2101,6 +2168,8 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps { * So `--2024` is equivalent to `--2024-12-31`. * - Whitespace is allowed either side of `--`. * + * Comma-separated list of disallowed dates in `YYYY-MM-DD` format. + * * @default "" * * @example @@ -2109,7 +2178,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps { */ disallow?: string; /** - * Days of the week that can be selected. These intersect with the result of `allow` and `disallow`. + * Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024. * * A comma-separated list of days. Whitespace is allowed after commas. * @@ -2165,6 +2234,8 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps { * - 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. * + * Single dates use ISO 8601 format (`YYYY-MM-DD`); ranges use `YYYY-MM-DD--YYYY-MM-DD`. Locale-specific formats aren't supported. + * * @default "" */ value?: string; @@ -2189,47 +2260,42 @@ interface DateFieldProps$1 extends GlobalProps, BaseTextFieldProps, Pick void; } export type DateAutocompleteField = ExtractStrict; interface DetailsProps$1 extends GlobalProps, ToggleEventProps { /** - * The content of the details. + * The content displayed within the details component, which creates a collapsible disclosure widget. * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details + * Learn more about the [details element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details). */ children?: ComponentChildren; /** - * Name of the element. - * - * This can be used to create multiple named disclosure boxes that where only one can be open at a time. + * The `name` attribute for the element. Use this to create multiple named disclosure groups where only one can be open at a time. * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details#multiple_named_disclosure_boxes + * Learn more about [multiple named disclosure boxes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details#multiple_named_disclosure_boxes). */ name?: string; /** - * Whether the element is open. - * - * This does not reflect to any attribute. + * Whether the element is currently open and showing its content. Use this for controlled behavior where you manage the open state yourself. * * @default false */ open?: boolean; /** - * Indicates whether the element should be open by default. - * - * This reflects to the `open` attribute. + * Whether the element should be open when it first renders. Use this for uncontrolled behavior where the component manages its own open state after the initial render. * * @default false */ defaultOpen?: boolean; /** - * Sets the transition between the two states. + * Sets the animation transition between the open and closed states. + * + * - `none`: Disables all transition animations. + * - `auto`: Uses the default transition animation. * * @default 'auto' */ @@ -2237,13 +2303,20 @@ interface DetailsProps$1 extends GlobalProps, ToggleEventProps { } interface DividerProps$1 extends GlobalProps { /** - * Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values). + * The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values). + * + * - `inline`: A horizontal divider that separates content stacked vertically. + * - `block`: A vertical divider that separates content arranged horizontally. Requires a parent with a defined height to render visibly. * * @default 'inline' */ direction?: "inline" | "block"; /** - * Modify the color to be more or less intense. + * The visual emphasis of the divider's color. + * + * - `subdued`: A lighter divider for subtle separation. + * - `base`: The standard divider color for most contexts. + * - `strong`: A darker divider for stronger visual separation. * * @default 'base' */ @@ -2253,7 +2326,7 @@ interface DropZoneProps$1 extends GlobalProps, FileInputProps, BasicFieldProps { /** * 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 file extension starting with a period (".") character (such as .jpg, .pdf, .doc) * - A valid MIME type string with no extensions * * If omitted, all file types are accepted. @@ -2280,6 +2353,9 @@ interface DropZoneProps$1 extends GlobalProps, FileInputProps, BasicFieldProps { */ onDropRejected?: (event: Event) => void; } +/** + * Doesn't perform automatic format validation. Implement validation logic yourself and use the `error` prop to display results. + */ interface EmailFieldProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps { } export type EmailAutocompleteField = ExtractStrict; @@ -2311,29 +2387,31 @@ interface FormProps$1 extends GlobalProps { */ onReset?: (event: Event) => void; } +/** + * The amount of space between child elements. + * + * - `none`: No spacing. + * - `small-500`: The smallest spacing. + * - `small-400` / `small-300` / `small-200` / `small-100` / `small`: Progressively larger small spacings. + * - `base`: The standard spacing for most use cases. + * - `large` / `large-100` / `large-200` / `large-300` / `large-400` / `large-500`: Progressively larger spacings. + */ export type SpacingKeyword = SizeKeyword | "none"; export interface GapProps { /** - * Adjust spacing between elements. - * - * A single value applies to both axes. - * A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively. + * The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently. * * @default 'none' */ gap?: MaybeResponsive>; /** - * Adjust spacing between elements in the block axis. - * - * This overrides the row value of `gap`. + * The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`. * * @default '' - meaning no override */ rowGap?: MaybeResponsive; /** - * Adjust spacing between elements in the inline axis. - * - * This overrides the column value of `gap`. + * The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`. * * @default '' - meaning no override */ @@ -2344,108 +2422,80 @@ export type ContentDistribution = "space-between" | "space-around" | "space-even export type ContentPosition = "center" | "start" | "end"; export type OverflowPosition = `unsafe ${ContentPosition}` | `safe ${ContentPosition}`; /** - * Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items + * Controls the default inline-axis alignment for all items within a container. Learn more about [`justify-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items). */ export type JustifyItemsKeyword = "normal" | "stretch" | BaselinePosition | OverflowPosition | ContentPosition; /** - * Align items sets the align-self value on all direct children as a group. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items + * Controls how all direct children are aligned along the cross axis. Learn more about [`align-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items). */ export type AlignItemsKeyword = "normal" | "stretch" | BaselinePosition | OverflowPosition | ContentPosition; /** - * Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content + * Controls how space is distributed between and around content items along the main axis of a flex container or the inline axis of a grid container. Learn more about [`justify-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content). */ export type JustifyContentKeyword = "normal" | ContentDistribution | OverflowPosition | ContentPosition; /** - *Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis. - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content + * Controls the distribution of space between and around content items along the cross axis of a flex container or the block axis of a grid container. Learn more about [`align-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content). */ export type AlignContentKeyword = "normal" | BaselinePosition | ContentDistribution | OverflowPosition | ContentPosition; interface GridProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps { /** - Define columns and specify their size. - - @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns - @default 'none' - */ + * Defines the number and size of columns in the grid. Accepts any valid CSS [`grid-template-columns`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) value, such as `"1fr 2fr"` or `"repeat(3, 1fr)"`. + * + * @default 'none' + */ gridTemplateColumns?: MaybeResponsive; /** - Define rows and specify their size. - - @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows - @default 'none' - */ + * Defines the number and size of rows in the grid. Accepts any valid CSS [`grid-template-rows`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) value, such as `"auto 1fr"` or `"repeat(2, 100px)"`. + * + * @default 'none' + */ gridTemplateRows?: MaybeResponsive; /** - Aligns the grid items along the inline (row) axis. - - This overrides the inline value of `placeItems`. - - @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items - @default '' - meaning no override - */ + * Aligns grid items along the inline (row) axis. Overrides the inline value of `placeItems`. Learn more about [`justify-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items). + * + * @default '' - meaning no override + */ justifyItems?: MaybeResponsive; /** - Aligns the grid items along the block (column) axis. - - This overrides the block value of `placeItems`. - - @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items - @default '' - meaning no override - */ + * Aligns grid items along the block (column) axis. Overrides the block value of `placeItems`. Learn more about [`align-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items). + * + * @default '' - meaning no override + */ alignItems?: MaybeResponsive; /** - A shorthand property for `justify-items` and `align-items`. - - @see https://developer.mozilla.org/en-US/docs/Web/CSS/place-items - @default 'normal normal' - */ + * A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once. Learn more about [`place-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/place-items). + * + * @default 'normal normal' + */ placeItems?: MaybeResponsive<`${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword>; /** - Aligns the grid along the inline (row) axis. - - This overrides the inline value of `placeContent`. - - @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content - @default '' - meaning no override - */ + * Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Overrides the inline value of `placeContent`. Learn more about [`justify-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content). + * + * @default '' - meaning no override + */ justifyContent?: MaybeResponsive; /** - Aligns the grid along the block (column) axis. - - This overrides the block value of `placeContent`. - - @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content - @default '' - meaning no override - */ + * Controls how the grid's rows are distributed along the block (column) axis when there is extra space. Overrides the block value of `placeContent`. Learn more about [`align-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content). + * + * @default '' - meaning no override + */ alignContent?: MaybeResponsive; /** - A shorthand property for `justify-content` and `align-content`. - - @see https://developer.mozilla.org/en-US/docs/Web/CSS/place-content - @default 'normal normal' - */ + * A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once. Learn more about [`place-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/place-content). + * + * @default 'normal normal' + */ placeContent?: MaybeResponsive<`${AlignContentKeyword} ${JustifyContentKeyword}` | AlignContentKeyword>; } interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole { /** - * Number of columns the item will span across - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column + * The number of columns this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of columns. Learn more about [`grid-column`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column). * * @default 'auto' */ gridColumn?: `span ${number}` | "auto"; /** - * Number of rows the item will span across - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row + * The number of rows this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of rows. Learn more about [`grid-row`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row). * * @default 'auto' */ @@ -2453,29 +2503,47 @@ interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole { } export interface BaseTypographyProps { /** - * Modify the color to be more or less intense. + * The color emphasis level that controls visual intensity. + * + * - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements. + * - `base`: Primary color for body text, standard UI elements, and general content with good readability. + * - `strong`: Higher-contrast color for text that needs more emphasis than `base`. * * @default 'base' */ color?: ColorKeyword; /** - * Sets the tone of the component, based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the component. + * + * - `auto`: Automatically determined based on context. + * - `neutral`: General information without specific intent. + * - `info`: Informational content or helpful tips. + * - `success`: Positive outcomes or successful states. + * - `caution`: Advisory notices that need attention. + * - `warning`: Important warnings about potential issues. + * - `critical`: Urgent problems or destructive actions. + * - `accent`: Highlighted or promotional content. + * - `custom`: Custom styling controlled by your theme. * * @default 'auto' */ tone?: ToneKeyword; /** - * Set the numeric properties of the font. + * The rendering style for numbers in the font. + * + * - `auto`: Inherits the setting from the parent element. + * - `normal`: Uses the font's default numeric glyphs. + * - `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists. * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric + * Learn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric). * - * @default 'auto' - inherit from the parent element + * @default 'auto' */ fontVariantNumeric?: "auto" | "normal" | "tabular-nums"; /** - * 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) + * The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation. + * + * The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). * * It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different. * @@ -2485,12 +2553,12 @@ export interface BaseTypographyProps { /** * 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) + * - `ltr`: The languages written from left to right (such as English). + * - `rtl`: The languages written from right to left (such as Arabic). + * - `auto`: The user agent determines the direction based on the content. + * - `""`: The direction is inherited from parent elements (equivalent to not setting the attribute). * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir + * Learn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir). * * @default '' */ @@ -2498,9 +2566,9 @@ export interface BaseTypographyProps { } export interface BlockTypographyProps { /** - * Truncates the text content to the specified number of lines. + * The maximum number of lines to display before truncating the text content. * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp + * Learn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp). * * @default Infinity - no truncation is applied */ @@ -2508,19 +2576,16 @@ export interface BlockTypographyProps { } interface HeadingProps$1 extends GlobalProps, AccessibilityVisibilityProps, BlockTypographyProps { /** - * The content of the Heading. + * The heading text displayed within the heading component, which provides a title or section header for content. */ children?: ComponentChildren; /** - * Sets the semantic meaning of the component’s content. When set, + * 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. + * - `presentation`: Removes semantic meaning, making the element purely decorative and ignored by screen readers. + * - `none`: Completely hides the element and its content from assistive technologies. * * @default 'heading' * @@ -2530,94 +2595,110 @@ interface HeadingProps$1 extends GlobalProps, AccessibilityVisibilityProps, Bloc */ accessibilityRole?: "heading" | ExtractStrict; } +/** + * The shared properties for the icon component. An icon displays a graphical symbol with configurable appearance, color, and semantic meaning. + */ interface IconProps$1 extends GlobalProps, Pick { /** - * Sets the tone of the icon, based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the icon. + * + * - `'info'`: Informational content or helpful tips. + * - `'auto'`: Automatically determined based on context. + * - `'neutral'`: General information without specific intent. + * - `'success'`: Positive outcomes or successful states. + * - `'warning'`: Important warnings about potential issues. + * - `'critical'`: Urgent problems or destructive actions. + * - `'custom'`: Inherits a custom color from its parent element's CSS. * * @default 'auto' */ tone?: ToneKeyword; /** - * Modify the color to be more or less intense. + * The color intensity of the icon. Use `'subdued'` for less intense, or `'base'` for standard coloring. * * @default 'base' */ color?: ColorKeyword; /** - * Adjusts the size of the icon. + * The size of the icon. + * + * - `'base'`: Default size that works well for most use cases. + * - `'small'`: Small icon for inline use within text or compact UI elements. + * - `'small-200'`: Extra small icon for the most compact contexts. + * - `'small-100'`: Small icon suitable for tight or dense layouts. + * - `'large'`: Large icon for emphasis or prominent display. + * - `'large-100'`: Extra large icon for maximum visual impact. * * @default 'base' */ size?: SizeKeyword; + /** + * The icon to display. Can be any icon name from the icon library or a custom string identifier. + */ type?: IconType | AnyString; } +/** + * The shared base properties for image-based components. These properties are common to all components that display images, including the image and product thumbnail components. Properties include `alt` for accessibility text, `src` for the image URL, `sizes` for responsive sizing hints, and `srcSet` for multiple image sources. + */ export interface BaseImageProps { /** - * 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. - * - * @default `''` - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt + * Alternative text that describes the image for accessibility. + * + * Provides a text description of the image for users with assistive technology + * and serves as a fallback when the image fails to load. A well-written description + * enables people with visual impairments to understand non-text content. + * + * When a screen reader encounters an image, it reads this description aloud. + * When an image fails to load, this text displays on screen, helping all users + * understand what content was intended. + * + * Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4) + * and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt). + * + * @default '' */ alt?: string; /** - * A set of media conditions and their corresponding sizes. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes + * A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes). */ sizes?: string; /** * 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. - * - * @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be - * reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src + * When the image is loading or no `src` is provided, a placeholder is rendered. + * Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src). */ src?: string; /** - * A set of image sources and their width or pixel density descriptors. - * - * This overrides the `src` property. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset + * A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property. */ srcSet?: string; } +/** + * The shared properties for the image component. An image displays pictures with configurable sizing, loading behavior, and borders. + */ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps { /** - * Sets the semantic meaning of the component’s content. When set, + * Sets the semantic meaning of the image content. When set, * the role will be used by assistive technologies to help users * navigate the page. * - * @default 'img' + * - `'img'`: Identifies the element as an image that conveys meaningful information to users. + * - `'none'`: Completely hides the element and its content from assistive technologies. + * - `'presentation'`: Removes semantic meaning, making the image purely decorative and ignored by screen readers. * - * @implementation The `img` role doesn't need to be applied if - * the host applies it for you; for example, an HTML host rendering - * an `` element should not apply the `img` role. + * @default 'img' */ accessibilityRole?: "img" | ExtractStrict; /** - * The displayed inline width of the image. + * The inline width (horizontal size) 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. + * - `'fill'`: The image takes up 100% of the available inline space. + * - `'auto'`: The image is displayed at its natural size. * - * @default 'fill' + * Learn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width). * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width + * @default 'fill' */ inlineSize?: "fill" | "auto"; /** @@ -2628,238 +2709,250 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps { * - `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`. + * Learn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio). * * @default '1/1' - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio */ aspectRatio?: `${number}${optionalSpace}/${optionalSpace}${number}` | `${number}`; /** - * Determines how the content of the image is resized to fit its container. - * The image is positioned in the center of the container. + * How the image should be resized to fit its container. The image is positioned in the center of the container. Learn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit). * - * @default 'contain' + * - `'contain'`: Fits the entire image within the container, preserving aspect ratio. May leave empty space. + * - `'cover'`: Fills the container while preserving aspect ratio, cropping the image if needed. * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit + * @default 'contain' */ objectFit?: "contain" | "cover"; /** * 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. + * - `'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. + * + * Learn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading). * * @default 'eager' - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading */ loading?: "eager" | "lazy"; /** - * Invoked when load completes successfully. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload + * A callback fired when the image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload). */ onLoad?: (event: Event) => void; /** - * Invoked on load error. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror + * A callback fired when the image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror). */ onError?: (event: Event) => void; } interface LinkProps$1 extends GlobalProps, LinkBehaviorProps { /** - * The content of the Link. + * The text or elements displayed as the link's content. */ children?: ComponentChildren; /** - * Sets the tone of the Link, based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the link. + * + * - `'auto'`: Automatically determined based on context. + * - `'neutral'`: Removes the default link color, inheriting the surrounding text style. * * @default 'auto' */ tone?: ToneKeyword; /** - * 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. + * A label that describes the purpose or content of the link for users of assistive technologies such as screen readers. */ accessibilityLabel?: string; /** - * 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) + * The language of the link's text content. Use this when the link text is in a different language than the rest of the page. */ lang?: string; } interface ListItemProps$1 extends GlobalProps { /** - * The content of the ListItem. + * The content displayed within the list item, which represents a single entry in an ordered or unordered list. */ children?: ComponentChildren; } interface MapProps$1 extends GlobalProps, SizingProps { /** - * A valid API key for the map service provider. - * - * The map service provider may require an API key. Without an API key the map could be hidden or render in a limited developer mode. + * A valid API key for the map service provider. This key is required to load and render the map tiles. Obtain a key from a supported provider such as [Google Maps Platform](https://developers.google.com/maps/documentation/javascript/get-api-key). */ apiKey?: string; /** - * Map center’s latitude in degrees. + * The latitude of the map's center point, in degrees. Valid values range from -90 (South Pole) to 90 (North Pole). * * @default 0 */ latitude?: number; /** - * Map center’s longitude in degrees. + * The longitude of the map's center point, in degrees. Valid values range from -180 (west) to 180 (east). * * @default 0 */ longitude?: number; /** - * A label that describes the purpose or contents of the map. - * - * When set, it will be announced to users using assistive technologies and will provide them with more context. + * A label that describes the purpose or contents of the map for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the map displays. */ accessibilityLabel?: string; /** - * The initial Map zoom level. - * - * Valid zoom values are numbers from zero up to 18. - * Larger zoom values correspond to a higher resolution. + * The initial zoom level of the map. Valid values are numbers from 0 (fully zoomed out, world view) to 18 (fully zoomed in, street level). * * @default 4 */ zoom?: number; /** - * The maximum zoom level which will be displayed on the map. - * - * Valid zoom values are numbers from zero up to 18. + * The maximum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming in beyond a useful level of detail. * * @default 18 */ maxZoom?: number; /** - * The minimum zoom level which will be displayed on the map. - * - * Valid zoom values are numbers from zero up to 18. + * The minimum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming out beyond a useful level of context. * * @default 0 */ minZoom?: number; /** - * Callback when the viewport bounds have changed or the map is resized. + * A callback fired when the visible map boundaries change, such as after a pan or zoom completes. */ onBoundsChange?: (event: MapBoundsChangeEvent) => void; /** - * Callback when the map view changes. + * A callback fired when the map view changes, such as when the user pans or zooms. Provides the new center location and zoom level. */ onViewChange?: (event: MapViewChangeEvent) => void; /** - * Callback when the user clicks on the map. + * A callback fired when the user clicks on the map. Provides the geographic location of the click. */ onClick?: (event: MapClickEvent) => void; /** - * Callback when the user double-clicks on the map. + * A callback fired when the user double-clicks on the map. Provides the geographic location of the double-click. */ onDblClick?: (event: MapDblClickEvent) => void; } +/** + * A geographic coordinate pair representing a location on the map, defined by latitude and longitude values. + */ interface Location$1 { + /** + * The latitude of the location in degrees. Valid values range from -90 (South Pole) to 90 (North Pole). + */ latitude?: number; + /** + * The longitude of the location in degrees. Valid values range from -180 (west) to 180 (east). + */ longitude?: number; } +/** + * The geographic boundaries of a visible map area, defined by its north-east and south-west corners. Used by `MapBoundsChangeEvent` to report the currently visible map region. + */ export interface Bounds { + /** + * The north-east corner of the bounded area, representing the top-right of the visible map region. + */ northEast?: Location$1; + /** + * The south-west corner of the bounded area, representing the bottom-left of the visible map region. + */ southWest?: Location$1; } +/** + * The event data provided when the map view changes, such as after the user pans or zooms. Contains the new center location and zoom level. + */ export interface MapViewChangeEvent extends Event { + /** + * The geographic location of the new map center after the view change. + */ location?: Location$1; + /** + * The current zoom level of the map after the view change, as a number from 0 (world view) to 18 (street level). + */ zoom?: number; } +/** + * The event data provided when the visible map boundaries change, such as after a pan or zoom completes. Contains the new geographic bounds of the visible area. + */ export interface MapBoundsChangeEvent extends Event { + /** + * The geographic boundaries of the currently visible map area, defined by its north-east and south-west corners. + */ bounds?: Bounds; } +/** + * The event data provided when the user clicks on the map. Contains the geographic location of the click. + */ export interface MapClickEvent extends Event { + /** + * The geographic location on the map where the click occurred, as a latitude/longitude coordinate pair. + */ location?: Location$1; } +/** + * The event data provided when the user double-clicks on the map. Contains the geographic location of the double-click. + */ export interface MapDblClickEvent extends Event { + /** + * The geographic location on the map where the double-click occurred, as a latitude/longitude coordinate pair. + */ location?: Location$1; } interface MapMarkerProps$1 extends GlobalProps, InteractionProps, Pick { /** - * Marker’s location latitude in degrees. + * The latitude of the marker’s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole). * * @default 0 */ latitude?: number; /** - * Marker’s longitude latitude in degrees. + * The longitude of the marker’s position in degrees. Valid values range from -180 (west) to 180 (east). * * @default 0 */ longitude?: number; /** - * A label that describes the purpose of the marker. When set, - * it will be announced to users using assistive technologies and will - * provide them with more context. + * A label that describes the purpose or location of the marker for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the marker represents. */ accessibilityLabel?: string; /** - * Allows grouping the marker in clusters when zoomed out. + * Whether the marker can be grouped into clusters when the map is zoomed out. Clustering helps reduce visual clutter when many markers are close together at low zoom levels. * * @default false */ clusterable?: boolean; /** - * The graphic to use as the marker. - * - * If unset, it will default to the provider’s default marker. + * A custom graphic element to use as the marker. If not provided, the map provider’s default marker pin is displayed. */ graphic?: ComponentChildren; /** - * Callback when a marker is clicked. - * - * It does not trigger a click event on the map itself. + * A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click. */ onClick?: (event: Event) => void; } interface ModalProps$1 extends GlobalProps, BaseOverlayProps, BaseOverlayMethods, ActionSlots { /** - * 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. + * A label that describes the purpose of the modal, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the modal. */ accessibilityLabel?: string; /** - * A title that describes the content of the Modal. - * + * A title that describes the content of the modal. */ heading?: string; /** - * Adjust the padding around the Modal content. + * 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. + * - `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. * * @default 'base' */ padding?: "base" | "none"; /** - * Adjust the size of the Modal. + * Adjust the size of the modal. * - * `max`: expands the Modal to its maximum size as defined by the host application, on both the horizontal and vertical axes. + * `max`: Expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes. * * @default 'base' */ size?: SizeKeyword | "max"; /** - * The content of the Modal. + * The content of the modal. */ children?: ComponentChildren; } @@ -2868,9 +2961,13 @@ interface MoneyFieldProps$1 extends GlobalProps, BaseTextFieldProps, NumberConst export type MoneyAutocompleteField = ExtractStrict; interface NumberFieldProps$1 extends GlobalProps, BaseTextFieldProps, AutocompleteProps, NumberConstraintsProps, FieldDecorationProps { /** - * Sets the virtual keyboard. + * Sets the virtual keyboard layout for the field. + * + * - `'decimal'`: A numeric keyboard with a decimal point, suitable for decimal numbers. + * - `'numeric'`: A numeric keyboard without a decimal point, suitable for integers. + * + * Learn more about the [inputMode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode). * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode * @default 'decimal' */ inputMode?: "decimal" | "numeric"; @@ -2886,11 +2983,11 @@ interface OrderedListProps$1 extends GlobalProps { } interface ParagraphProps$1 extends GlobalProps, BaseTypographyProps, BlockTypographyProps, AccessibilityVisibilityProps { /** - * The content of the Text. + * The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling. */ children?: ComponentChildren; /** - * Provide semantic meaning and default styling to the paragraph. + * The semantic type and styling treatment for the paragraph content. * * Other presentation properties on `s-paragraph` override the default styling. * @@ -2900,45 +2997,46 @@ interface ParagraphProps$1 extends GlobalProps, BaseTypographyProps, BlockTypogr } export type ParagraphType = /** - * Indicate the text is a structural grouping of related content. + * A semantic type that indicates the text is a structural grouping of related content. * - * In an HTML host, the text will be rendered in an `

` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p + * In an HTML host, the text will be rendered in an `

` element. Learn more about the [p element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p). */ "paragraph" /** - * Indicates the text is considered less important than the main content, but is still necessary for the reader to understand. + * A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand. + * * It can be used for secondary content but also for disclaimers, terms and conditions, or legal information. * * Surfaces should apply a smaller font size than the default size. * - * In an HTML host, the text will be rendered in a `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small + * In an HTML host, the text will be rendered in a `` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small). */ | "small"; interface PasswordFieldProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps { } export type PasswordAutocompleteField = ExtractStrict; +/** + * The shared properties for the payment icon component. A payment icon displays a recognizable icon for a payment method, such as Visa, Mastercard, or PayPal. + */ interface PaymentIconProps$1 extends GlobalProps { /** - * The icon type of the payment method + * The payment method to display. Specify a payment method name from the available set (for example, `'visa'`, `'mastercard'`, or `'paypal'`), or use an empty string to show no icon. * * @default '' */ type?: PaymentIconName | AnyString; /** - * A label that describes the purpose or contents of the icon. - * - * When set, it will be announced to users using assistive technologies and will provide them with more context. - * This should only be used if the icon requires an alternative internationalised label - * or if it is otherwise inappropriate to make use of the default label included with the icon. + * A label that describes the payment icon for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about which payment method the icon represents. */ accessibilityLabel?: string; } +/** + * The recognized payment method identifiers used by the `PaymentIcon` component. Each value maps to a branded icon for a specific payment provider, card network, digital wallet, or buy-now-pay-later service. Pass one of these names as the `type` property of `PaymentIcon` to display the corresponding icon — for example, `"visa"`, `"apple-pay"`, or `"afterpay"`. + */ export type PaymentIconName = "abn" | "acima-leasing" | "acuotaz" | "ada" | "addi" | "adyen" | "aeropay" | "affin-bank" | "affirm" | "aftee" | "afterpay-paynl-version" | "afterpay" | "airtel-money" | "airteltigo-mobile-money" | "aktia" | "akulaku-paylater" | "akulaku" | "alandsbanken" | "alfamart" | "alfamidi" | "alipay-hk" | "alipay-paynl-version" | "alipay" | "alliance-bank" | "alma" | "aman" | "amazon" | "ambank" | "american-express" | "amex" | "ansa-stored-value" | "ansa" | "anyday" | "apecoin" | "aplazo" | "apple-pay" | "aqsat" | "arbitrum" | "arhaus" | "arvato" | "ashley-plcc" | "ask" | "astrapay" | "atm-bersama" | "atobaraidotcom" | "atome" | "atone" | "atrato" | "au-kantan-kessai" | "au-pay" | "authorize-net" | "avalanche" | "axs" | "bancnet" | "banco-azteca" | "bancomat" | "bancontact" | "bangkok-bank" | "bank-islam" | "bank-muamalat" | "bank-rakyat" | "barclays" | "base" | "bbva-cie" | "bc-card" | "bca-klikpay" | "bca" | "bdo" | "belfius" | "benefit" | "best-buy-card" | "biercheque-paynl-version" | "bigc" | "billease" | "biller-paynl-version" | "billie" | "billink-method" | "billink" | "bitcoin-cash" | "bitcoin" | "bizum" | "blik" | "bnbchain" | "bni" | "bnp" | "bogus-app-coin" | "bogus" | "boleto" | "boodil" | "boost" | "bpi" | "braintree" | "bread-pay" | "bread" | "bri-direct-debit" | "bri" | "brimo" | "bsi" | "bsn" | "bss" | "busd" | "careem-pay" | "cartes-bancaires" | "cash-app-pay" | "cash" | "cashew" | "cashinvoice-latin-america" | "catch-payments" | "cebuana" | "cembrapay" | "centi" | "cetelem" | "checkout-finance" | "chinabank" | "cimb-clicks" | "cimb" | "circle-k" | "citadele" | "citi-pay" | "clave-telered" | "clearpay" | "clerq" | "cleverpay" | "clip" | "cliq" | "codensa" | "coinsph" | "collector-bank" | "coop" | "coppel-pay" | "credit-agricole" | "credit-key" | "creditclick-paynl-version" | "credix" | "cuotas" | "d-barai" | "dai" | "daily-yamazaki" | "dan-dan" | "dana" | "danamon-online" | "dankort" | "danske-bank" | "dappmx" | "dash" | "daviplata" | "de-cadeaukaart" | "depay" | "deutsche-bank" | "dinacard" | "diners-club" | "direct-bank-transfer-latin-america" | "directa24" | "directpay" | "discover" | "divido" | "dnb" | "docomo-barai" | "dogecoin" | "dropp" | "duitnow" | "duologi" | "dwolla" | "easywallet" | "ebucks" | "echelon-financing" | "ecpay" | "edenred" | "efecty" | "eft-secure" | "eftpos-au" | "eghl" | "elo" | "elv" | "empty" | "enets" | "eos" | "epayments" | "epospay" | "eps" | "erste" | "escrowcom" | "esr-paymentslip-switzerland" | "ethereum" | "etihad-guest-pay" | "etika" | "ewallet-indonesia" | "ewallet-philippines" | "ewallet-southkorea" | "facebook-pay" | "fairstone-payments" | "fam" | "familymart" | "fantom" | "farmlands" | "fashion-giftcard-paynlversion" | "fashioncheque" | "favepay" | "fawry" | "finloup" | "fintecture" | "fintoc" | "flexiti" | "float-payments" | "flying-blue-plus" | "forbrugsforeningen" | "forsa" | "fortiva" | "fps" | "fpx" | "freecharge" | "freedompay" | "futurepay-mytab" | "gcash" | "generalfinancing" | "generic" | "genoapay" | "gezondheidsbon-paynl-version" | "giftcard" | "giropay" | "givacard" | "glbe-paypal" | "glbe-plus" | "gmo-atokara" | "gmo-bank-transfer" | "gmo-postpay" | "gmo-virtualaccount" | "gnosis" | "google-pay" | "google-wallet" | "gopay" | "grabpay" | "grailpay" | "gusd" | "hana-card" | "handelsbanken" | "happy-pay" | "hello-clever" | "heylight" | "hitrustpay-transfer" | "home-credit" | "hong-leong-bank" | "hong-leong-connect" | "hsbc" | "huis-tuin-cadeau" | "humm" | "hyper" | "hypercard" | "hypercash" | "hyundai-card" | "ibexpay" | "ideal" | "in3-via-ideal" | "in3" | "inbank" | "indomaret" | "ing-homepay" | "interac" | "ivy" | "iwocapay-pay-later" | "jcb" | "jenius" | "jko" | "jousto" | "kakao-pay" | "kakebaraidotcom" | "kasikornbank" | "kasssh" | "katapult" | "kb-card" | "kbc-cbc" | "kcp-credit-card" | "kfast" | "khqr" | "klarna-pay-later" | "klarna-pay-now" | "klarna-slice-it" | "klarna" | "knaken-settle" | "knet" | "koalafi" | "koin" | "krediidipank" | "kredivo" | "krungsri" | "krungthai-bank" | "kueski-pay" | "kunst-en-cultuur-cadeaukaart" | "kuwait-finance-house" | "land-bank" | "laser" | "latitude-creditline-au" | "latitude-gem-au" | "latitude-gem-nz" | "latitude-go-au" | "latitudepay" | "lawson" | "laybuy-heart" | "laybuy" | "lbc" | "lhv" | "line-pay" | "linkaja" | "linkpay" | "litecoin" | "lku" | "lloyds" | "lotte-card" | "lpb" | "luminor" | "lunch-check" | "lydia" | "mach" | "mada" | "maestro" | "mandiri" | "mash" | "master" | "mastercard" | "masterpass" | "maxima" | "maya-bank" | "maya" | "maybank-qrpay" | "maybank" | "maybankm2u" | "mb-way" | "mb" | "mcash" | "medicinos-bankas" | "meeza" | "mercado-credito" | "mercado-pago" | "merpay" | "meta-pay" | "metro-bank" | "military-starcard" | "minicuotas" | "ministop" | "mobicred" | "mobikwik" | "mobilepay" | "mode" | "mokka" | "momopay" | "mondido" | "monero" | "monzo" | "mpesa" | "mtn-mobile-money" | "multisafepay" | "mybank" | "myfatoorah" | "n26" | "naps" | "nationale-bioscoopbon" | "nationale-entertainmentcard" | "natwest" | "naver-pay" | "nelo" | "nequi" | "netbanking" | "neteller" | "nh-card" | "nordea" | "notyd" | "novuna" | "npatobarai" | "npkakebarai" | "oca" | "ocbc-bank" | "octo-clicks" | "octopus" | "offline-bank-transfer-latin-america" | "ola-money" | "omannet" | "omasp" | "oney" | "online-banking" | "online-banktransfer" | "op" | "opay" | "openpay" | "optimism" | "orange-mobile-money" | "overstock-citicobrand" | "overstock-citiplcc" | "ovo" | "oxxo" | "ozow" | "pagoefectivo" | "paid" | "paidy" | "palawa" | "palawan" | "pastpay" | "pay-after-delivery-instalments" | "pay-by-bank-us" | "pay-by-bank" | "pay-easy" | "pay-pay" | "paybylink" | "paycash" | "payco" | "payconiq" | "payd" | "payfast-instant-eft" | "payflex" | "payid" | "payitmonthly" | "payjustnow" | "paymark-online-eftpos" | "paymaya" | "payme" | "paynow-mbank" | "paynow" | "payoo-qr" | "payoo" | "paypal" | "payplan" | "paypo" | "payrexx-bank-transfer" | "payright" | "paysafecard-paynl-version" | "paysafecard" | "paysafecash" | "paysera" | "paysquad" | "paytm" | "payto" | "paytomorrow" | "payu" | "payzapp" | "pei" | "perlasfinance" | "permata" | "pf-pay" | "pivo" | "pix" | "podium-cadeaukaart" | "pointspay" | "poli" | "polygon" | "poppankki" | "postfinance-card" | "postfinance-efinance" | "postpay" | "powered-by-ansa-stored-value" | "powered-by-ansa" | "powerpay" | "pps" | "prepaysolutions" | "progressive-leasing" | "przelew24" | "przelewy24-paynl-version" | "przelewy24" | "pse" | "public-bank" | "publicbank-pbe" | "qasitli" | "qliro" | "qr-promptpay" | "qris" | "qrph" | "rabbit-line-pay" | "rabobank" | "rakuten-pay" | "rapid-transfer" | "ratepay" | "raty-pekao" | "rcbc" | "rcs" | "reka" | "resolve-pay" | "revolut" | "rhb-bank" | "rhb-now" | "rietumu" | "riverty-paynl-version" | "riverty" | "rupay" | "saastopankki" | "sadad" | "sam" | "samsung-card" | "samsung-pay" | "santander" | "satisfi" | "satispay" | "sbpl" | "scalapay" | "scream-truck-wallet" | "scream-truck" | "seb" | "seicomart" | "sepa-bank-transfer" | "sepa-direct-debit" | "sequra" | "seven-eleven" | "sezzle" | "shib" | "shinhan-card" | "shop-pay" | "shopeepay" | "shopify-pay" | "siam-commercial" | "siauliu-bankas" | "siirto" | "sika-fsa" | "sika-hsa" | "sika" | "simpl" | "simple-pay" | "sinpe-movil" | "sistecredito" | "skeps" | "skrill-digital-wallet" | "slice-fnbo" | "smartpay" | "snap-checkout" | "snapmint" | "societe-generale" | "sofort" | "softbank" | "solana-pay-helio" | "solana-pay" | "solana" | "souhoola" | "spankki" | "sparkasse" | "spei" | "splitit" | "spotii" | "spraypay" | "standard-chartered" | "stc-pay" | "stoov" | "store-credit" | "stripe" | "sunkus" | "super-payments" | "svea-b2b-faktura" | "svea-b2b-invoice" | "svea-checkout" | "svea-credit-account" | "svea-delbetalning" | "svea-faktura" | "svea-invoice" | "svea-lasku" | "svea-ostukonto" | "svea-part-payment" | "svea-yrityslasku" | "sveaeramaksu" | "swedbank" | "swiftpay" | "swish" | "swissbilling" | "sympl" | "synchrony-pay" | "synchrony" | "tabby" | "tabit" | "taly" | "tamara" | "tandympayment" | "tasa-cero" | "tbi-bank" | "tcf" | "tendopay" | "tensile" | "tesco-lotus" | "thanachart-bank" | "timepayment" | "tiptop" | "todopay" | "toss" | "touch-n-go" | "tpay" | "trevipay" | "truelayer" | "truemoney-pay" | "trustly" | "twig-pay" | "twint" | "twoinvoice" | "uae-visa" | "uangme" | "ubp" | "underpay" | "unionpay" | "unipay" | "uob-ez-pay" | "uob-thai" | "uob" | "upi" | "urbo" | "urpay" | "usdc" | "usdp" | "v-pay" | "valu" | "venmo" | "ventipay" | "venus-plcc" | "viabill" | "vipps" | "visa-electron" | "visa" | "volksbank" | "volt" | "vvv-cadeaukaart-paynl-version" | "vvv-giftcard" | "waave-pay-by-bank" | "wallet" | "walley" | "wbtc" | "webshop-giftcard" | "wechat-pay" | "wechat-paynl-version" | "wegetfinancing" | "whish-checkout" | "whish-pay" | "wise" | "wissel" | "world-chain" | "xrp" | "yape" | "yappy" | "ymobile" | "younited-pay" | "zalopay" | "zapper" | "zingala" | "zinia" | "zip" | "zoodpay" | "zulily-credit-card" | "zustaina"; interface PopoverProps$1 extends GlobalProps, BaseOverlayProps, BaseOverlayMethods, ToggleEventProps, SizingProps { /** - * The content of the popover. + * The content displayed within the popover, which appears in an overlay positioned relative to its trigger element. */ children?: ComponentChildren; } @@ -2958,178 +3056,150 @@ interface PressButtonProps$1 extends GlobalProps, Pick void; /** - * Invoked on load error of provided image. - * - * @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror + * A callback fired when the product thumbnail image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror). */ onError?: (event: Event) => void; } interface ProgressProps$1 extends GlobalProps { /** - * 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. - * - * Use it to provide context of what is progressing. + * A label announced by assistive technologies that describes what is progressing. Use this to provide context about the ongoing task, such as "Loading order details" or "Uploading file". */ accessibilityLabel?: string; /** - * Sets the tone of the progress, based on the intention of the information being conveyed. + * The semantic meaning and color treatment of the progress indicator. * * @default 'auto' */ tone?: ToneKeyword; /** - * Specifies how much of the task has been completed. - * - * It must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted. - * If there is no value attribute, the progress bar is indeterminate; - * this indicates that an activity is ongoing with no indication of how long it is expected to take. + * How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time. * - * @implementation Surfaces should apply styling to cover that indeterminate state. - * @implementation In a HTML host, you can customize the progress animation via the :indeterminate pseudo-class. - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/:indeterminate#progress_bar + * Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value). */ value?: number; /** - * This attribute describes how much work the task indicated by the progress element requires. + * The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number. * - * The `max` attribute, if present, must have a value greater than 0 and be a valid floating point number. + * Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max). * * @default 1 - * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max */ max?: number; } +/** + * The shared properties for the QR code component. A QR code generates and displays a scannable matrix barcode from a given string. Properties include `content` for the data to encode, `size` for display dimensions, `border` for visual framing, and `logo` for branding. + */ interface QRCodeProps$1 extends GlobalProps { /** - * Set the border of the QR code. + * Whether to display a border around the QR code. * - * `base`: applies border that is appropriate for the element. - * `none`: removes the border from the element. + * - `'base'`: Applies a standard border to frame the QR code. + * - `'none'`: Removes the border for seamless integration with the surrounding layout. * * @default 'base' */ border?: "base" | "none"; /** - * The content to be encoded in the QR code, which can be any string such as a URL, email address, plain text, etc. - * Specific string formatting can trigger actions on the user's device when scanned, like opening geolocation - * coordinates on a map, opening a preferred app or app store entry, preparing an email, text message, and more. + * The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content — typically by opening a URL in a browser or prompting an action based on the content type. */ content?: string; /** * The displayed size of the QR code. * - * `fill`: the QR code will takes up 100% of the available inline-size and maintain a 1:1 aspect ratio. - * `base`: the QR code will be displayed at its default size. + * - `'base'`: The QR code is displayed at its default fixed size. + * - `'fill'`: The QR code takes up 100% of the available inline size, useful for responsive layouts. * * @default 'base' */ size?: "base" | "fill"; /** - * A label that describes the purpose or contents of the QR code. When set, - * it will be announced to users using assistive technologies and will - * provide more context about what the QR code may do when scanned. + * A label that describes the purpose or contents of the QR code for accessibility. When set, it will be announced to users using assistive technologies such as screen readers. * * @default 'QR code' (translated to the user's locale) */ accessibilityLabel?: string; /** - * Invoked when the conversion of `content` to a QR code fails. - * If an error occurs, the QR code and its child elements will not be displayed. + * A callback fired when the conversion of `content` to a QR code fails. This can happen when the content is too long or contains unsupported characters. */ onError?: (event: Event) => void; /** - * URL of an image to be displayed in the center of the QR code. - * This is useful for branding or to indicate to the user what scanning the QR code will do. - * By default, no image is displayed. + * The URL of an image to display in the center of the QR code, typically used for branding. The image should be small enough not to interfere with the QR code's scannability. */ logo?: string; } interface QueryContainerProps$1 extends GlobalProps { /** - * The content of the container. + * The child elements to render inside the query container. */ children?: ComponentChildren; /** - * 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. + * A custom name for the container, used in [container queries](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name) to target this container specifically. The value is added alongside the default name `s-default`. * * @default '' - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/container-name - * - * @implementation You must always have a CSS `container-name` of `s-default` for this component. */ containerName?: string; } +/** + * The overflow behavior for a scrollable container axis. + * + * - `auto`: Content that exceeds the container is clipped and becomes scrollable. + * - `hidden`: Content that exceeds the container is clipped and not scrollable. + */ export type OverflowKeyword = "auto" | "hidden"; interface ScrollBoxProps$1 extends GlobalProps, Omit { /** - * Sets the overflow behavior of the element. - * - * - `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis. - * - `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis. + * The overflow behavior of the scroll box, controlling whether content that exceeds the container is scrollable or clipped. Learn more about [`overflow`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow). * - * 1-to-2-value syntax is supported but note that, contrary to the CSS, it uses flow-relative values and the order is: + * - `hidden`: Content is clipped and the element is not scrollable in that axis. + * - `auto`: Content is clipped and becomes scrollable in that axis. * - * - 2 values: `block inline` + * Supports 1-to-2-value syntax using flow-relative axes. Two values are ordered as `block inline` (for example, `hidden auto` clips vertically and scrolls horizontally). * * @default 'auto' - * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/overflow */ overflow?: OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`; } interface SectionProps$1 extends GlobalProps, ActionSlots { /** - * The content of the Section. + * The child elements to render inside the section, typically the main content area below the heading. */ children?: ComponentChildren; /** - * 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. + * A label announced by assistive technologies that describes the purpose of the section. When no `heading` property is provided, you **must** set `accessibilityLabel` so screen readers can identify the section. */ accessibilityLabel?: string; /** - * A title that describes the content of the section. + * The heading text displayed at the top of the section to summarize its content. */ heading?: string; /** - * Adjust the padding of all edges. + * The padding applied to all edges of the section. * - * - `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. + * - `base`: Applies context-appropriate padding. In some contexts this may result in no visible padding. + * - `none`: Removes all padding, allowing child elements to span the full width of the section. Use a Box with `base` padding to restore spacing for individual content areas. * * @default 'base' */ @@ -3145,28 +3215,15 @@ interface SelectProps$1 extends GlobalProps, AutocompleteProps; /** - * Aligns the Stack along the main axis. + * Controls how child elements are distributed along the main axis. Learn more about [`justify-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content * @default 'normal' */ justifyContent?: MaybeResponsive; /** - * Aligns the Stack's children along the cross axis. + * Controls how child elements are aligned along the cross axis. Learn more about [`align-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items * @default 'normal' */ alignItems?: MaybeResponsive; /** - * Aligns the Stack along the cross axis. + * Controls how lines of content are distributed along the cross axis when there is extra space. Learn more about [`align-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content). * - * @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content * @default 'normal' */ alignContent?: MaybeResponsive; } interface SummaryProps$1 extends GlobalProps { /** - * The content to use as the label. + * The content displayed as the clickable label of the disclosure widget. This label is always visible and users interact with it to toggle the details content open or closed. * - * Interactive content is disallowed. For example, you can use a `` element for extra formatting but + * Interactive content is disallowed. For example, you can use an `s-text` element for extra formatting but * elements like buttons and fields are not allowed. * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary + * Learn more about the [summary element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary). * * @implementation Surfaces may apply styling to this element. An icon suggesting the state (open or closed) of the * details element is recommended. @@ -3274,13 +3321,13 @@ interface SwitchProps$1 extends GlobalProps, BaseCheckableProps, BasicFieldProps } interface TextProps$1 extends GlobalProps, AccessibilityVisibilityProps, BaseTypographyProps, DisplayProps, Pick { /** - * The content of the Text. + * The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type. */ children?: ComponentChildren; /** - * Provide semantic meaning and default styling to the text. + * The semantic type and styling treatment for the text content. * - * Other presentation properties on Text override the default styling. + * Other presentation properties on `s-text` override the default styling. * * @default 'generic' */ @@ -3288,7 +3335,7 @@ interface TextProps$1 extends GlobalProps, AccessibilityVisibilityProps, BaseTyp } export type TextType = /** - * Indicate the text is contact information. Typically used for addresses. + * A semantic type that indicates the text is contact information. Typically used for addresses. * * This must have `inline` layout (despite the default being `block` in HTML hosts). * @@ -3298,65 +3345,60 @@ export type TextType = * * @implementation vertical alignment should be `baseline` (`vertical-align: baseline`) * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address + * Learn more about the [address element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address). */ "address" /** - * Indicate the text is no longer accurate or no longer relevant. One such use-case is discounted prices. + * A semantic type that indicates the text is no longer accurate or no longer relevant. One such use-case is discounted prices. * * Surfaces should apply styling to this type to suggest its content no longer applies. * - * In an HTML host, the text will be rendered in a `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s + * In an HTML host, the text will be rendered in a `` element. Learn more about the [s element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s). */ | "redundant" /** - * Indicate the text is marked or highlighted and relevant to the user’s current action. + * A semantic type that indicates the text is marked or highlighted and relevant to the user’s current action. * One such use-case is to indicate the characters that matched a search query. * * Surfaces should apply styling to this type to draw attention to the content. * - * In an HTML host, the text will be rendered in a `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark + * In an HTML host, the text will be rendered in a `` element. Learn more about the [mark element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark). */ | "mark" /** - * Indicate emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text. + * A semantic type that indicates emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text. * * Surfaces should apply styling to this type to distinguish it from surrounding text. Italicization is a common choice, but not required. * - * In an HTML host, the text will be rendered in an `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em + * In an HTML host, the text will be rendered in an `` element. Learn more about the [em element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em). */ | "emphasis" /** - * Indicate an offset from the normal prose of the text. Typically used to indicate - * a foreign word, fictional character thoughts, or when the text refers to the definition of a word - * instead of representing its semantic meaning. + * A semantic type that indicates an offset from the normal prose of the text. + * + * Typically used to indicate a foreign word, fictional character thoughts, or when the text refers to the definition of a word instead of representing its semantic meaning. * * Surfaces should italicize this content by default. * - * In an HTML host, the text will be rendered in a `` tag. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i + * In an HTML host, the text will be rendered in a `` tag. Learn more about the [i element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i). */ | "offset" /** - * Indicate strong importance, seriousness, or urgency. + * A semantic type that indicates strong importance, seriousness, or urgency. * * Surfaces should render this content bold by default. * - * In an HTML host, the text will be rendered in a `` tag. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong + * In an HTML host, the text will be rendered in a `` tag. Learn more about the [strong element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong). */ | "strong" /** - * Indicates the text is considered less important than the main content, but is still necessary for the reader to understand. + * A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand. + * * It can be used for secondary content but also for disclaimers, terms and conditions, or legal information. * * Surfaces should apply a smaller font size than the default size. * - * In an HTML host, the text will be rendered in a `` element. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small + * In an HTML host, the text will be rendered in a `` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small). */ | "small" /** @@ -3364,8 +3406,7 @@ export type TextType = * * Surfaces must not apply any default styling to this type. * - * In an HTML host, the text will be rendered in a `` tag. - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span + * In an HTML host, the text will be rendered in a `` tag. Learn more about the [span element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span). */ | "generic"; interface TextAreaProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps { @@ -3380,15 +3421,13 @@ interface TextFieldProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLength } interface TimeProps$1 extends GlobalProps { /** - * The content of the Time. + * The text content displayed within the time component, representing a human-readable date or time value. */ children?: ComponentChildren; /** - * Set the time and/or date of the element. - * - * It must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values). + * The machine-readable date and/or time value for the element. Use this to provide a datetime string that browsers, search engines, and assistive technologies can parse for improved semantics and functionality. * - * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/time#valid_datetime_values + * The value must be a [valid datetime string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values), such as `2024-01-15`, `14:30`, or `2024-01-15T14:30:00`. * * @default '' */ @@ -3396,7 +3435,7 @@ interface TimeProps$1 extends GlobalProps { } interface TooltipProps$1 extends GlobalProps { /** - * The content of the Tooltip. + * The text or elements displayed inside the tooltip popup. */ children?: ComponentChildren; } diff --git a/packages/ui-extensions/src/surfaces/checkout/components/components.d.ts b/packages/ui-extensions/src/surfaces/checkout/components/components.d.ts index 1fdd734c1a..70adcbde0d 100644 --- a/packages/ui-extensions/src/surfaces/checkout/components/components.d.ts +++ b/packages/ui-extensions/src/surfaces/checkout/components/components.d.ts @@ -48,19 +48,19 @@ export interface ActionSlots { } export interface BaseOverlayProps { /** - * Callback fired after the overlay is shown. + * A callback fired immediately after the overlay is shown. */ onShow?: (event: Event) => void; /** - * Callback fired when the overlay is shown **after** any animations to show the overlay have finished. + * A callback fired when the overlay is shown, after any show animations have completed. */ onAfterShow?: (event: Event) => void; /** - * Callback fired after the overlay is hidden. + * A callback fired immediately after the overlay is hidden. */ onHide?: (event: Event) => void; /** - * Callback fired when the overlay is hidden **after** any animations to hide the overlay have finished. + * A callback fired when the overlay is hidden, after any hide animations have completed. */ onAfterHide?: (event: Event) => void; } @@ -74,19 +74,19 @@ export interface BaseOverlayProps { */ export interface BaseOverlayMethods { /** - * Method to show an overlay. + * A method to programmatically show the overlay. * * @implementation This is a method to be called on the element and not a callback and should hence be camelCase */ showOverlay: () => void; /** - * Method to hide an overlay. + * A method to programmatically hide the overlay and run any associated hide animations. * * @implementation This is a method to be called on the element and not a callback and should hence be camelCase */ hideOverlay: () => void; /** - * Method to toggle the visiblity of an overlay. + * A method to programmatically toggle the visibility of the overlay. * * @implementation This is a method to be called on the element and not a callback and should hence be camelCase */ @@ -108,28 +108,25 @@ export interface FocusEventProps { } export interface ToggleEventProps { /** - * Callback fired when the element state changes **after** any animations have finished. + * A callback fired when the element state changes, after any toggle animations have finished. * * - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. * - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState). */ onAfterToggle?: (event: ToggleEvent$1) => void; /** - * Callback straight after the element state changes. + * A callback fired immediately when the element state changes, before any animations. * * - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the * `newState` property will be set to `open`. - * - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the + * - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the * `newState` will be `closed`. * - * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState - * @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState + * Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState), and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState). */ onToggle?: (event: ToggleEvent$1) => void; } @@ -164,7 +161,17 @@ interface AnnouncementProps$1 extends GlobalProps, ToggleEventProps { */ dismiss: () => void; } +/** + * The design system's size scale, used to control the dimensions of components like avatars, icons, and thumbnails. Values range from `"small-500"` (smallest) through `"base"` (standard) to `"large-500"` (largest). Not all components support every size — check the component's `size` property type for its available options. + */ export type SizeKeyword = "small-500" | "small-400" | "small-300" | "small-200" | "small-100" | "small" | "base" | "large" | "large-100" | "large-200" | "large-300" | "large-400" | "large-500"; +/** + * Defines the color intensity or emphasis level for text and UI elements. + * + * - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements. + * - `base`: Primary color for body text, standard UI elements, and general content with good readability. + * - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence. + */ export type ColorKeyword = "subdued" | "base" | "strong"; export type BackgroundColorKeyword = "transparent" | ColorKeyword; export interface BackgroundProps { @@ -740,8 +747,28 @@ export type IconType = (typeof privateIconArray)[number]; * Like `Extract`, but ensures that the extracted type is a strict subtype of the input type. */ export type ExtractStrict = Extract; +/** + * Represents CSS shorthand properties that accept one to four values, following the [CSS shorthand syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box). Supports specifying values for all four sides: top, right, bottom, and left. + * + * - `T`: Single value that applies to all four sides. + * - `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right). + * - `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom). + * - `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left). + */ export type MaybeAllValuesShorthandProperty = T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`; +/** + * Represents CSS shorthand properties that accept one or two values. Supports specifying the same value for both dimensions or different values. + * + * - `T`: Single value that applies to both dimensions. + * - `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal). + */ export type MaybeTwoValuesShorthandProperty = T | `${T} ${T}`; +/** + * Makes a property responsive by allowing it to be set conditionally based on container query conditions. The value can be either a base value or a container query string. + * + * - `T`: Base value that applies in all conditions. + * - `@container${string}`: Container query string for conditional responsive styling based on container size. + */ export type MaybeResponsive = T | `@container${string}`; /** * Prevents widening string literal types in a union to `string`. @@ -882,130 +909,95 @@ export interface DisplayProps { } export interface AccessibilityRoleProps { /** - * 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. - * - * @implementation Although, in HTML hosts, this property changes the element used, - * changing this property must not impact the visual styling of inside or outside of the box. + * The semantic meaning of the component’s content. When set, assistive technologies use this role to help users navigate the page. * * @default 'generic' */ accessibilityRole?: AccessibilityRole; } -export type AccessibilityRole = /** - * Used to indicate the primary content. + * The semantic role of a component, used by assistive technologies to convey the element’s purpose to users. Each role maps to a specific HTML element or ARIA role. * - * In an HTML host, `main` will render a `

` element. - * Learn more about the [`
` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/main) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/main_role) in the MDN web docs. + * - `main`: The primary content of the page. + * - `header`: A page or section header. + * - `footer`: Information such as copyright, navigation links, and privacy statements. + * - `section`: A generic section that should have a heading or `accessibilityLabel`. + * - `aside`: Supporting content related to the main content. + * - `navigation`: A major group of navigation links. + * - `ordered-list`: A list of ordered items. + * - `list-item`: An item inside a list. + * - `list-item-separator`: A divider between list items. + * - `unordered-list`: A list of unordered items. + * - `separator`: A divider that separates sections of content. + * - `status`: A live region with advisory information that is not urgent. + * - `alert`: Important, usually time-sensitive information. + * - `generic`: A nameless container with no semantic meaning (renders a `
`). + * - `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`. + * - `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`. + */ +export type AccessibilityRole = +/** + * The primary content of the page. Learn more about the [`
` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/main). */ "main" /** - * Used to indicate the component is a header. - * - * In an HTML host `header` will render a `
` element. - * Learn more about the [`
` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/main_role) in the MDN web docs. + * A page or section header. Learn more about the [`
` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header). */ | "header" /** - * Used to display information such as copyright information, navigation links, and privacy statements. - * - * In an HTML host `footer` will render a `